azure.mgmt.resource.resources.v2018_05_01.operations module¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available Microsoft.Resources REST API operations.
- Parameters
- Returns
An iterator like instance of Operation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
DeploymentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeploymentsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
calculate_template_hash
(template, custom_headers=None, raw=False, **operation_config)[source]¶ Calculate the hash of the given template.
- Parameters
- Returns
TemplateHashResult or ClientRawResponse if raw=true
- Return type
TemplateHashResult or ClientRawResponse
- Raises
CloudError
-
cancel
(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[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
resource_group_name (str) – The name of the resource group. The name is case insensitive.
deployment_name (str) – The name of the deployment to cancel.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
cancel_at_subscription_scope
(deployment_name, custom_headers=None, raw=False, **operation_config)[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.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
check_existence
(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Checks whether the deployment exists.
- Parameters
resource_group_name (str) – The name of the resource group with the deployment to check. The name is case insensitive.
deployment_name (str) – The name of the deployment to check.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
CloudError
-
check_existence_at_subscription_scope
(deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Checks whether the deployment exists.
- Parameters
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
CloudError
-
create_or_update
(resource_group_name, deployment_name, properties, location=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
deployment_name (str) – The name of the deployment.
properties (DeploymentProperties) – The deployment properties.
location (str) – The location to store the deployment data.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns DeploymentExtended or ClientRawResponse<DeploymentExtended> if raw==True
- Return type
AzureOperationPoller[DeploymentExtended] or AzureOperationPoller[ClientRawResponse[DeploymentExtended]]
- Raises
CloudError
-
create_or_update_at_subscription_scope
(deployment_name, properties, location=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
properties (DeploymentProperties) – The deployment properties.
location (str) – The location to store the deployment data.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns DeploymentExtended or ClientRawResponse<DeploymentExtended> if raw==True
- Return type
AzureOperationPoller[DeploymentExtended] or AzureOperationPoller[ClientRawResponse[DeploymentExtended]]
- Raises
CloudError
-
delete
(resource_group_name, deployment_name, custom_headers=None, raw=False, polling=True, **operation_config)[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
resource_group_name (str) – The name of the resource group with the deployment to delete. The name is case insensitive.
deployment_name (str) – The name of the deployment to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
delete_at_subscription_scope
(deployment_name, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
export_template
(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Exports the template used for specified 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 from which to get the template.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentExportResult or ClientRawResponse if raw=true
- Return type
DeploymentExportResult or ClientRawResponse
- Raises
CloudError
-
export_template_at_subscription_scope
(deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Exports the template used for specified deployment.
- Parameters
- Returns
DeploymentExportResult or ClientRawResponse if raw=true
- Return type
DeploymentExportResult or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a 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 get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentExtended or ClientRawResponse if raw=true
- Return type
DeploymentExtended or ClientRawResponse
- Raises
CloudError
-
get_at_subscription_scope
(deployment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a deployment.
- Parameters
- Returns
DeploymentExtended or ClientRawResponse if raw=true
- Return type
DeploymentExtended or ClientRawResponse
- Raises
CloudError
-
list_at_subscription_scope
(filter=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get all the deployments for a subscription.
- Parameters
filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.
top (int) – The number of results to get. 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_config – Operation configuration overrides.
- Returns
An iterator like instance of DeploymentExtended
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, filter=None, top=None, custom_headers=None, raw=False, **operation_config)[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.
filter (str) – The filter to apply on the operation. For example, you can use $filter=provisioningState eq ‘{state}’.
top (int) – The number of results to get. 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_config – Operation configuration overrides.
- Returns
An iterator like instance of DeploymentExtended
- Return type
- Raises
CloudError
-
validate
(resource_group_name, deployment_name, properties, location=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
deployment_name (str) – The name of the deployment.
properties (DeploymentProperties) – The deployment properties.
location (str) – The location to store the deployment data.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentValidateResult or ClientRawResponse if raw=true
- Return type
DeploymentValidateResult or ClientRawResponse
- Raises
CloudError
-
validate_at_subscription_scope
(deployment_name, properties, location=None, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
properties (DeploymentProperties) – The deployment properties.
location (str) – The location to store the deployment data.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentValidateResult or ClientRawResponse if raw=true
- Return type
DeploymentValidateResult or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ProvidersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ProvidersOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
get
(resource_provider_namespace, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the specified resource provider.
- Parameters
resource_provider_namespace (str) – The namespace of the resource provider.
expand (str) – The $expand query parameter. For example, 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_config – Operation configuration overrides.
- Returns
Provider or ClientRawResponse if raw=true
- Return type
Provider or ClientRawResponse
- Raises
CloudError
-
list
(top=None, expand=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all resource providers for a subscription.
- Parameters
top (int) – The number of results to return. If null is passed returns all deployments.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Provider
- Return type
- Raises
CloudError
-
register
(resource_provider_namespace, custom_headers=None, raw=False, **operation_config)[source]¶ Registers a subscription with a resource provider.
- Parameters
- Returns
Provider or ClientRawResponse if raw=true
- Return type
Provider or ClientRawResponse
- Raises
CloudError
-
unregister
(resource_provider_namespace, custom_headers=None, raw=False, **operation_config)[source]¶ Unregisters a subscription from a resource provider.
- Parameters
- Returns
Provider or ClientRawResponse if raw=true
- Return type
Provider or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ResourcesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ResourcesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-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 a resource exists.
- Parameters
resource_group_name (str) – The name of the resource group containing the resource to check. The name is case insensitive.
resource_provider_namespace (str) – The resource provider of the resource to check.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type.
resource_name (str) – The name of the resource to check whether it exists.
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
CloudError
-
check_existence_by_id
(resource_id, api_version, custom_headers=None, raw=False, **operation_config)[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}
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- 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, polling=True, **operation_config)[source]¶ Creates a resource.
- Parameters
resource_group_name (str) – The name of the resource group for the resource. The name is case insensitive.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the resource to create.
resource_name (str) – The name of the resource to create.
api_version (str) – The API version to use for the operation.
parameters (GenericResource) – Parameters for creating or updating the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns GenericResource or ClientRawResponse<GenericResource> if raw==True
- Return type
AzureOperationPoller[GenericResource] or AzureOperationPoller[ClientRawResponse[GenericResource]]
- Raises
CloudError
-
create_or_update_by_id
(resource_id, api_version, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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}
api_version (str) – The API version to use for the operation.
parameters (GenericResource) – Create or update resource parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns GenericResource or ClientRawResponse<GenericResource> if raw==True
- Return type
AzureOperationPoller[GenericResource] or AzureOperationPoller[ClientRawResponse[GenericResource]]
- Raises
CloudError
-
delete
(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, custom_headers=None, raw=False, polling=True, **operation_config)[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.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type.
resource_name (str) – The name of the resource to delete.
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
delete_by_id
(resource_id, api_version, custom_headers=None, raw=False, polling=True, **operation_config)[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}
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- 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]¶ Gets a resource.
- Parameters
resource_group_name (str) – The name of the resource group containing the resource to get. The name is case insensitive.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the resource.
resource_name (str) – The name of the resource to get.
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GenericResource or ClientRawResponse if raw=true
- Return type
GenericResource or ClientRawResponse
- Raises
CloudError
-
get_by_id
(resource_id, api_version, custom_headers=None, raw=False, **operation_config)[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}
api_version (str) – The API version to use for the operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GenericResource or ClientRawResponse if raw=true
- Return type
GenericResource or ClientRawResponse
- Raises
CloudError
-
list
(filter=None, expand=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get all the resources in a subscription.
- Parameters
filter (str) – The filter to apply on the operation.<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.<br><br>For example, to filter by a resource type, use: $filter=resourceType eq ‘Microsoft.Network/virtualNetworks’<br><br>You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.<br><br>For example, to get all resources with ‘demo’ anywhere in the name, use: $filter=substringof(‘demo’, name)<br><br>You can link more than one substringof together by adding and/or operators.<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’<br><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.
expand (str) – The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime
top (int) – The number of results to return. 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_config – Operation configuration overrides.
- Returns
An iterator like instance of GenericResource
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, filter=None, expand=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get all the resources for a resource group.
- Parameters
resource_group_name (str) – The resource group with the resources to get.
filter (str) – The filter to apply on the operation.<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.<br><br>For example, to filter by a resource type, use: $filter=resourceType eq ‘Microsoft.Network/virtualNetworks’<br><br>You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.<br><br>For example, to get all resources with ‘demo’ anywhere in the name, use: $filter=substringof(‘demo’, name)<br><br>You can link more than one substringof together by adding and/or operators.<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’<br><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.
expand (str) – The $expand query parameter. You can expand createdTime and changedTime. For example, to expand both properties, use $expand=changedTime,createdTime
top (int) – The number of results to return. If null is passed, returns all resources.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GenericResource
- Return type
- Raises
CloudError
-
move_resources
(source_resource_group_name, resources=None, target_resource_group=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
target_resource_group (str) – The target resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
update
(resource_group_name, resource_provider_namespace, parent_resource_path, resource_type, resource_name, api_version, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a resource.
- Parameters
resource_group_name (str) – The name of the resource group for the resource. The name is case insensitive.
resource_provider_namespace (str) – The namespace of the resource provider.
parent_resource_path (str) – The parent resource identity.
resource_type (str) – The resource type of the resource to update.
resource_name (str) – The name of the resource to update.
api_version (str) – The API version to use for the operation.
parameters (GenericResource) – Parameters for updating the resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns GenericResource or ClientRawResponse<GenericResource> if raw==True
- Return type
AzureOperationPoller[GenericResource] or AzureOperationPoller[ClientRawResponse[GenericResource]]
- Raises
CloudError
-
update_by_id
(resource_id, api_version, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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}
api_version (str) – The API version to use for the operation.
parameters (GenericResource) – Update resource parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns GenericResource or ClientRawResponse<GenericResource> if raw==True
- Return type
AzureOperationPoller[GenericResource] or AzureOperationPoller[ClientRawResponse[GenericResource]]
- Raises
CloudError
-
validate_move_resources
(source_resource_group_name, resources=None, target_resource_group=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
target_resource_group (str) – The target resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
ResourceGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ResourceGroupsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
check_existence
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Checks whether a resource group exists.
- Parameters
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
CloudError
-
create_or_update
(resource_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
parameters (ResourceGroup) – Parameters supplied to the create or update a resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ResourceGroup or ClientRawResponse if raw=true
- Return type
ResourceGroup or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- 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 export as a template.
resources (list[str]) – The IDs of the resources to filter the export by. To export all resources, supply an array with single entry ‘*’.
options (str) – The export template options. A CSV-formatted list containing zero or more of the following: ‘IncludeParameterDefaultValue’, ‘IncludeComments’, ‘SkipResourceNameParameterization’, ‘SkipAllParameterization’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ResourceGroupExportResult or ClientRawResponse if raw=true
- Return type
ResourceGroupExportResult or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a resource group.
- Parameters
- Returns
ResourceGroup or ClientRawResponse if raw=true
- Return type
ResourceGroup or ClientRawResponse
- Raises
CloudError
-
list
(filter=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all the resource groups for a subscription.
- Parameters
filter (str) – The filter to apply on the operation.<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’
top (int) – The number of results to return. 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_config – Operation configuration overrides.
- Returns
An iterator like instance of ResourceGroup
- Return type
- Raises
CloudError
-
update
(resource_group_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
parameters (ResourceGroupPatchable) – Parameters supplied to update a resource group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ResourceGroup or ClientRawResponse if raw=true
- Return type
ResourceGroup or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
TagsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TagsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
create_or_update
(tag_name, custom_headers=None, raw=False, **operation_config)[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.
- Parameters
- Returns
TagDetails or ClientRawResponse if raw=true
- Return type
TagDetails or ClientRawResponse
- Raises
CloudError
-
create_or_update_value
(tag_name, tag_value, custom_headers=None, raw=False, **operation_config)[source]¶ Creates a tag value. The name of the tag must already exist.
- Parameters
- Returns
TagValue or ClientRawResponse if raw=true
- Return type
TagValue or ClientRawResponse
- Raises
CloudError
-
delete
(tag_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a tag from the subscription.
You must remove all values from a resource tag before you can delete it.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
delete_value
(tag_name, tag_value, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a tag value.
- Parameters
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets the names and values of all resource tags that are defined in a subscription.
- Parameters
- Returns
An iterator like instance of TagDetails
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶
-
class
azure.mgmt.resource.resources.v2018_05_01.operations.
DeploymentOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DeploymentOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for this operation. Constant value: “2018-05-01”.
-
get
(resource_group_name, deployment_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a deployments operation.
- 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) – The ID of the operation to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentOperation or ClientRawResponse if raw=true
- Return type
DeploymentOperation or ClientRawResponse
- Raises
CloudError
-
get_at_subscription_scope
(deployment_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a deployments operation.
- Parameters
deployment_name (str) – The name of the deployment.
operation_id (str) – The ID of the operation to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DeploymentOperation or ClientRawResponse if raw=true
- Return type
DeploymentOperation or ClientRawResponse
- Raises
CloudError
-
list
(resource_group_name, deployment_name, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all deployments operations for a 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 with the operation to get.
top (int) – The number of results to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DeploymentOperation
- Return type
- Raises
CloudError
-
list_at_subscription_scope
(deployment_name, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all deployments operations for a deployment.
- Parameters
deployment_name (str) – The name of the deployment with the operation to get.
top (int) – The number of results to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DeploymentOperation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.resource.resources.v2018_05_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/resource/resources/v2018_05_01/models/__init__.py'>¶