azure.mgmt.resource.resources.v2018_05_01.operations module¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
DeploymentOperationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’sdeployment_operations
attribute.-
get
(resource_group_name: str, deployment_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentOperation[source]¶ Gets a deployments operation.
- 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
-
get_at_subscription_scope
(deployment_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentOperation[source]¶ Gets a deployments operation.
- 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
-
list
(resource_group_name: str, deployment_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentOperation][source]¶ Gets all deployments operations for a deployment.
- Parameters
- 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
- Raises
-
list_at_subscription_scope
(deployment_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentOperation][source]¶ Gets all deployments operations for a deployment.
- Parameters
- 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
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
DeploymentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’sdeployments
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] Deploys resources to a resource group.
You can provide the template and parameters directly in the request or link to JSON files.
- Parameters
resource_group_name (str) – The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. 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
- Raises
-
begin_create_or_update_at_subscription_scope
(deployment_name: str, parameters: _models.Deployment, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DeploymentExtended][source]¶ -
begin_create_or_update_at_subscription_scope
(deployment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DeploymentExtended] Deploys resources at subscription scope.
You can provide the template and parameters directly in the request or link to JSON files.
- Parameters
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
- Raises
-
begin_delete
(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a deployment from the deployment history.
A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
- 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) – 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
- Raises
-
begin_delete_at_subscription_scope
(deployment_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a deployment from the deployment history.
A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
- Parameters
deployment_name (str) – The name of the deployment to delete. 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
- Raises
-
calculate_template_hash
(template: collections.abc.MutableMapping[str, Any], **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_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
- Raises
-
cancel
(resource_group_name: str, deployment_name: str, **kwargs: Any) → None[source]¶ Cancels a currently running template deployment.
You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
- 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
-
cancel_at_subscription_scope
(deployment_name: str, **kwargs: Any) → None[source]¶ Cancels a currently running template deployment.
You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
-
check_existence
(resource_group_name: str, deployment_name: str, **kwargs: Any) → bool[source]¶ Checks whether the deployment exists.
- Parameters
- 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
- Raises
-
check_existence_at_subscription_scope
(deployment_name: str, **kwargs: Any) → bool[source]¶ Checks whether the deployment exists.
-
export_template
(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExportResult[source]¶ Exports the template used for specified deployment.
- 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
-
export_template_at_subscription_scope
(deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExportResult[source]¶ Exports the template used for specified deployment.
-
get
(resource_group_name: str, deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExtended[source]¶ Gets 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
-
get_at_subscription_scope
(deployment_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExtended[source]¶ Gets a deployment.
-
list_at_subscription_scope
(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExtended][source]¶ Get all the deployments for a subscription.
- Parameters
- 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
- Raises
-
list_by_resource_group
(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.DeploymentExtended][source]¶ Get all the deployments for a resource group.
- Parameters
resource_group_name (str) – The name of the resource group with the deployments to get. The name is case insensitive. Required.
filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’. Default value is None.
top (int) – The number of results to get. 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
- Raises
-
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 Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
- Parameters
resource_group_name (str) – The name of the resource group the template will be deployed to. The name is case insensitive. Required.
deployment_name (str) – The name of the deployment. Required.
parameters (Deployment or IO) – Parameters to validate. Is either a Deployment type or a IO type. Required.
- Keyword Arguments
- Returns
DeploymentValidateResult or the result of cls(response)
- Return type
- Raises
-
validate_at_subscription_scope
(deployment_name: str, parameters: _models.Deployment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeploymentValidateResult[source]¶ -
validate_at_subscription_scope
(deployment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DeploymentValidateResult Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
- Parameters
deployment_name (str) – The name of the deployment. Required.
parameters (Deployment or IO) – Parameters to validate. Is either a Deployment type or a IO type. Required.
- Keyword Arguments
- Returns
DeploymentValidateResult or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
Operations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’soperations
attribute.-
list
(**kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.Operation][source]¶ Lists all of the available Microsoft.Resources 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
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ProvidersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’sproviders
attribute.-
get
(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.Provider[source]¶ Gets the specified 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
-
list
(top: Optional[int] = None, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.Provider][source]¶ Gets all resource providers for a subscription.
- Parameters
top (int) – The number of results to return. If null is passed returns all deployments. Default value is None.
expand (str) – The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. 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
- Raises
-
register
(resource_provider_namespace: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.Provider[source]¶ Registers a subscription with a resource provider.
-
unregister
(resource_provider_namespace: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.Provider[source]¶ Unregisters a subscription from a resource provider.
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ResourceGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’sresource_groups
attribute.-
begin_delete
(resource_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a resource group.
When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
- Parameters
resource_group_name (str) – The name of the resource group to delete. 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
- Raises
-
check_existence
(resource_group_name: str, **kwargs: Any) → bool[source]¶ Checks whether a resource group exists.
-
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 Creates or updates a resource group.
- Parameters
resource_group_name (str) – The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters. Required.
parameters (ResourceGroup or IO) – Parameters supplied to the create or update a resource group. Is either a ResourceGroup type or a IO type. Required.
- Keyword Arguments
- Returns
ResourceGroup or the result of cls(response)
- Return type
- Raises
-
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 export as a template. Required.
parameters (ExportTemplateRequest or IO) – Parameters for exporting the template. Is either a ExportTemplateRequest type or a IO type. Required.
- Keyword Arguments
- Returns
ResourceGroupExportResult or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.ResourceGroup[source]¶ Gets a resource group.
-
list
(filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.ResourceGroup][source]¶ Gets all the resource groups for a subscription.
- Parameters
filter (str) – The filter to apply on the operation.:code:<br>:code:`<br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq ‘tag1’ and tagValue eq ‘Value1’. Default value is None.
top (int) – The number of results to return. 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
- Raises
-
update
(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ResourceGroup[source]¶ -
update
(resource_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ResourceGroup Updates a resource group.
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 group. If a field is unspecified, the current value is retained.
- Parameters
resource_group_name (str) – The name of the resource group to update. The name is case insensitive. Required.
parameters (ResourceGroupPatchable or IO) – Parameters supplied to update a resource group. Is either a ResourceGroupPatchable type or a IO type. Required.
- Keyword Arguments
- Returns
ResourceGroup or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ResourcesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’sresources
attribute.-
begin_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) → LROPoller[_models.GenericResource][source]¶ -
begin_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) → LROPoller[_models.GenericResource] Creates 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 create. Required.
resource_name (str) – The name of the resource to create. Required.
api_version (str) – The API version to use for the operation. Required.
parameters (GenericResource or IO) – Parameters for creating or 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
- Raises
-
begin_create_or_update_by_id
(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource][source]¶ -
begin_create_or_update_by_id
(resource_id: str, api_version: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource] Create a resource by ID.
- Parameters
resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Required.
api_version (str) – The API version to use for the operation. 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
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
- Raises
-
begin_delete
(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a resource.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource to delete. 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. Required.
resource_name (str) – The name of the resource to delete. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
begin_delete_by_id
(resource_id: str, api_version: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a resource by ID.
- Parameters
resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
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] Moves resources from one resource group to another resource group.
The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
- Parameters
source_resource_group_name (str) – The name of the resource group containing the resources to move. Required.
parameters (ResourcesMoveInfo or IO) – Parameters for moving resources. 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
- Raises
-
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
- Raises
-
begin_update_by_id
(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource][source]¶ -
begin_update_by_id
(resource_id: str, api_version: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GenericResource] Updates a resource by ID.
- Parameters
resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Required.
api_version (str) – The API version to use for the operation. Required.
parameters (GenericResource or IO) – 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
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
- Raises
-
begin_validate_move_resources
(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]¶ -
begin_validate_move_resources
(source_resource_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None] Validates whether resources can be moved from one resource group to another resource group.
This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
- Parameters
source_resource_group_name (str) – The name of the resource group containing the resources to validate for move. Required.
parameters (ResourcesMoveInfo or IO) – Parameters for moving resources. 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
- Raises
-
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 a resource exists.
- Parameters
resource_group_name (str) – The name of the resource group containing the resource to check. The name is case insensitive. Required.
resource_provider_namespace (str) – The resource provider of the resource to check. Required.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type. Required.
resource_name (str) – The name of the resource to check whether it exists. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
check_existence_by_id
(resource_id: str, api_version: str, **kwargs: Any) → bool[source]¶ Checks by ID whether a resource exists.
- Parameters
resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
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.v2018_05_01.models._models_py3.GenericResource[source]¶ Gets a resource.
- Parameters
resource_group_name (str) – The name of the resource group containing the resource to get. 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. Required.
resource_name (str) – The name of the resource to get. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
get_by_id
(resource_id: str, api_version: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.GenericResource[source]¶ Gets a resource by ID.
- Parameters
resource_id (str) – The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}. Required.
api_version (str) – The API version to use for the operation. 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
- Raises
-
list
(filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.GenericResourceExpanded][source]¶ Get all the resources in a subscription.
- Parameters
filter (str) – The filter to apply on the operation.:code:<br>
<br>`The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:`<br>
<br>`For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:`<br>
<br>`You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.:code:`<br>
<br>`For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name):code:`<br>
<br>`You can link more than one substringof together by adding and/or operators.:code:`<br>
<br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1':code:`<br>
:code:`<br>`You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. Default value is None.expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include
createdTime
,changedTime
andprovisioningState
. 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
- Raises
-
list_by_resource_group
(resource_group_name: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.GenericResourceExpanded][source]¶ Get all the resources for a resource group.
- Parameters
resource_group_name (str) – The resource group with the resources to get. Required.
filter (str) – The filter to apply on the operation.:code:<br>
<br>`The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.:code:`<br>
<br>`For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:`<br>
<br>`You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.:code:`<br>
<br>`For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name):code:`<br>
<br>`You can link more than one substringof together by adding and/or operators.:code:`<br>
<br>`You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1':code:`<br>
:code:`<br>`You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. Default value is None.expand (str) – Comma-separated list of additional properties to be included in the response. Valid values include
createdTime
,changedTime
andprovisioningState
. 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
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
TagsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ResourceManagementClient
’stags
attribute.-
create_or_update
(tag_name: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.TagDetails[source]¶ Creates a tag in the subscription.
The tag name can have a maximum of 512 characters and is case insensitive. Tag names created by Azure have prefixes of microsoft, azure, or windows. You cannot create tags with one of these prefixes.
-
create_or_update_value
(tag_name: str, tag_value: str, **kwargs: Any) → azure.mgmt.resource.resources.v2018_05_01.models._models_py3.TagValue[source]¶ Creates a tag value. The name of the tag must already exist.
- 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
-
delete
(tag_name: str, **kwargs: Any) → None[source]¶ Deletes a tag from the subscription.
You must remove all values from a resource tag before you can delete it.
-
delete_value
(tag_name: str, tag_value: str, **kwargs: Any) → None[source]¶ Deletes a tag value.
- 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
-
list
(**kwargs: Any) → Iterable[azure.mgmt.resource.resources.v2018_05_01.models._models_py3.TagDetails][source]¶ Gets the names and values of all resource tags that are defined in a subscription.
- 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
- Raises
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/mnt/vss/_work/1/s/sdk/resources/azure-mgmt-resource/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-