azure.mgmt.resource.locks.v2016_09_01.operations module¶

class azure.mgmt.resource.locks.v2016_09_01.operations.AuthorizationOperationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ManagementLockClient’s authorization_operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.resource.locks.v2016_09_01.models._models_py3.Operation][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 Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

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

class azure.mgmt.resource.locks.v2016_09_01.operations.ManagementLocksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ManagementLockClient’s management_locks attribute.

create_or_update_at_resource_group_level(resource_group_name: str, lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject[source]¶

create_or_update_at_resource_group_level(resource_group_name: str, lock_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject

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. Required.
lock_name (str) – The lock name. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters. Required.
parameters (ManagementLockObject or IO) – The management lock parameters. Is either a ManagementLockObject 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

ManagementLockObject or the result of cls(response)

Return type

ManagementLockObject

Raises

HttpResponseError –

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: _models.ManagementLockObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject[source]¶

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: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject

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. Required.
resource_provider_namespace (str) – The resource provider namespace of the resource to lock. Required.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type of the resource to lock. Required.
resource_name (str) – The name of the resource to lock. Required.
lock_name (str) – The name of lock. The lock name can be a maximum of 260 characters. It cannot contain <, > %, &, :, , ?, /, or any control characters. Required.
parameters (ManagementLockObject or IO) – Parameters for creating or updating a management lock. Is either a ManagementLockObject 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

ManagementLockObject or the result of cls(response)

Return type

ManagementLockObject

Raises

HttpResponseError –

create_or_update_at_subscription_level(lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject[source]¶

create_or_update_at_subscription_level(lock_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject

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. Required.
parameters (ManagementLockObject or IO) – The management lock parameters. Is either a ManagementLockObject 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

ManagementLockObject or the result of cls(response)

Return type

ManagementLockObject

Raises

HttpResponseError –

create_or_update_by_scope(scope: str, lock_name: str, parameters: _models.ManagementLockObject, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject[source]¶

create_or_update_by_scope(scope: str, lock_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagementLockObject

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. Required.
lock_name (str) – The name of lock. Required.
parameters (ManagementLockObject or IO) – Create or update management lock parameters. Is either a ManagementLockObject 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

ManagementLockObject or the result of cls(response)

Return type

ManagementLockObject

Raises

HttpResponseError –

delete_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs: Any) → 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. Required.
lock_name (str) – The name of lock to delete. 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 –

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: Any) → 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. Required.
resource_provider_namespace (str) – The resource provider namespace of the resource with the lock to delete. Required.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type of the resource with the lock to delete. Required.
resource_name (str) – The name of the resource with the lock to delete. Required.
lock_name (str) – The name of the lock to delete. 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 –

delete_at_subscription_level(lock_name: str, **kwargs: Any) → 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. 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 –

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

Delete a management lock by scope.

Parameters

scope (str) – The scope for the lock. Required.
lock_name (str) – The name of lock. 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 –

get_at_resource_group_level(resource_group_name: str, lock_name: str, **kwargs: Any) → 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. Required.
lock_name (str) – The name of the lock to get. Required.

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

HttpResponseError –

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: Any) → 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. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_path (str) – An extra path parameter needed in some services, like SQL Databases. Required.
resource_type (str) – The type of the resource. Required.
resource_name (str) – The name of the resource. Required.
lock_name (str) – The name of lock. Required.

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

HttpResponseError –

get_at_subscription_level(lock_name: str, **kwargs: Any) → 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. Required.
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: HttpResponseError –

get_by_scope(scope: str, lock_name: str, **kwargs: Any) → 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. Required.
lock_name (str) – The name of lock. Required.

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

HttpResponseError –

list_at_resource_group_level(resource_group_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject][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. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagementLockObject]

Raises

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: Any) → Iterable[azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject][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. Required.
resource_provider_namespace (str) – The namespace of the resource provider. Required.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type of the locked resource. Required.
resource_name (str) – The name of the locked resource. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagementLockObject]

Raises

HttpResponseError –

list_at_subscription_level(filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject][source]¶

Gets all the management locks for a subscription.

Parameters: filter (str) – The filter to apply on the operation. Default value is None.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ManagementLockObject or the result of cls(response)
Return type: ItemPaged[ManagementLockObject]
Raises: HttpResponseError –

list_by_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.locks.v2016_09_01.models._models_py3.ManagementLockObject][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. Required.
filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagementLockObject]

Raises

HttpResponseError –

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