azure.mgmt.resource.resources.v2016_02_01.operations module¶

class azure.mgmt.resource.resources.v2016_02_01.operations.DeploymentOperationsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s deployment_operations attribute.

get(resource_group_name: str, deployment_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperation[source]¶

Get a list of deployments operations.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.
operation_id (str) – Operation Id. Required.

Keyword Arguments

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

Returns

DeploymentOperation or the result of cls(response)

Return type

DeploymentOperation

Raises

HttpResponseError –

list(resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentOperation][source]¶

Gets a list of deployments operations.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.
top (int) – Query parameters. 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 DeploymentOperation or the result of cls(response)

Return type

ItemPaged[DeploymentOperation]

Raises

HttpResponseError –

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

class azure.mgmt.resource.resources.v2016_02_01.operations.DeploymentsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s deployments attribute.

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DeploymentExtended][source]¶

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DeploymentExtended]

Create a named template deployment using a template.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.
parameters (Deployment or IO) – Additional parameters supplied to the operation. Is either a Deployment 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
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 DeploymentExtended or the result of cls(response)

Return type

LROPoller[DeploymentExtended]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete deployment.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment to be deleted. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

calculate_template_hash(template: collections.abc.MutableMapping[str, Any], **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TemplateHashResult[source]¶

Calculate the hash of the given template.

Parameters: template (JSON) – The template provided to calculate hash. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: TemplateHashResult or the result of cls(response)
Return type: TemplateHashResult
Raises: HttpResponseError –

cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) → None [source]¶

Cancel a currently running template deployment.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. 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 –

check_existence(resource_group_name: str, deployment_name: str, **kwargs: Any) → bool [source]¶

Checks whether deployment exists.

Parameters

resource_group_name (str) – The name of the resource group to check. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExportResult[source]¶

Exports a deployment template.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.

Keyword Arguments

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

Returns

DeploymentExportResult or the result of cls(response)

Return type

DeploymentExportResult

Raises

HttpResponseError –

