azure.mgmt.resource package

class azure.mgmt.resource.ApplicationClient(credential: ‘TokenCredential’, subscription_id: str, base_url: Optional[str] = None, **kwargs: Any)[source]

ARM applications.

Variables
Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • base_url (str) – Service URL

Keyword Arguments

polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

close() → None[source]
class azure.mgmt.resource.DeploymentScriptsClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

The APIs listed in this specification can be used to manage Deployment Scripts resource through the Azure Resource Manager.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – Subscription Id which forms part of the URI for every service call.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

Keyword Arguments

polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client

close()[source]
classmethod models(api_version='2020-10-01')[source]

Module depends on the API version:

  • 2019-10-01-preview: v2019_10_01_preview.models

  • 2020-10-01: v2020_10_01.models

DEFAULT_API_VERSION = '2020-10-01'
LATEST_PROFILE = azure.mgmt.resource.DeploymentScriptsClient latest
property deployment_scripts

Instance depends on the API version:

  • 2019-10-01-preview: DeploymentScriptsOperations

  • 2020-10-01: DeploymentScriptsOperations

class azure.mgmt.resource.FeatureClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

Azure Feature Exposure Control (AFEC) provides a mechanism for the resource providers to control feature exposure to users. Resource providers typically use this mechanism to provide public/private preview for new features prior to making them generally available. Users need to explicitly register for AFEC features to get access to such functionality.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

close()[source]
list_operations(**kwargs)

Lists all of the available Microsoft.Features 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 OperationListResult or the result of cls(response)

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

classmethod models(api_version='2015-12-01')[source]

Module depends on the API version:

  • 2015-12-01: v2015_12_01.models

DEFAULT_API_VERSION = '2015-12-01'
LATEST_PROFILE = azure.mgmt.resource.FeatureClient latest
property features

Instance depends on the API version:

  • 2015-12-01: FeaturesOperations

class azure.mgmt.resource.PolicyClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

To manage and control access to your resources, you can define customized policies and assign them at a scope.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client

close()[source]
classmethod models(api_version='2019-09-01')[source]

Module depends on the API version:

  • 2015-10-01-preview: v2015_10_01_preview.models

  • 2016-04-01: v2016_04_01.models

  • 2016-12-01: v2016_12_01.models

  • 2017-06-01-preview: v2017_06_01_preview.models

  • 2018-03-01: v2018_03_01.models

  • 2018-05-01: v2018_05_01.models

  • 2019-01-01: v2019_01_01.models

  • 2019-06-01: v2019_06_01.models

  • 2019-09-01: v2019_09_01.models

DEFAULT_API_VERSION = '2019-09-01'
LATEST_PROFILE = azure.mgmt.resource.PolicyClient latest
property policy_assignments

Instance depends on the API version:

  • 2015-10-01-preview: PolicyAssignmentsOperations

  • 2016-04-01: PolicyAssignmentsOperations

  • 2016-12-01: PolicyAssignmentsOperations

  • 2017-06-01-preview: PolicyAssignmentsOperations

  • 2018-03-01: PolicyAssignmentsOperations

  • 2018-05-01: PolicyAssignmentsOperations

  • 2019-01-01: PolicyAssignmentsOperations

  • 2019-06-01: PolicyAssignmentsOperations

  • 2019-09-01: PolicyAssignmentsOperations

property policy_definitions

Instance depends on the API version:

  • 2015-10-01-preview: PolicyDefinitionsOperations

  • 2016-04-01: PolicyDefinitionsOperations

  • 2016-12-01: PolicyDefinitionsOperations

  • 2017-06-01-preview: PolicyDefinitionsOperations

  • 2018-03-01: PolicyDefinitionsOperations

  • 2018-05-01: PolicyDefinitionsOperations

  • 2019-01-01: PolicyDefinitionsOperations

  • 2019-06-01: PolicyDefinitionsOperations

  • 2019-09-01: PolicyDefinitionsOperations

property policy_set_definitions

Instance depends on the API version:

  • 2017-06-01-preview: PolicySetDefinitionsOperations

  • 2018-03-01: PolicySetDefinitionsOperations

  • 2018-05-01: PolicySetDefinitionsOperations

  • 2019-01-01: PolicySetDefinitionsOperations

  • 2019-06-01: PolicySetDefinitionsOperations

  • 2019-09-01: PolicySetDefinitionsOperations

