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

class azure.mgmt.resource.resources.v2016_02_01.operations.DeploymentsOperations(client, config, serializer, deserializer)[source]

Bases: object

DeploymentsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

cancel(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]

Cancel a currently running template deployment.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

check_existence(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]

Checks whether deployment exists.

Parameters:
  • resource_group_name (str) – The name of the resource group to check. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

bool

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, deployment_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Create a named template deployment using a template.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • properties (DeploymentProperties) – The deployment properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns DeploymentExtended

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]

Delete deployment.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment to be deleted.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

export_template(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]

Exports a deployment template.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentExportResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]

Get a deployment.

Parameters:
  • resource_group_name (str) – The name of the resource group to get. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentExtended

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, filter=None, top=None, custom_headers=None, raw=False, **operation_config)[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.
  • filter (str) – The filter to apply on the operation.
  • top (int) – Query parameters. If null is passed returns all deployments.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentExtendedPaged

Raises:

CloudError

validate(resource_group_name, deployment_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Validate a deployment template.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • properties (DeploymentProperties) – The deployment properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentValidateResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.resource.resources.v2016_02_01.operations.ProvidersOperations(client, config, serializer, deserializer)[source]

Bases: object

ProvidersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

get(resource_provider_namespace, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a resource provider.

Parameters:
  • resource_provider_namespace (str) – Namespace of the resource provider.
  • expand (str) – The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Provider

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(top=None, expand=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a list of resource providers.

Parameters:
  • top (int) – Query parameters. If null is passed returns all deployments.
  • expand (str) – The $expand query parameter. e.g. To include property aliases in response, use $expand=resourceTypes/aliases.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ProviderPaged

Raises:

CloudError

register(resource_provider_namespace, custom_headers=None, raw=False, **operation_config)[source]

Registers provider to be used with a subscription.

Parameters:
  • resource_provider_namespace (str) – Namespace of the resource provider.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Provider

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

unregister(resource_provider_namespace, custom_headers=None, raw=False, **operation_config)[source]

Unregisters provider from a subscription.

Parameters:
  • resource_provider_namespace (str) – Namespace of the resource provider.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Provider

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.resource.resources.v2016_02_01.operations.ResourceGroupsOperations(client, config, serializer, deserializer)[source]

Bases: object

ResourceGroupsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

check_existence(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Checks whether resource group exists.

Parameters:
  • resource_group_name (str) – The name of the resource group to check. The name is case insensitive.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

bool

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group to be created or updated.
  • parameters (ResourceGroup) – Parameters supplied to the create or update resource group service operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceGroup

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Delete resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group to be deleted. The name is case insensitive.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

export_template(resource_group_name, resources=None, options=None, custom_headers=None, raw=False, **operation_config)[source]

Captures the specified resource group as a template.

Parameters:
  • resource_group_name (str) – The name of the resource group to be created or updated.
  • resources (list of str) – The ids of the resources. The only supported string currently is ‘*’ (all resources). Future api updates will support exporting specific resources.
  • options (str) – The export template options. Supported values include ‘IncludeParameterDefaultValue’, ‘IncludeComments’ or ‘IncludeParameterDefaultValue, IncludeComments
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceGroupExportResult

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Get a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group to get. The name is case insensitive.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceGroup

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(filter=None, top=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a collection of resource groups.

Parameters:
  • filter (str) – The filter to apply on the operation.
  • top (int) – Query parameters. If null is passed returns all resource groups.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceGroupPaged

Raises:

CloudError

list_resources(resource_group_name, filter=None, expand=None, top=None, custom_headers=None, raw=False, **operation_config)[source]

Get all of the resources under a subscription.

Parameters:
  • resource_group_name (str) – Query parameters. If null is passed returns all resource groups.
  • filter (str) – The filter to apply on the operation.
  • expand (str) – The $expand query parameter
  • top (int) – Query parameters. If null is passed returns all resource groups.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

GenericResourcePaged

Raises:

CloudError

patch(resource_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

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.
  • parameters (ResourceGroup) – Parameters supplied to the update state resource group service operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceGroup

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.resource.resources.v2016_02_01.operations.ResourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

ResourcesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

check_existence(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, custom_headers=None, raw=False, **operation_config)[source]

Checks whether resource exists.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • resource_provider_namespace (str) – Resource identity.
  • parent_resource_path (str) – Resource identity.
  • resource_type (str) – Resource identity.
  • resource_name (str) – Resource identity.
  • api_version (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

bool

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create a resource.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • resource_provider_namespace (str) – Resource identity.
  • parent_resource_path (str) – Resource identity.
  • resource_type (str) – Resource identity.
  • resource_name (str) – Resource identity.
  • api_version (str) –
  • parameters (GenericResource) – Create or update resource parameters.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

GenericResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, custom_headers=None, raw=False, **operation_config)[source]

Delete resource and all of its resources. .

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • resource_provider_namespace (str) – Resource identity.
  • parent_resource_path (str) – Resource identity.
  • resource_type (str) – Resource identity.
  • resource_name (str) – Resource identity.
  • api_version (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, custom_headers=None, raw=False, **operation_config)[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.
  • resource_provider_namespace (str) – Resource identity.
  • parent_resource_path (str) – Resource identity.
  • resource_type (str) – Resource identity.
  • resource_name (str) – Resource identity.
  • api_version (str) –
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

GenericResource

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(filter=None, expand=None, top=None, custom_headers=None, raw=False, **operation_config)[source]

Get all of the resources under a subscription.

Parameters:
  • filter (str) – The filter to apply on the operation.
  • expand (str) – The $expand query parameter.
  • top (int) – Query parameters. If null is passed returns all resource groups.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

GenericResourcePaged

Raises:

CloudError

move_resources(source_resource_group_name, resources=None, target_resource_group=None, custom_headers=None, raw=False, **operation_config)[source]

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.
  • resources (list of str) – The ids of the resources.
  • target_resource_group (str) – The target resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.resource.resources.v2016_02_01.operations.TagsOperations(client, config, serializer, deserializer)[source]

Bases: object

TagsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

create_or_update(tag_name, custom_headers=None, raw=False, **operation_config)[source]

Create a subscription resource tag.

Parameters:
  • tag_name (str) – The name of the tag.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

TagDetails

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

create_or_update_value(tag_name, tag_value, custom_headers=None, raw=False, **operation_config)[source]

Create a subscription resource tag value.

Parameters:
  • tag_name (str) – The name of the tag.
  • tag_value (str) – The value of the tag.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

TagValue

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(tag_name, custom_headers=None, raw=False, **operation_config)[source]

Delete a subscription resource tag.

Parameters:
  • tag_name (str) – The name of the tag.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete_value(tag_name, tag_value, custom_headers=None, raw=False, **operation_config)[source]

Delete a subscription resource tag value.

Parameters:
  • tag_name (str) – The name of the tag.
  • tag_value (str) – The value of the tag.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Get a list of subscription resource tags.

Parameters:
Return type:

TagDetailsPaged

Raises:

CloudError

class azure.mgmt.resource.resources.v2016_02_01.operations.DeploymentOperations(client, config, serializer, deserializer)[source]

Bases: object

DeploymentOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2016-02-01”.

get(resource_group_name, deployment_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]

Get a list of deployments operations.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • operation_id (str) – Operation Id.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentOperation

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

list(resource_group_name, deployment_name, top=None, custom_headers=None, raw=False, **operation_config)[source]

Gets a list of deployments operations.

Parameters:
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.
  • deployment_name (str) – The name of the deployment.
  • top (int) – Query parameters.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

DeploymentOperationPaged

Raises:

CloudError