get(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended[source]¶

Get a deployment.

Parameters

resource_group_name (str) – The name of the resource group to get. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.

Keyword Arguments

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

Returns

DeploymentExtended or the result of cls(response)

Return type

DeploymentExtended

Raises

HttpResponseError –

list(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended][source]¶

Get a list of deployments.

Parameters

resource_group_name (str) – The name of the resource group to filter by. The name is case insensitive. Required.
filter (str) – The filter to apply on the operation. Default value is None.
top (int) – Query parameters. If null is passed returns all deployments. 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 DeploymentExtended or the result of cls(response)

Return type

ItemPaged[DeploymentExtended]

Raises

HttpResponseError –

validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeploymentValidateResult[source]¶

validate(resource_group_name: str, deployment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeploymentValidateResult

Validate a deployment template.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.
parameters (Deployment or IO) – Deployment to validate. Is either a Deployment 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

DeploymentValidateResult or the result of cls(response)

Return type

DeploymentValidateResult

Raises

HttpResponseError –

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

class azure.mgmt.resource.resources.v2016_02_01.operations.ProvidersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s providers attribute.

get(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Provider[source]¶

Gets a resource provider.

Parameters

resource_provider_namespace (str) – Namespace of the resource provider. Required.
expand (str) – The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. Default value is None.

Keyword Arguments

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

Returns

Provider or the result of cls(response)

Return type

Provider

Raises

HttpResponseError –

list(top: Optional[int] = None, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Provider][source]¶

Gets a list of resource providers.

Parameters

top (int) – Query parameters. If null is passed returns all deployments. Default value is None.
expand (str) – The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases. 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 Provider or the result of cls(response)

Return type

ItemPaged[Provider]

Raises

HttpResponseError –

register(resource_provider_namespace: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Provider[source]¶

Registers provider to be used with a subscription.

Parameters: resource_provider_namespace (str) – Namespace of the resource provider. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Provider or the result of cls(response)
Return type: Provider
Raises: HttpResponseError –

unregister(resource_provider_namespace: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Provider[source]¶

Unregisters provider from a subscription.

Parameters: resource_provider_namespace (str) – Namespace of the resource provider. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: Provider or the result of cls(response)
Return type: Provider
Raises: HttpResponseError –

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

class azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s resource_groups attribute.

begin_delete(resource_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete resource group.

Parameters

resource_group_name (str) – The name of the resource group to be deleted. The name is case insensitive. 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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

check_existence(resource_group_name: str, **kwargs: Any) → bool [source]¶

Checks whether resource group exists.

Parameters: resource_group_name (str) – The name of the resource group to check. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: bool or the result of cls(response)
Return type: bool
Raises: HttpResponseError –

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

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

Create a resource group.

Parameters

resource_group_name (str) – The name of the resource group to be created or updated. Required.
parameters (ResourceGroup or IO) – Parameters supplied to the create or update resource group service operation. Is either a ResourceGroup 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

ResourceGroup or the result of cls(response)

Return type

ResourceGroup

Raises

HttpResponseError –

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

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

Captures the specified resource group as a template.

Parameters

resource_group_name (str) – The name of the resource group to be created or updated. Required.
parameters (ExportTemplateRequest or IO) – Parameters supplied to the export template resource group operation. Is either a ExportTemplateRequest 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

ResourceGroupExportResult or the result of cls(response)

Return type

ResourceGroupExportResult

Raises

HttpResponseError –

get(resource_group_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ResourceGroup[source]¶

Get a resource group.

Parameters: resource_group_name (str) – The name of the resource group to get. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ResourceGroup or the result of cls(response)
Return type: ResourceGroup
Raises: HttpResponseError –

list(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.ResourceGroup][source]¶

Gets a collection of resource groups.

Parameters

filter (str) – The filter to apply on the operation. Default value is None.
top (int) – Query parameters. If null is passed returns all resource groups. 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 ResourceGroup or the result of cls(response)

Return type

ItemPaged[ResourceGroup]

Raises

HttpResponseError –

list_resources(resource_group_name: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResourceExpanded][source]¶

Get all of the resources under a subscription.

Parameters

resource_group_name (str) – Query parameters. If null is passed returns all resource groups. Required.
filter (str) – The filter to apply on the operation. Default value is None.
expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime. Default value is None.
top (int) – Query parameters. If null is passed returns all resource groups. 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 GenericResourceExpanded or the result of cls(response)

Return type

ItemPaged[GenericResourceExpanded]

Raises

HttpResponseError –

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

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

Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over.

Parameters

resource_group_name (str) – The name of the resource group to be created or updated. The name is case insensitive. Required.
parameters (ResourceGroup or IO) – Parameters supplied to the update state resource group service operation. Is either a ResourceGroup 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

ResourceGroup or the result of cls(response)

Return type

ResourceGroup

Raises

HttpResponseError –

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

class azure.mgmt.resource.resources.v2016_02_01.operations.ResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s resources attribute.

begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶

begin_move_resources(source_resource_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Move resources from one resource group to another. The resources being moved should all be in the same resource group.

Parameters

source_resource_group_name (str) – Source resource group name. Required.
parameters (ResourcesMoveInfo or IO) – move resources’ parameters. Is either a ResourcesMoveInfo 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
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 None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource][source]¶

begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource]

Updates a resource.

Parameters

resource_group_name (str) – The name of the resource group for the 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 resource to update. Required.
resource_name (str) – The name of the resource to update. Required.
api_version (str) – The API version to use for the operation. Required.
parameters (GenericResource or IO) – Parameters for updating the resource. Is either a GenericResource 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
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 GenericResource or the result of cls(response)

Return type

LROPoller[GenericResource]

Raises

HttpResponseError –

check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) → bool [source]¶

Checks whether resource exists.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
resource_provider_namespace (str) – Resource identity. Required.
parent_resource_path (str) – Resource identity. Required.
resource_type (str) – Resource identity. Required.
resource_name (str) – Resource identity. Required.
api_version (str) – Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GenericResource[source]¶

create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GenericResource

Create a resource.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
resource_provider_namespace (str) – Resource identity. Required.
parent_resource_path (str) – Resource identity. Required.
resource_type (str) – Resource identity. Required.
resource_name (str) – Resource identity. Required.
api_version (str) – Required.
parameters (GenericResource or IO) – Create or update resource parameters. Is either a GenericResource 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

GenericResource or the result of cls(response)

Return type

GenericResource

Raises

HttpResponseError –

delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) → None [source]¶

Delete resource and all of its resources.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
resource_provider_namespace (str) – Resource identity. Required.
parent_resource_path (str) – Resource identity. Required.
resource_type (str) – Resource identity. Required.
resource_name (str) – Resource identity. Required.
api_version (str) – 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(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResource[source]¶

Returns a resource belonging to a resource group.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
resource_provider_namespace (str) – Resource identity. Required.
parent_resource_path (str) – Resource identity. Required.
resource_type (str) – Resource identity. Required.
resource_name (str) – Resource identity. Required.
api_version (str) – Required.

Keyword Arguments

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

Returns

GenericResource or the result of cls(response)

Return type

GenericResource

Raises

HttpResponseError –

list(filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.GenericResourceExpanded][source]¶

Get all of the resources under a subscription.

Parameters

filter (str) – The filter to apply on the operation. Default value is None.
expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include createdTime, changedTime and provisioningState. For example, $expand=createdTime,changedTime. Default value is None.
top (int) – The number of results to return. If null is passed, returns all resources. 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 GenericResourceExpanded or the result of cls(response)

Return type

ItemPaged[GenericResourceExpanded]

Raises

HttpResponseError –

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

class azure.mgmt.resource.resources.v2016_02_01.operations.TagsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ResourceManagementClient’s tags attribute.

create_or_update(tag_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TagDetails[source]¶

Create a subscription resource tag.

Parameters: tag_name (str) – The name of the tag. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: TagDetails or the result of cls(response)
Return type: TagDetails
Raises: HttpResponseError –

create_or_update_value(tag_name: str, tag_value: str, **kwargs: Any) → azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TagValue[source]¶

Create a subscription resource tag value.

Parameters

tag_name (str) – The name of the tag. Required.
tag_value (str) – The value of the tag. Required.

Keyword Arguments

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

Returns

TagValue or the result of cls(response)

Return type

TagValue

Raises

HttpResponseError –

delete(tag_name: str, **kwargs: Any) → None [source]¶

Delete a subscription resource tag.

Parameters: tag_name (str) – The name of the tag. 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_value(tag_name: str, tag_value: str, **kwargs: Any) → None [source]¶

Delete a subscription resource tag value.

Parameters

tag_name (str) – The name of the tag. Required.
tag_value (str) – The value of the tag. 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 –

list(**kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TagDetails][source]¶

Get a list of subscription resource tags.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TagDetails or the result of cls(response)
Return type: ItemPaged[TagDetails]
Raises: HttpResponseError –

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