class azure.mgmt.resource.ManagementLinkClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

Azure resources can be linked together to form logical relationships. You can establish links between resources belonging to different resource groups. However, all the linked resources must belong to the same subscription. Each resource can be linked to 50 other resources. If any of the linked resources are deleted or moved, the link owner must clean up the remaining link.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client

close()[source]
classmethod models(api_version='2016-09-01')[source]

Module depends on the API version:

  • 2016-09-01: v2016_09_01.models

DEFAULT_API_VERSION = '2016-09-01'
LATEST_PROFILE = azure.mgmt.resource.ManagementLinkClient latest
property operations

Instance depends on the API version:

  • 2016-09-01: Operations

Instance depends on the API version:

  • 2016-09-01: ResourceLinksOperations

class azure.mgmt.resource.ManagementLockClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

Azure resources can be locked to prevent other users in your organization from deleting or modifying resources.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client

close()[source]
classmethod models(api_version='2016-09-01')[source]

Module depends on the API version:

  • 2015-01-01: v2015_01_01.models

  • 2016-09-01: v2016_09_01.models

DEFAULT_API_VERSION = '2016-09-01'
LATEST_PROFILE = azure.mgmt.resource.ManagementLockClient latest
property authorization_operations

Instance depends on the API version:

  • 2016-09-01: AuthorizationOperationsOperations

property management_locks

Instance depends on the API version:

  • 2015-01-01: ManagementLocksOperations

  • 2016-09-01: ManagementLocksOperations

