RemediationsOperations Class
RemediationsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
Constructor
RemediationsOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
models
|
Alias to model classes used in this operation group. |
Methods
| cancel_at_management_group |
Cancels a remediation at management group scope. |
| cancel_at_resource |
Cancel a remediation at resource scope. |
| cancel_at_resource_group |
Cancels a remediation at resource group scope. |
| cancel_at_subscription |
Cancels a remediation at subscription scope. |
| create_or_update_at_management_group |
Creates or updates a remediation at management group scope. |
| create_or_update_at_resource |
Creates or updates a remediation at resource scope. |
| create_or_update_at_resource_group |
Creates or updates a remediation at resource group scope. |
| create_or_update_at_subscription |
Creates or updates a remediation at subscription scope. |
| delete_at_management_group |
Deletes an existing remediation at management group scope. |
| delete_at_resource |
Deletes an existing remediation at individual resource scope. |
| delete_at_resource_group |
Deletes an existing remediation at resource group scope. |
| delete_at_subscription |
Deletes an existing remediation at subscription scope. |
| get_at_management_group |
Gets an existing remediation at management group scope. |
| get_at_resource |
Gets an existing remediation at resource scope. |
| get_at_resource_group |
Gets an existing remediation at resource group scope. |
| get_at_subscription |
Gets an existing remediation at subscription scope. |
| list_deployments_at_management_group |
Gets all deployments for a remediation at management group scope. |
| list_deployments_at_resource |
Gets all deployments for a remediation at resource scope. |
| list_deployments_at_resource_group |
Gets all deployments for a remediation at resource group scope. |
| list_deployments_at_subscription |
Gets all deployments for a remediation at subscription scope. |
| list_for_management_group |
Gets all remediations for the management group. |
| list_for_resource |
Gets all remediations for a resource. |
| list_for_resource_group |
Gets all remediations for the subscription. |
| list_for_subscription |
Gets all remediations for the subscription. |
cancel_at_management_group
Cancels a remediation at management group scope.
async cancel_at_management_group(management_group_id: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
cancel_at_resource
Cancel a remediation at resource scope.
async cancel_at_resource(resource_id: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
cancel_at_resource_group
Cancels a remediation at resource group scope.
async cancel_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
cancel_at_subscription
Cancels a remediation at subscription scope.
async cancel_at_subscription(remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_at_management_group
Creates or updates a remediation at management group scope.
async create_or_update_at_management_group(management_group_id: str, remediation_name: str, parameters: Remediation, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
remediation_name
Required
|
The name of the remediation. |
|
parameters
Required
|
The remediation parameters. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_at_resource
Creates or updates a remediation at resource scope.
async create_or_update_at_resource(resource_id: str, remediation_name: str, parameters: Remediation, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
remediation_name
Required
|
The name of the remediation. |
|
parameters
Required
|
The remediation parameters. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_at_resource_group
Creates or updates a remediation at resource group scope.
async create_or_update_at_resource_group(resource_group_name: str, remediation_name: str, parameters: Remediation, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
remediation_name
Required
|
The name of the remediation. |
|
parameters
Required
|
The remediation parameters. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update_at_subscription
Creates or updates a remediation at subscription scope.
async create_or_update_at_subscription(remediation_name: str, parameters: Remediation, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
remediation_name
Required
|
The name of the remediation. |
|
parameters
Required
|
The remediation parameters. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_management_group
Deletes an existing remediation at management group scope.
async delete_at_management_group(management_group_id: str, remediation_name: str, **kwargs) -> Remediation | NoneParameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_resource
Deletes an existing remediation at individual resource scope.
async delete_at_resource(resource_id: str, remediation_name: str, **kwargs) -> Remediation | NoneParameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_resource_group
Deletes an existing remediation at resource group scope.
async delete_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs) -> Remediation | NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete_at_subscription
Deletes an existing remediation at subscription scope.
async delete_at_subscription(remediation_name: str, **kwargs) -> Remediation | NoneParameters
| Name | Description |
|---|---|
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_management_group
Gets an existing remediation at management group scope.
async get_at_management_group(management_group_id: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_resource
Gets an existing remediation at resource scope.
async get_at_resource(resource_id: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_resource_group
Gets an existing remediation at resource group scope.
async get_at_resource_group(resource_group_name: str, remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_at_subscription
Gets an existing remediation at subscription scope.
async get_at_subscription(remediation_name: str, **kwargs) -> RemediationParameters
| Name | Description |
|---|---|
|
remediation_name
Required
|
The name of the remediation. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
Remediation, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_deployments_at_management_group
Gets all deployments for a remediation at management group scope.
list_deployments_at_management_group(management_group_id: str, remediation_name: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationDeploymentsListResult]Parameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
remediation_name
Required
|
The name of the remediation. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationDeploymentsListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_deployments_at_resource
Gets all deployments for a remediation at resource scope.
list_deployments_at_resource(resource_id: str, remediation_name: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationDeploymentsListResult]Parameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
remediation_name
Required
|
The name of the remediation. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationDeploymentsListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_deployments_at_resource_group
Gets all deployments for a remediation at resource group scope.
list_deployments_at_resource_group(resource_group_name: str, remediation_name: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationDeploymentsListResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
remediation_name
Required
|
The name of the remediation. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationDeploymentsListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_deployments_at_subscription
Gets all deployments for a remediation at subscription scope.
list_deployments_at_subscription(remediation_name: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationDeploymentsListResult]Parameters
| Name | Description |
|---|---|
|
remediation_name
Required
|
The name of the remediation. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationDeploymentsListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_for_management_group
Gets all remediations for the management group.
list_for_management_group(management_group_id: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationListResult]Parameters
| Name | Description |
|---|---|
|
management_group_id
Required
|
Management group ID. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_for_resource
Gets all remediations for a resource.
list_for_resource(resource_id: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationListResult]Parameters
| Name | Description |
|---|---|
|
resource_id
Required
|
Resource ID. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_for_resource_group
Gets all remediations for the subscription.
list_for_resource_group(resource_group_name: str, query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationListResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Resource group name. |
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_for_subscription
Gets all remediations for the subscription.
list_for_subscription(query_options: QueryOptions | None = None, **kwargs) -> AsyncIterable[RemediationListResult]Parameters
| Name | Description |
|---|---|
|
query_options
|
Parameter group. Default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RemediationListResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.policyinsights.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv188\\Lib\\site-packages\\azure\\mgmt\\policyinsights\\models\\__init__.py'>