azure.mgmt.resource.resources.v2016_02_01.operations module¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
DeploymentOperationsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeploymentOperationsOperations 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.
-
get
(resource_group_name: str, deployment_name: str, operation_id: str, **kwargs: Any) → ’models.DeploymentOperation’[source]¶ Get a list of deployments operations.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.DeploymentOperationsListResult’][source]¶ Gets a list of deployments operations.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DeploymentOperationsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
DeploymentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeploymentsOperations 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.
-
begin_create_or_update
(resource_group_name: str, deployment_name: str, parameters: ‘models.Deployment’, **kwargs: Any) → LROPoller[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.
parameters (Deployment) – Additional parameters supplied to the operation.
- 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) – True for ARMPolling, False for no polling, or a polling object for 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
- Raises
-
begin_delete
(resource_group_name: str, deployment_name: str, **kwargs: Any) → LROPoller[source]¶ Delete deployment.
- Parameters
- 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) – True for ARMPolling, False for no polling, or a polling object for 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
- Raises
-
calculate_template_hash
(template: object, **kwargs: Any) → ’models.TemplateHashResult’[source]¶ Calculate the hash of the given template.
-
cancel
(resource_group_name: str, deployment_name: str, **kwargs: Any) → None[source]¶ Cancel a currently running template deployment.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
check_existence
(resource_group_name: str, deployment_name: str, **kwargs: Any) → None[source]¶ Checks whether deployment exists.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
export_template
(resource_group_name: str, deployment_name: str, **kwargs: Any) → ’models.DeploymentExportResult’[source]¶ Exports a deployment template.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, deployment_name: str, **kwargs: Any) → ’models.DeploymentExtended’[source]¶ Get a deployment.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.DeploymentListResult’][source]¶ Get a list of deployments.
- param resource_group_name
The name of the resource group to filter by. The name is case
- insensitive.
- type resource_group_name
str
- param filter
The filter to apply on the operation.
- type filter
str
- param top
Query parameters. If null is passed returns all deployments.
- type top
int
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either DeploymentListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.resource.resources.v2016_02_01.models.DeploymentListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
validate
(resource_group_name: str, deployment_name: str, parameters: ‘models.Deployment’, **kwargs: Any) → ’models.DeploymentValidateResult’[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.
parameters (Deployment) – Deployment to validate.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DeploymentValidateResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
ProvidersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ProvidersOperations 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.
-
get
(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs: Any) → ’models.Provider’[source]¶ Gets a resource provider.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(top: Optional[int] = None, expand: Optional[str] = None, **kwargs: Any) → Iterable[‘models.ProviderListResult’][source]¶ Gets a list of resource providers.
- param top
Query parameters. If null is passed returns all deployments.
- type top
int
- param expand
The $expand query parameter. e.g. To include property aliases in response, use
- $expand=resourceTypes/aliases.
- type expand
str
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either ProviderListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.resource.resources.v2016_02_01.models.ProviderListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
register
(resource_provider_namespace: str, **kwargs: Any) → ’models.Provider’[source]¶ Registers provider to be used with a subscription.
-
unregister
(resource_provider_namespace: str, **kwargs: Any) → ’models.Provider’[source]¶ Unregisters provider from a subscription.
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
ResourceGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ResourceGroupsOperations 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.
-
begin_delete
(resource_group_name: str, **kwargs: Any) → LROPoller[source]¶ Delete resource group.
- param resource_group_name
The name of the resource group to be deleted. The name is case
- insensitive.
- type resource_group_name
str
- keyword callable cls
A custom type or function that will be passed the direct response
- keyword str continuation_token
A continuation token to restart a poller from a saved state.
- keyword polling
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- paramtype polling
bool or ~azure.core.polling.PollingMethod
- keyword int polling_interval
Default waiting time between two polls for LRO operations if no Retry-After header is present.
- return
An instance of LROPoller that returns either None or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[None]
- raises ~azure.core.exceptions.HttpResponseError
-
check_existence
(resource_group_name: str, **kwargs: Any) → None[source]¶ Checks whether resource group exists.
- Parameters
resource_group_name (str) – The name of the resource group to check. The name is case insensitive.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
create_or_update
(resource_group_name: str, parameters: ‘models.ResourceGroup’, **kwargs: Any) → ’models.ResourceGroup’[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.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
export_template
(resource_group_name: str, parameters: ‘models.ExportTemplateRequest’, **kwargs: Any) → ’models.ResourceGroupExportResult’[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.
parameters (ExportTemplateRequest) – Parameters supplied to the export template resource group operation.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ResourceGroupExportResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, **kwargs: Any) → ’models.ResourceGroup’[source]¶ Get a resource group.
- Parameters
resource_group_name (str) – The name of the resource group to get. The name is case insensitive.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.ResourceGroupListResult’][source]¶ Gets a collection of resource groups.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ResourceGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_resources
(resource_group_name: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.ResourceListResult’][source]¶ Get all of the resources under a subscription.
- param resource_group_name
Query parameters. If null is passed returns all resource groups.
- type resource_group_name
str
- param filter
The filter to apply on the operation.
- type filter
str
- param expand
Comma-separated list of additional properties to be included in the response.
Valid values include
createdTime
,changedTime
andprovisioningState
. For example,$expand=createdTime,changedTime
.- type expand
str
- param top
Query parameters. If null is passed returns all resource groups.
- type top
int
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either ResourceListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.resource.resources.v2016_02_01.models.ResourceListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
patch
(resource_group_name: str, parameters: ‘models.ResourceGroup’, **kwargs: Any) → ’models.ResourceGroup’[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.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
ResourcesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ResourcesOperations 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.
-
begin_move_resources
(source_resource_group_name: str, parameters: ‘models.ResourcesMoveInfo’, **kwargs: Any) → LROPoller[source]¶ Move resources from one resource group to another. The resources being moved should all be in the same resource group.
- param source_resource_group_name
Source resource group name.
- type source_resource_group_name
str
- param parameters
move resources’ parameters.
- type parameters
~azure.mgmt.resource.resources.v2016_02_01.models.ResourcesMoveInfo
- keyword callable cls
A custom type or function that will be passed the direct response
- keyword str continuation_token
A continuation token to restart a poller from a saved state.
- keyword polling
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- paramtype polling
bool or ~azure.core.polling.PollingMethod
- keyword int polling_interval
Default waiting time between two polls for LRO operations if no Retry-After header is present.
- return
An instance of LROPoller that returns either None or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[None]
- raises ~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, parameters: ‘models.GenericResource’, **kwargs: Any) → LROPoller[source]¶ Updates a resource.
- param resource_group_name
The name of the resource group for the resource. The name is case
- insensitive.
- type resource_group_name
str
- param resource_provider_namespace
The namespace of the resource provider.
- type resource_provider_namespace
str
- param parent_resource_path
The parent resource identity.
- type parent_resource_path
str
- param resource_type
The resource type of the resource to update.
- type resource_type
str
- param resource_name
The name of the resource to update.
- type resource_name
str
- param parameters
Parameters for updating the resource.
- type parameters
~azure.mgmt.resource.resources.v2016_02_01.models.GenericResource
- keyword callable cls
A custom type or function that will be passed the direct response
- keyword str continuation_token
A continuation token to restart a poller from a saved state.
- keyword polling
True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- paramtype polling
bool or ~azure.core.polling.PollingMethod
- keyword int polling_interval
Default waiting time between two polls for LRO operations if no Retry-After header is present.
- return
An instance of LROPoller that returns either GenericResource or the result of cls(response)
- rtype
~azure.core.polling.LROPoller[~azure.mgmt.resource.resources.v2016_02_01.models.GenericResource]
- raises ~azure.core.exceptions.HttpResponseError
-
check_existence
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, **kwargs: Any) → None[source]¶ Checks whether resource exists.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
create_or_update
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, parameters: ‘models.GenericResource’, **kwargs: Any) → ’models.GenericResource’[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.
parameters (GenericResource) – Create or update resource parameters.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, **kwargs: Any) → None[source]¶ Delete resource and all of its resources.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, **kwargs: Any) → ’models.GenericResource’[source]¶ Returns a resource belonging to a resource group.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[‘models.ResourceListResult’][source]¶ Get all of the resources under a subscription.
- param filter
The filter to apply on the operation.
- type filter
str
- param expand
Comma-separated list of additional properties to be included in the response.
Valid values include
createdTime
,changedTime
andprovisioningState
. For example,$expand=createdTime,changedTime
.- type expand
str
- param top
Query parameters. If null is passed returns all resource groups.
- type top
int
- keyword callable cls
A custom type or function that will be passed the direct response
- return
An iterator like instance of either ResourceListResult or the result of cls(response)
- rtype
~azure.core.paging.ItemPaged[~azure.mgmt.resource.resources.v2016_02_01.models.ResourceListResult]
- raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2016_02_01.operations.
TagsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TagsOperations 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.
-
create_or_update
(tag_name: str, **kwargs: Any) → ’models.TagDetails’[source]¶ Create a subscription resource tag.
-
create_or_update_value
(tag_name: str, tag_value: str, **kwargs: Any) → ’models.TagValue’[source]¶ Create a subscription resource tag value.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
delete_value
(tag_name: str, tag_value: str, **kwargs: Any) → None[source]¶ Delete a subscription resource tag value.
-
list
(**kwargs: Any) → Iterable[‘models.TagsListResult’][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 TagsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.resource.resources.v2016_02_01.models' from '/home/vsts/work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/resource/resources/v2016_02_01/models/__init__.py'>¶