class azure.mgmt.resource.ResourceManagementClient(credential, subscription_id, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

Provides operations for working with resources and resource groups.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • subscription_id (str) – The ID of the target subscription.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

Keyword Arguments

polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client

close()[source]
classmethod models(api_version='2020-06-01')[source]

Module depends on the API version:

  • 2016-02-01: v2016_02_01.models

  • 2016-09-01: v2016_09_01.models

  • 2017-05-10: v2017_05_10.models

  • 2018-02-01: v2018_02_01.models

  • 2018-05-01: v2018_05_01.models

  • 2019-03-01: v2019_03_01.models

  • 2019-05-01: v2019_05_01.models

  • 2019-05-10: v2019_05_10.models

  • 2019-07-01: v2019_07_01.models

  • 2019-08-01: v2019_08_01.models

  • 2019-10-01: v2019_10_01.models

  • 2020-06-01: v2020_06_01.models

DEFAULT_API_VERSION = '2020-06-01'
LATEST_PROFILE = azure.mgmt.resource.ResourceManagementClient latest
property deployment_operations

Instance depends on the API version:

  • 2016-02-01: DeploymentOperationsOperations

  • 2016-09-01: DeploymentOperationsOperations

  • 2017-05-10: DeploymentOperationsOperations

  • 2018-02-01: DeploymentOperationsOperations

  • 2018-05-01: DeploymentOperationsOperations

  • 2019-03-01: DeploymentOperationsOperations

  • 2019-05-01: DeploymentOperationsOperations

  • 2019-05-10: DeploymentOperationsOperations

  • 2019-07-01: DeploymentOperationsOperations

  • 2019-08-01: DeploymentOperationsOperations

  • 2019-10-01: DeploymentOperationsOperations

  • 2020-06-01: DeploymentOperationsOperations

property deployments

Instance depends on the API version:

  • 2016-02-01: DeploymentsOperations

  • 2016-09-01: DeploymentsOperations

  • 2017-05-10: DeploymentsOperations

  • 2018-02-01: DeploymentsOperations

  • 2018-05-01: DeploymentsOperations

  • 2019-03-01: DeploymentsOperations

  • 2019-05-01: DeploymentsOperations

  • 2019-05-10: DeploymentsOperations

  • 2019-07-01: DeploymentsOperations

  • 2019-08-01: DeploymentsOperations

  • 2019-10-01: DeploymentsOperations

  • 2020-06-01: DeploymentsOperations

property operations

Instance depends on the API version:

  • 2018-05-01: Operations

  • 2019-03-01: Operations

  • 2019-05-01: Operations

  • 2019-05-10: Operations

  • 2019-07-01: Operations

  • 2019-08-01: Operations

  • 2019-10-01: Operations

  • 2020-06-01: Operations

property providers

Instance depends on the API version:

  • 2016-02-01: ProvidersOperations

  • 2016-09-01: ProvidersOperations

  • 2017-05-10: ProvidersOperations

  • 2018-02-01: ProvidersOperations

  • 2018-05-01: ProvidersOperations

  • 2019-03-01: ProvidersOperations

  • 2019-05-01: ProvidersOperations

  • 2019-05-10: ProvidersOperations

  • 2019-07-01: ProvidersOperations

  • 2019-08-01: ProvidersOperations

  • 2019-10-01: ProvidersOperations

  • 2020-06-01: ProvidersOperations

property resource_groups

Instance depends on the API version:

  • 2016-02-01: ResourceGroupsOperations

  • 2016-09-01: ResourceGroupsOperations

  • 2017-05-10: ResourceGroupsOperations

  • 2018-02-01: ResourceGroupsOperations

  • 2018-05-01: ResourceGroupsOperations

  • 2019-03-01: ResourceGroupsOperations

  • 2019-05-01: ResourceGroupsOperations

  • 2019-05-10: ResourceGroupsOperations

  • 2019-07-01: ResourceGroupsOperations

  • 2019-08-01: ResourceGroupsOperations

  • 2019-10-01: ResourceGroupsOperations

  • 2020-06-01: ResourceGroupsOperations

property resources

Instance depends on the API version:

  • 2016-02-01: ResourcesOperations

  • 2016-09-01: ResourcesOperations

  • 2017-05-10: ResourcesOperations

  • 2018-02-01: ResourcesOperations

  • 2018-05-01: ResourcesOperations

  • 2019-03-01: ResourcesOperations

  • 2019-05-01: ResourcesOperations

  • 2019-05-10: ResourcesOperations

  • 2019-07-01: ResourcesOperations

  • 2019-08-01: ResourcesOperations

  • 2019-10-01: ResourcesOperations

  • 2020-06-01: ResourcesOperations

property tags

Instance depends on the API version:

  • 2016-02-01: TagsOperations

  • 2016-09-01: TagsOperations

  • 2017-05-10: TagsOperations

  • 2018-02-01: TagsOperations

  • 2018-05-01: TagsOperations

  • 2019-03-01: TagsOperations

  • 2019-05-01: TagsOperations

  • 2019-05-10: TagsOperations

  • 2019-07-01: TagsOperations

  • 2019-08-01: TagsOperations

  • 2019-10-01: TagsOperations

  • 2020-06-01: TagsOperations

class azure.mgmt.resource.SubscriptionClient(credential, api_version=None, base_url=None, profile=<KnownProfiles.default: <azure.profiles.DefaultProfile object>>, **kwargs)[source]

All resource groups and resources exist within subscriptions. These operation enable you get information about your subscriptions and tenants. A tenant is a dedicated instance of Azure Active Directory (Azure AD) for your organization.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Parameters

  • credential (TokenCredential) – Credential needed for the client to connect to Azure.

  • api_version (str) – API version to use if no profile is provided, or if missing in profile.

  • base_url (str) – Service URL

  • profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.

check_resource_name(resource_name_definition=None, **kwargs)

Checks resource name validity.

A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word.

Parameters

resource_name_definition (ResourceName) – Resource object with values for resource name and resource type.

Keyword Arguments

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

Returns

CheckResourceNameResult, or the result of cls(response)

Return type

CheckResourceNameResult

Raises

~azure.core.exceptions.HttpResponseError

close()[source]
classmethod models(api_version='2019-11-01')[source]

Module depends on the API version:

  • 2016-06-01: v2016_06_01.models

  • 2018-06-01: v2018_06_01.models

  • 2019-06-01: v2019_06_01.models

  • 2019-11-01: v2019_11_01.models

DEFAULT_API_VERSION = '2019-11-01'
LATEST_PROFILE = azure.mgmt.resource.SubscriptionClient latest
property operations

Instance depends on the API version:

  • 2016-06-01: Operations

  • 2018-06-01: Operations

  • 2019-06-01: Operations

  • 2019-11-01: Operations

property subscriptions

Instance depends on the API version:

  • 2016-06-01: SubscriptionsOperations

  • 2018-06-01: SubscriptionsOperations

  • 2019-06-01: SubscriptionsOperations

  • 2019-11-01: SubscriptionsOperations

property tenants

Instance depends on the API version:

  • 2016-06-01: TenantsOperations

  • 2018-06-01: TenantsOperations

  • 2019-06-01: TenantsOperations

  • 2019-11-01: TenantsOperations

Subpackages