azure.mgmt.resource.locks.v2016_09_01.aio.operations package¶

class azure.mgmt.resource.locks.v2016_09_01.aio.operations.AuthorizationOperationsOperations(client, config, serializer, deserializer)[source]¶

AuthorizationOperationsOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs) → AsyncIterable[azure.mgmt.resource.features.v2015_12_01.models._models_py3.OperationListResult][source]¶

Lists all of the available Microsoft.Authorization REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationListResult or the result of cls(response)
Return type: AsyncItemPaged[OperationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.locks.v2016_09_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\locks\\v2016_09_01\\models\\__init__.py'>¶

class azure.mgmt.resource.locks.v2016_09_01.aio.operations.ManagementLocksOperations(client, config, serializer, deserializer)[source]¶

ManagementLocksOperations 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.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

async create_or_update_at_resource_group_level(resource_group_name: str, lock_name: str, parameters: azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Creates or updates a management lock at the resource group level.

When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters

resource_group_name (str) – The name of the resource group to lock.
lock_name (str) – The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters.
parameters (ManagementLockObject) – The management lock parameters.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, parameters: azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Creates or updates a management lock at the resource level or any level below the resource.

When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters

resource_group_name (str) – The name of the resource group containing the resource to lock.
resource_provider_namespace (str) – The resource provider namespace of the resource to lock.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the resource to lock.
resource_name (str) – The name of the resource to lock.
lock_name (str) – The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters.
parameters (ManagementLockObject) – Parameters for creating or updating a management lock.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update_at_subscription_level(lock_name: str, parameters: azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Creates or updates a management lock at the subscription level.

When you apply a lock at a parent scope, all child resources inherit the same lock. To create management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters

lock_name (str) – The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters.
parameters (ManagementLockObject) – The management lock parameters.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async create_or_update_by_scope(scope: str, lock_name: str, parameters: azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Create or update a management lock by scope.

Parameters

scope (str) – The scope for the lock. When providing a scope for the assignment, use ‘/subscriptions/{subscriptionId}’ for subscriptions, ‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}’ for resource groups, and ‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}’ for resources.
lock_name (str) – The name of lock.
parameters (ManagementLockObject) – Create or update management lock parameters.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async delete_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs) → None [source]¶

Deletes a management lock at the resource group level.

To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters

resource_group_name (str) – The name of the resource group containing the lock.
lock_name (str) – The name of lock to delete.

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

~azure.core.exceptions.HttpResponseError

async delete_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, **kwargs) → None [source]¶

Deletes the management lock of a resource or any level below the resource.

To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters

resource_group_name (str) – The name of the resource group containing the resource with the lock to delete.
resource_provider_namespace (str) – The resource provider namespace of the resource with the lock to delete.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the resource with the lock to delete.
resource_name (str) – The name of the resource with the lock to delete.
lock_name (str) – The name of the lock to delete.

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

~azure.core.exceptions.HttpResponseError

async delete_at_subscription_level(lock_name: str, **kwargs) → None [source]¶

Deletes the management lock at the subscription level.

To delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Parameters: lock_name (str) – The name of lock to delete.
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: ~azure.core.exceptions.HttpResponseError

async delete_by_scope(scope: str, lock_name: str, **kwargs) → None [source]¶

Delete a management lock by scope.

Parameters

scope (str) – The scope for the lock.
lock_name (str) – The name of lock.

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

~azure.core.exceptions.HttpResponseError

async get_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Gets a management lock at the resource group level.

Parameters

resource_group_name (str) – The name of the locked resource group.
lock_name (str) – The name of the lock to get.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async get_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, lock_name: str, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Get the management lock of a resource or any level below resource.

Parameters

resource_group_name (str) – The name of the resource group.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – An extra path parameter needed in some services, like SQL Databases.
resource_type (str) – The type of the resource.
resource_name (str) – The name of the resource.
lock_name (str) – The name of lock.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

async get_at_subscription_level(lock_name: str, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Gets a management lock at the subscription level.

Parameters: lock_name (str) – The name of the lock to get.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ManagementLockObject, or the result of cls(response)
Return type: ManagementLockObject
Raises: ~azure.core.exceptions.HttpResponseError

async get_by_scope(scope: str, lock_name: str, **kwargs) → azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject[source]¶

Get a management lock by scope.

Parameters

scope (str) – The scope for the lock.
lock_name (str) – The name of lock.

Keyword Arguments

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

Returns

ManagementLockObject, or the result of cls(response)

Return type

ManagementLockObject

Raises

~azure.core.exceptions.HttpResponseError

list_at_resource_group_level(resource_group_name: str, filter: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.locks.v2015_01_01.models._models_py3.ManagementLockListResult][source]¶

Gets all the management locks for a resource group.

Parameters

resource_group_name (str) – The name of the resource group containing the locks to get.
filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

AsyncItemPaged[ManagementLockListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_resource_level(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.locks.v2015_01_01.models._models_py3.ManagementLockListResult][source]¶

Gets all the management locks for a resource or any level below resource.

Parameters

resource_group_name (str) – The name of the resource group containing the locked resource. The name is case insensitive.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the locked resource.
resource_name (str) – The name of the locked resource.
filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

AsyncItemPaged[ManagementLockListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_at_subscription_level(filter: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.locks.v2015_01_01.models._models_py3.ManagementLockListResult][source]¶

Gets all the management locks for a subscription.

Parameters: filter (str) – The filter to apply on the operation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ManagementLockListResult or the result of cls(response)
Return type: AsyncItemPaged[ManagementLockListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_scope(scope: str, filter: Optional[str] = None, **kwargs) → AsyncIterable[azure.mgmt.resource.locks.v2015_01_01.models._models_py3.ManagementLockListResult][source]¶

Gets all the management locks for a scope.

Parameters

scope (str) – The scope for the lock. When providing a scope for the assignment, use ‘/subscriptions/{subscriptionId}’ for subscriptions, ‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}’ for resource groups, and ‘/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePathIfPresent}/{resourceType}/{resourceName}’ for resources.
filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

AsyncItemPaged[ManagementLockListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.resource.locks.v2016_09_01.models' from 'c:\\repo\\azure-sdk-for-python\\sdk\\resources\\azure-mgmt-resource\\.tox\\sphinx\\lib\\site-packages\\azure\\mgmt\\resource\\locks\\v2016_09_01\\models\\__init__.py'>¶