azure.mgmt.resourcegraph.models module¶

class azure.mgmt.resourcegraph.models.AuthorizationScopeFilter(value)[source]¶

Bases: str, enum.Enum

Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes.

AT_SCOPE_ABOVE_AND_BELOW = 'AtScopeAboveAndBelow'¶

AT_SCOPE_AND_ABOVE = 'AtScopeAndAbove'¶

AT_SCOPE_AND_BELOW = 'AtScopeAndBelow'¶

AT_SCOPE_EXACT = 'AtScopeExact'¶

class azure.mgmt.resourcegraph.models.ChangeCategory(value)[source]¶

Bases: str, enum.Enum

The change category.

SYSTEM = 'System'¶

USER = 'User'¶

class azure.mgmt.resourcegraph.models.ChangeType(value)[source]¶

Bases: str, enum.Enum

The change type for snapshot. PropertyChanges will be provided in case of Update change type.

CREATE = 'Create'¶

DELETE = 'Delete'¶

UPDATE = 'Update'¶

class azure.mgmt.resourcegraph.models.Column(*, name: str, type: Union[str, _models.ColumnDataType], **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Query result column descriptor.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Column name. Required.
type (str or ColumnDataType) – Column data type. Required. Known values are: “string”, “integer”, “number”, “boolean”, “object”, and “datetime”.

Keyword Arguments

name (str) – Column name. Required.
type (str or ColumnDataType) – Column data type. Required. Known values are: “string”, “integer”, “number”, “boolean”, “object”, and “datetime”.

class azure.mgmt.resourcegraph.models.ColumnDataType(value)[source]¶

Bases: str, enum.Enum

Data type of a column in a table.

BOOLEAN = 'boolean'¶

DATETIME = 'datetime'¶

INTEGER = 'integer'¶

NUMBER = 'number'¶

OBJECT = 'object'¶

STRING = 'string'¶

class azure.mgmt.resourcegraph.models.DateTimeInterval(*, start: datetime.datetime, end: datetime.datetime, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. [start, end).

All required parameters must be populated in order to send to Azure.

Variables

start (datetime) – A datetime indicating the inclusive/closed start of the time interval, i.e. [ **start**, end). Specifying a start that occurs chronologically after end will result in an error. Required.
end (datetime) – A datetime indicating the exclusive/open end of the time interval, i.e. [start, **end**). Specifying an end that occurs chronologically before start will result in an error. Required.

Keyword Arguments

start (datetime) – A datetime indicating the inclusive/closed start of the time interval, i.e. [**start**, end). Specifying a start that occurs chronologically after end will result in an error. Required.
end (datetime) – A datetime indicating the exclusive/open end of the time interval, i.e. [start,**end**). Specifying an end that occurs chronologically before start will result in an error. Required.

class azure.mgmt.resourcegraph.models.Error(*, code: str, message: str, details: Optional[List[_models.ErrorDetails]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Error details.

All required parameters must be populated in order to send to Azure.

Variables

code (str) – Error code identifying the specific error. Required.
message (str) – A human readable error message. Required.
details (list[ErrorDetails]) – Error details.

Keyword Arguments

code (str) – Error code identifying the specific error. Required.
message (str) – A human readable error message. Required.
details (list[ErrorDetails]) – Error details.

class azure.mgmt.resourcegraph.models.ErrorDetails(*, code: str, message: str, additional_properties: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Error details.

All required parameters must be populated in order to send to Azure.

Variables

additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.
code (str) – Error code identifying the specific error. Required.
message (str) – A human readable error message. Required.

Keyword Arguments

additional_properties (dict[str, JSON]) – Unmatched properties from the message are deserialized to this collection.
code (str) – Error code identifying the specific error. Required.
message (str) – A human readable error message. Required.

class azure.mgmt.resourcegraph.models.ErrorResponse(*, error: _models.Error, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

An error response from the API.

All required parameters must be populated in order to send to Azure.

Variables: error (Error) – Error information. Required.
Keyword Arguments: error (Error) – Error information. Required.

class azure.mgmt.resourcegraph.models.Facet(*, expression: str, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FacetError, FacetResult

All required parameters must be populated in order to send to Azure.

Variables

expression (str) – Facet expression, same as in the corresponding facet request. Required.
result_type (str) – Result type. Required.

Keyword Arguments

expression (str) – Facet expression, same as in the corresponding facet request. Required.

class azure.mgmt.resourcegraph.models.FacetError(*, expression: str, errors: List[_models.ErrorDetails], **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph.models._models_py3.Facet

A facet whose execution resulted in an error.

All required parameters must be populated in order to send to Azure.

Variables

expression (str) – Facet expression, same as in the corresponding facet request. Required.
result_type (str) – Result type. Required.
errors (list[ErrorDetails]) – An array containing detected facet errors with details. Required.

Keyword Arguments

expression (str) – Facet expression, same as in the corresponding facet request. Required.
errors (list[ErrorDetails]) – An array containing detected facet errors with details. Required.

class azure.mgmt.resourcegraph.models.FacetRequest(*, expression: str, options: Optional[_models.FacetRequestOptions] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

A request to compute additional statistics (facets) over the query results.

All required parameters must be populated in order to send to Azure.

Variables

expression (str) – The column or list of columns to summarize by. Required.
options (FacetRequestOptions) – The options for facet evaluation.

Keyword Arguments

expression (str) – The column or list of columns to summarize by. Required.
options (FacetRequestOptions) – The options for facet evaluation.

class azure.mgmt.resourcegraph.models.FacetRequestOptions(*, sort_by: Optional[str] = None, sort_order: Union[str, _models.FacetSortOrder] = 'desc', filter: Optional[str] = None, top: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The options for facet evaluation.

Variables

sort_by (str) – The column name or query expression to sort on. Defaults to count if not present.
sort_order (str or FacetSortOrder) – The sorting order by the selected column (count by default). Known values are: “asc” and “desc”.
filter (str) – Specifies the filter condition for the ‘where’ clause which will be run on main query’s result, just before the actual faceting.
top (int) – The maximum number of facet rows that should be returned.

Keyword Arguments

sort_by (str) – The column name or query expression to sort on. Defaults to count if not present.
sort_order (str or FacetSortOrder) – The sorting order by the selected column (count by default). Known values are: “asc” and “desc”.
filter (str) – Specifies the filter condition for the ‘where’ clause which will be run on main query’s result, just before the actual faceting.
top (int) – The maximum number of facet rows that should be returned.

class azure.mgmt.resourcegraph.models.FacetResult(*, expression: str, total_records: int, count: int, data: collections.abc.MutableMapping[str, Any], **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph.models._models_py3.Facet

Successfully executed facet containing additional statistics on the response of a query.

All required parameters must be populated in order to send to Azure.

Variables

expression (str) – Facet expression, same as in the corresponding facet request. Required.
result_type (str) – Result type. Required.
total_records (int) – Number of total records in the facet results. Required.
count (int) – Number of records returned in the facet response. Required.
data (JSON) – A JObject array or Table containing the desired facets. Only present if the facet is valid. Required.

Keyword Arguments

expression (str) – Facet expression, same as in the corresponding facet request. Required.
total_records (int) – Number of total records in the facet results. Required.
count (int) – Number of records returned in the facet response. Required.
data (JSON) – A JObject array or Table containing the desired facets. Only present if the facet is valid. Required.

class azure.mgmt.resourcegraph.models.FacetSortOrder(value)[source]¶

Bases: str, enum.Enum

The sorting order by the selected column (count by default).

ASC = 'asc'¶

DESC = 'desc'¶

class azure.mgmt.resourcegraph.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationDisplay] = None, origin: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Resource Graph REST API operation definition.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
origin (str) – The origin of operations.

Keyword Arguments

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
origin (str) – The origin of operations.

class azure.mgmt.resourcegraph.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Display metadata associated with the operation.

Variables

provider (str) – Service provider: Microsoft Resource Graph.
resource (str) – Resource on which the operation is performed etc.
operation (str) – Type of operation: get, read, delete, etc.
description (str) – Description for the operation.

Keyword Arguments

provider (str) – Service provider: Microsoft Resource Graph.
resource (str) – Resource on which the operation is performed etc.
operation (str) – Type of operation: get, read, delete, etc.
description (str) – Description for the operation.

class azure.mgmt.resourcegraph.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Result of the request to list Resource Graph operations. It contains a list of operations and a URL link to get the next set of results.

Variables: value (list[Operation]) – List of Resource Graph operations supported by the Resource Graph resource provider.
Keyword Arguments: value (list[Operation]) – List of Resource Graph operations supported by the Resource Graph resource provider.

class azure.mgmt.resourcegraph.models.PropertyChangeType(value)[source]¶

Bases: str, enum.Enum

The property change Type.

INSERT = 'Insert'¶

REMOVE = 'Remove'¶

UPDATE = 'Update'¶

class azure.mgmt.resourcegraph.models.QueryRequest(*, query: str, subscriptions: Optional[List[str]] = None, management_groups: Optional[List[str]] = None, options: Optional[_models.QueryRequestOptions] = None, facets: Optional[List[_models.FacetRequest]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Describes a query to be executed.

All required parameters must be populated in order to send to Azure.

Variables

subscriptions (list[str]) – Azure subscriptions against which to execute the query.
management_groups (list[str]) – Azure management groups against which to execute the query. Example: [ ‘mg1’, ‘mg2’ ].
query (str) – The resources query. Required.
options (QueryRequestOptions) – The query evaluation options.
facets (list[FacetRequest]) – An array of facet requests to be computed against the query result.

Keyword Arguments

subscriptions (list[str]) – Azure subscriptions against which to execute the query.
management_groups (list[str]) – Azure management groups against which to execute the query. Example: [ ‘mg1’, ‘mg2’ ].
query (str) – The resources query. Required.
options (QueryRequestOptions) – The query evaluation options.
facets (list[FacetRequest]) – An array of facet requests to be computed against the query result.

class azure.mgmt.resourcegraph.models.QueryRequestOptions(*, skip_token: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, result_format: Optional[Union[str, _models.ResultFormat]] = None, allow_partial_scopes: bool = False, authorization_scope_filter: Union[str, _models.AuthorizationScopeFilter] = 'AtScopeAndBelow', **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The options for query evaluation.

Variables

skip_token (str) – Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
top (int) – The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.
skip (int) – The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
result_format (str or ResultFormat) – Defines in which format query result returned. Known values are: “table” and “objectArray”.
allow_partial_scopes (bool) – Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.
authorization_scope_filter (str or AuthorizationScopeFilter) – Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. Known values are: “AtScopeAndBelow”, “AtScopeAndAbove”, “AtScopeExact”, and “AtScopeAboveAndBelow”.

Keyword Arguments

skip_token (str) – Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
top (int) – The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.
skip (int) – The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
result_format (str or ResultFormat) – Defines in which format query result returned. Known values are: “table” and “objectArray”.
allow_partial_scopes (bool) – Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.
authorization_scope_filter (str or AuthorizationScopeFilter) – Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. Known values are: “AtScopeAndBelow”, “AtScopeAndAbove”, “AtScopeExact”, and “AtScopeAboveAndBelow”.

class azure.mgmt.resourcegraph.models.QueryResponse(*, total_records: int, count: int, result_truncated: Union[str, _models.ResultTruncated], data: collections.abc.MutableMapping[str, Any], skip_token: Optional[str] = None, facets: Optional[List[_models.Facet]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Query result.

All required parameters must be populated in order to send to Azure.

Variables

total_records (int) – Number of total records matching the query. Required.
count (int) – Number of records returned in the current response. In the case of paging, this is the number of records in the current page. Required.
result_truncated (str or ResultTruncated) – Indicates whether the query results are truncated. Required. Known values are: “true” and “false”.
skip_token (str) – When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
data (JSON) – Query output in JObject array or Table format. Required.
facets (list[Facet]) – Query facets.

Keyword Arguments

total_records (int) – Number of total records matching the query. Required.
count (int) – Number of records returned in the current response. In the case of paging, this is the number of records in the current page. Required.
result_truncated (str or ResultTruncated) – Indicates whether the query results are truncated. Required. Known values are: “true” and “false”.
skip_token (str) – When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
data (JSON) – Query output in JObject array or Table format. Required.
facets (list[Facet]) – Query facets.

class azure.mgmt.resourcegraph.models.ResourceChangeData(*, change_id: str, before_snapshot: _models.ResourceChangeDataBeforeSnapshot, after_snapshot: _models.ResourceChangeDataAfterSnapshot, resource_id: Optional[str] = None, change_type: Optional[Union[str, _models.ChangeType]] = None, property_changes: Optional[List[_models.ResourcePropertyChange]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Data on a specific change, represented by a pair of before and after resource snapshots.

All required parameters must be populated in order to send to Azure.

Variables

resource_id (str) – The resource for a change.
change_id (str) – The change ID. Valid and unique within the specified resource only. Required.
before_snapshot (ResourceChangeDataBeforeSnapshot) – The snapshot before the change. Required.
after_snapshot (ResourceChangeDataAfterSnapshot) – The snapshot after the change. Required.
change_type (str or ChangeType) – The change type for snapshot. PropertyChanges will be provided in case of Update change type. Known values are: “Create”, “Update”, and “Delete”.
property_changes (list[ResourcePropertyChange]) – An array of resource property change.

Keyword Arguments

resource_id (str) – The resource for a change.
change_id (str) – The change ID. Valid and unique within the specified resource only. Required.
before_snapshot (ResourceChangeDataBeforeSnapshot) – The snapshot before the change. Required.
after_snapshot (ResourceChangeDataAfterSnapshot) – The snapshot after the change. Required.
change_type (str or ChangeType) – The change type for snapshot. PropertyChanges will be provided in case of Update change type. Known values are: “Create”, “Update”, and “Delete”.
property_changes (list[ResourcePropertyChange]) – An array of resource property change.

class azure.mgmt.resourcegraph.models.ResourceChangeDataAfterSnapshot(*, timestamp: datetime.datetime, snapshot_id: Optional[str] = None, content: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph.models._models_py3.ResourceSnapshotData

The snapshot after the change.

All required parameters must be populated in order to send to Azure.

Variables

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

Keyword Arguments

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

class azure.mgmt.resourcegraph.models.ResourceChangeDataBeforeSnapshot(*, timestamp: datetime.datetime, snapshot_id: Optional[str] = None, content: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph.models._models_py3.ResourceSnapshotData

The snapshot before the change.

All required parameters must be populated in order to send to Azure.

Variables

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

Keyword Arguments

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

class azure.mgmt.resourcegraph.models.ResourceChangeDetailsRequestParameters(*, resource_ids: List[str], change_ids: List[str], **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The parameters for a specific change details request.

All required parameters must be populated in order to send to Azure.

Variables

resource_ids (list[str]) – Specifies the list of resources for a change details request. Required.
change_ids (list[str]) – Specifies the list of change IDs for a change details request. Required.

Keyword Arguments

resource_ids (list[str]) – Specifies the list of resources for a change details request. Required.
change_ids (list[str]) – Specifies the list of change IDs for a change details request. Required.

class azure.mgmt.resourcegraph.models.ResourceChangeList(*, changes: Optional[List[_models.ResourceChangeData]] = None, skip_token: Optional[Any] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

A list of changes associated with a resource over a specific time interval.

Variables

changes (list[ResourceChangeData]) –
The pageable value returned by the operation, i.e. a list of changes to the resource.
- The list is ordered from the most recent changes to the least recent changes.
- This list will be empty if there were no changes during the requested interval.
- The Before snapshot timestamp value of the oldest change can be outside of the specified
time interval.
skip_token (any) – Skip token that encodes the skip information while executing the current request.

Keyword Arguments

changes (list[ResourceChangeData]) –
The pageable value returned by the operation, i.e. a list of changes to the resource.
- The list is ordered from the most recent changes to the least recent changes.
- This list will be empty if there were no changes during the requested interval.
- The Before snapshot timestamp value of the oldest change can be outside of the specified
time interval.
skip_token (any) – Skip token that encodes the skip information while executing the current request.

class azure.mgmt.resourcegraph.models.ResourceChangesRequestParameters(*, interval: _models.ResourceChangesRequestParametersInterval, resource_ids: Optional[List[str]] = None, subscription_id: Optional[str] = None, skip_token: Optional[str] = None, top: Optional[int] = None, table: Optional[str] = None, fetch_property_changes: Optional[bool] = None, fetch_snapshots: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The parameters for a specific changes request.

All required parameters must be populated in order to send to Azure.

Variables

resource_ids (list[str]) – Specifies the list of resources for a changes request.
subscription_id (str) – The subscription id of resources to query the changes from.
interval (ResourceChangesRequestParametersInterval) – Specifies the date and time interval for a changes request. Required.
skip_token (str) – Acts as the continuation token for paged responses.
top (int) – The maximum number of changes the client can accept in a paged response.
table (str) – The table name to query resources from.
fetch_property_changes (bool) – The flag if set to true will fetch property changes.
fetch_snapshots (bool) – The flag if set to true will fetch change snapshots.

Keyword Arguments

resource_ids (list[str]) – Specifies the list of resources for a changes request.
subscription_id (str) – The subscription id of resources to query the changes from.
interval (ResourceChangesRequestParametersInterval) – Specifies the date and time interval for a changes request. Required.
skip_token (str) – Acts as the continuation token for paged responses.
top (int) – The maximum number of changes the client can accept in a paged response.
table (str) – The table name to query resources from.
fetch_property_changes (bool) – The flag if set to true will fetch property changes.
fetch_snapshots (bool) – The flag if set to true will fetch change snapshots.

class azure.mgmt.resourcegraph.models.ResourceChangesRequestParametersInterval(*, start: datetime.datetime, end: datetime.datetime, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph.models._models_py3.DateTimeInterval

Specifies the date and time interval for a changes request.

All required parameters must be populated in order to send to Azure.

Variables

start (datetime) – A datetime indicating the inclusive/closed start of the time interval, i.e. [ **start**, end). Specifying a start that occurs chronologically after end will result in an error. Required.
end (datetime) – A datetime indicating the exclusive/open end of the time interval, i.e. [start, **end**). Specifying an end that occurs chronologically before start will result in an error. Required.

Keyword Arguments

start (datetime) – A datetime indicating the inclusive/closed start of the time interval, i.e. [**start**, end). Specifying a start that occurs chronologically after end will result in an error. Required.
end (datetime) – A datetime indicating the exclusive/open end of the time interval, i.e. [start,**end**). Specifying an end that occurs chronologically before start will result in an error. Required.

class azure.mgmt.resourcegraph.models.ResourcePropertyChange(*, property_name: str, change_category: Union[str, _models.ChangeCategory], property_change_type: Union[str, _models.PropertyChangeType], before_value: Optional[str] = None, after_value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The resource property change.

All required parameters must be populated in order to send to Azure.

Variables

property_name (str) – The property name. Required.
before_value (str) – The property value in before snapshot.
after_value (str) – The property value in after snapshot.
change_category (str or ChangeCategory) – The change category. Required. Known values are: “User” and “System”.
property_change_type (str or PropertyChangeType) – The property change Type. Required. Known values are: “Insert”, “Update”, and “Remove”.

Keyword Arguments

property_name (str) – The property name. Required.
before_value (str) – The property value in before snapshot.
after_value (str) – The property value in after snapshot.
change_category (str or ChangeCategory) – The change category. Required. Known values are: “User” and “System”.
property_change_type (str or PropertyChangeType) – The property change Type. Required. Known values are: “Insert”, “Update”, and “Remove”.

class azure.mgmt.resourcegraph.models.ResourceSnapshotData(*, timestamp: datetime.datetime, snapshot_id: Optional[str] = None, content: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Data on a specific resource snapshot.

All required parameters must be populated in order to send to Azure.

Variables

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

Keyword Arguments

snapshot_id (str) – The ID of the snapshot.
timestamp (datetime) – The time when the snapshot was created. The snapshot timestamp provides an approximation as to when a modification to a resource was detected. There can be a difference between the actual modification time and the detection time. This is due to differences in how operations that modify a resource are processed, versus how operation that record resource snapshots are processed. Required.
content (JSON) – The resource snapshot content (in resourceChangeDetails response only).

class azure.mgmt.resourcegraph.models.ResourcesHistoryRequest(*, subscriptions: Optional[List[str]] = None, query: Optional[str] = None, options: Optional[_models.ResourcesHistoryRequestOptions] = None, management_groups: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Describes a history request to be executed.

Variables

subscriptions (list[str]) – Azure subscriptions against which to execute the query.
query (str) – The resources query.
options (ResourcesHistoryRequestOptions) – The history request evaluation options.
management_groups (list[str]) – Azure management groups against which to execute the query. Example: [ ‘mg1’, ‘mg2’ ].

Keyword Arguments

subscriptions (list[str]) – Azure subscriptions against which to execute the query.
query (str) – The resources query.
options (ResourcesHistoryRequestOptions) – The history request evaluation options.
management_groups (list[str]) – Azure management groups against which to execute the query. Example: [ ‘mg1’, ‘mg2’ ].

class azure.mgmt.resourcegraph.models.ResourcesHistoryRequestOptions(*, interval: Optional[_models.DateTimeInterval] = None, top: Optional[int] = None, skip: Optional[int] = None, skip_token: Optional[str] = None, result_format: Optional[Union[str, _models.ResultFormat]] = None, **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

The options for history request evaluation.

Variables

interval (DateTimeInterval) – The time interval used to fetch history.
top (int) – The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.
skip (int) – The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
skip_token (str) – Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
result_format (str or ResultFormat) – Defines in which format query result returned. Known values are: “table” and “objectArray”.

Keyword Arguments

interval (DateTimeInterval) – The time interval used to fetch history.
top (int) – The maximum number of rows that the query should return. Overrides the page size when $skipToken property is present.
skip (int) – The number of rows to skip from the beginning of the results. Overrides the next page offset when $skipToken property is present.
skip_token (str) – Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
result_format (str or ResultFormat) – Defines in which format query result returned. Known values are: “table” and “objectArray”.

class azure.mgmt.resourcegraph.models.ResultFormat(value)[source]¶

Bases: str, enum.Enum

Defines in which format query result returned.

OBJECT_ARRAY = 'objectArray'¶

TABLE = 'table'¶

class azure.mgmt.resourcegraph.models.ResultTruncated(value)[source]¶

Bases: str, enum.Enum

Indicates whether the query results are truncated.

FALSE = 'false'¶

TRUE = 'true'¶

class azure.mgmt.resourcegraph.models.Table(*, columns: List[_models.Column], rows: List[List[collections.abc.MutableMapping[str, Any]]], **kwargs)[source]¶

Bases: azure.mgmt.resourcegraph._serialization.Model

Query output in tabular format.

All required parameters must be populated in order to send to Azure.

Variables

columns (list[Column]) – Query result column descriptors. Required.
rows (list[list[JSON]]) – Query result rows. Required.

Keyword Arguments

columns (list[Column]) – Query result column descriptors. Required.
rows (list[list[JSON]]) – Query result rows. Required.