azure.mgmt.authorization.v2022_08_01_preview.operations module¶

class azure.mgmt.authorization.v2022_08_01_preview.operations.AlertConfigurationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s alert_configurations attribute.

get(scope: str, alert_id: str, **kwargs: Any) → azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertConfiguration[source]¶

Get the specified alert configuration.

Parameters

scope (str) – The scope of the alert configuration. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.
alert_id (str) – The name of the alert configuration to get. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AlertConfiguration or the result of cls(response)

Return type

AlertConfiguration

Raises

HttpResponseError –

list_for_scope(scope: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertConfiguration][source]¶

Gets alert configurations for a resource scope.

Parameters: scope (str) – The scope of the alert configuration. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertConfiguration or the result of cls(response)
Return type: ItemPaged[AlertConfiguration]
Raises: HttpResponseError –

update(scope: str, alert_id: str, parameters: _models.AlertConfiguration, *, content_type: str = "'application/json'", **kwargs: Any) → None [source]¶

update(scope: str, alert_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update an alert configuration.

Parameters

scope (str) – The scope of the alert configuration. Required.
alert_id (str) – The name of the alert configuration to update. Required.
parameters (AlertConfiguration or IO) – Parameters for the alert configuration. Is either a AlertConfiguration type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2022_08_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2022_08_01_preview/models/__init__.py'>¶

class azure.mgmt.authorization.v2022_08_01_preview.operations.AlertDefinitionsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s alert_definitions attribute.

get(scope: str, alert_definition_id: str, **kwargs: Any) → azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertDefinition[source]¶

Get the specified alert definition.

Parameters

scope (str) – The scope of the alert definition. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.
alert_definition_id (str) – The name of the alert definition to get. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AlertDefinition or the result of cls(response)

Return type

AlertDefinition

Raises

HttpResponseError –

list_for_scope(scope: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertDefinition][source]¶

Gets alert definitions for a resource scope.

Parameters: scope (str) – The scope of the alert definition. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either AlertDefinition or the result of cls(response)
Return type: ItemPaged[AlertDefinition]
Raises: HttpResponseError –

models = <module 'azure.mgmt.authorization.v2022_08_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2022_08_01_preview/models/__init__.py'>¶

class azure.mgmt.authorization.v2022_08_01_preview.operations.AlertIncidentsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s alert_incidents attribute.

get(scope: str, alert_id: str, alert_incident_id: str, **kwargs: Any) → azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertIncident[source]¶

Get the specified alert incident.

Parameters

scope (str) – The scope of the alert incident. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.
alert_id (str) – The name of the alert. Required.
alert_incident_id (str) – The name of the alert incident to get. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AlertIncident or the result of cls(response)

Return type

AlertIncident

Raises

HttpResponseError –

list_for_scope(scope: str, alert_id: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertIncident][source]¶

Gets alert incidents for a resource scope.

Parameters

scope (str) – The scope of the alert incident. Required.
alert_id (str) – The name of the alert. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AlertIncident or the result of cls(response)

Return type

ItemPaged[AlertIncident]

Raises

HttpResponseError –

remediate(scope: str, alert_id: str, alert_incident_id: str, **kwargs: Any) → None [source]¶

Remediate an alert incident.

Parameters

scope (str) – The scope of the alert incident. Required.
alert_id (str) – The name of the alert. Required.
alert_incident_id (str) – The name of the alert incident to remediate. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2022_08_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2022_08_01_preview/models/__init__.py'>¶

class azure.mgmt.authorization.v2022_08_01_preview.operations.AlertOperationOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s alert_operation attribute.

get(scope: str, operation_id: str, **kwargs: Any) → azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertOperationResult[source]¶

Get the specified alert operation.

Parameters

scope (str) – The scope of the alert operation. Required.
operation_id (str) – The id of the alert operation. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AlertOperationResult or the result of cls(response)

Return type

AlertOperationResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2022_08_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2022_08_01_preview/models/__init__.py'>¶

class azure.mgmt.authorization.v2022_08_01_preview.operations.AlertsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s alerts attribute.

begin_refresh(scope: str, alert_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertOperationResult][source]¶

Refresh an alert.

Parameters

scope (str) – The scope of the alert. Required.
alert_id (str) – The name of the alert to refresh. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either AlertOperationResult or the result of cls(response)

Return type

LROPoller[AlertOperationResult]

Raises

HttpResponseError –

begin_refresh_all(scope: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.AlertOperationResult][source]¶

Refresh all alerts for a resource scope.

Parameters

scope (str) – The scope of the alert. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either AlertOperationResult or the result of cls(response)

Return type

LROPoller[AlertOperationResult]

Raises

HttpResponseError –

get(scope: str, alert_id: str, **kwargs: Any) → azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.Alert[source]¶

Get the specified alert.

Parameters

scope (str) – The scope of the alert. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.
alert_id (str) – The name of the alert to get. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Alert or the result of cls(response)

Return type

Alert

Raises

HttpResponseError –

list_for_scope(scope: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2022_08_01_preview.models._models_py3.Alert][source]¶

Gets alerts for a resource scope.

Parameters: scope (str) – The scope of the alert. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Alert or the result of cls(response)
Return type: ItemPaged[Alert]
Raises: HttpResponseError –

update(scope: str, alert_id: str, parameters: _models.Alert, *, content_type: str = "'application/json'", **kwargs: Any) → None [source]¶

update(scope: str, alert_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update an alert.

Parameters

scope (str) – The scope of the alert. Required.
alert_id (str) – The name of the alert to dismiss. Required.
parameters (Alert or IO) – Parameters for the alert. Is either a Alert type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2022_08_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2022_08_01_preview/models/__init__.py'>¶