ArmClient

Classes

LocationListResult dataclass

LocationListResult(*, value: Optional[List[Location | Mapping[str, Any]]] = None)

Response for Lists the subscription locations

Attributes

value class-attribute instance-attribute

value: Optional[List[Location | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The locations.

Subscription dataclass

Subscription(*, id: Optional[str] = None, subscription_id: Optional[str] = None, tenant_id: Optional[str] = None, display_name: Optional[str] = None, state: Optional[str] = None, subscription_policies: Optional[SubscriptionPolicies | Mapping[str, Any]] = None, authorization_source: Optional[str] = None)

Response for Read a subscription

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The tenant Id.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The subscription display name.

state class-attribute instance-attribute

state: Optional[str] = dataclass_field(default=None, kw_only=True)

The subscription state.

authorization_source class-attribute instance-attribute

authorization_source: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'authorizationSource'})

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

SubscriptionListResult dataclass

SubscriptionListResult(*, value: Optional[List[Subscription | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List subscriptions

Attributes

value class-attribute instance-attribute

value: Optional[List[Subscription | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The subscriptions.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

DeploymentExtended dataclass

DeploymentExtended(name: str, *, id: Optional[str] = None, properties: Optional[DeploymentPropertiesExtended | Mapping[str, Any]] = None)

Response for Read a template deployment

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the deployment.

name instance-attribute

name: str

The name of the deployment.

DeploymentValidateResult dataclass

DeploymentValidateResult(*, error: Optional[ResourceManagementErrorWithDetails | Mapping[str, Any]] = None, properties: Optional[DeploymentPropertiesExtended | Mapping[str, Any]] = None)

Response for Validate a template deployment

DeploymentExportResult dataclass

DeploymentExportResult(*, template: Optional[Dict[str, Any]] = None)

Response for Export deployment template

Attributes

template class-attribute instance-attribute

template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The template content.

DeploymentListResult dataclass

DeploymentListResult(*, value: Optional[List[DeploymentExtended | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List template deployments

Attributes

value class-attribute instance-attribute

value: Optional[List[DeploymentExtended | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of deployments.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

DeploymentOperation dataclass

DeploymentOperation(*, id: Optional[str] = None, operation_id: Optional[str] = None, properties: Optional[DeploymentOperationProperties | Mapping[str, Any]] = None)

Response for Read a template deployment operation

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Full deployment operation id.

operation_id class-attribute instance-attribute

operation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'operationId'})

Deployment operation id.

DeploymentOperationsListResult dataclass

DeploymentOperationsListResult(*, value: Optional[List[DeploymentOperation | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for Lists template deployment operations

Attributes

value class-attribute instance-attribute

value: Optional[List[DeploymentOperation | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of deployments.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

Provider dataclass

Provider(*, id: Optional[str] = None, namespace: Optional[str] = None, registration_state: Optional[str] = None, resource_types: Optional[List[ProviderResourceType | Mapping[str, Any]]] = None)

Response for Unregister resource provider

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The provider id.

namespace class-attribute instance-attribute

namespace: Optional[str] = dataclass_field(default=None, kw_only=True)

The namespace of the provider.

registration_state class-attribute instance-attribute

registration_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'registrationState'})

The registration state of the provider.

resource_types class-attribute instance-attribute

resource_types: Optional[List[ProviderResourceType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceTypes'})

The collection of provider resource types.

ProviderListResult dataclass

ProviderListResult(*, value: Optional[List[Provider | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resource providers

Attributes

value class-attribute instance-attribute

value: Optional[List[Provider | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource providers.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceListResult dataclass

ResourceListResult(*, value: Optional[List[GenericResource | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resources by resource group

Attributes

value class-attribute instance-attribute

value: Optional[List[GenericResource | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resources.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

ResourceGroup dataclass

ResourceGroup(location: str, *, id: Optional[str] = None, name: Optional[str] = None, managed_by: Optional[str] = None, tags: Optional[Dict[str, str]] = None, properties: Optional[ResourceGroupProperties | Mapping[str, Any]] = None)

Response for Read a resource group

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The Name of the resource group.

location instance-attribute

location: str

The location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc.

managed_by class-attribute instance-attribute

managed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managedBy'})

Id of the resource that manages this resource group.

tags class-attribute instance-attribute

tags: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

The tags attached to the resource group.

ResourceGroupExportResult dataclass

ResourceGroupExportResult(*, template: Optional[Dict[str, Any]] = None, error: Optional[ResourceManagementErrorWithDetails | Mapping[str, Any]] = None)

Response for Export a resource group template

Attributes

template class-attribute instance-attribute

template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The template content.

ResourceGroupListResult dataclass

ResourceGroupListResult(*, value: Optional[List[ResourceGroup | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List resource groups

Attributes

value class-attribute instance-attribute

value: Optional[List[ResourceGroup | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource groups.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

GenericResource dataclass

GenericResource(*, id: Optional[str] = None, name: Optional[str] = None, type_: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, plan: Optional[Plan | Mapping[str, Any]] = None, kind: Optional[str] = None, managed_by: Optional[str] = None, sku: Optional[Sku | Mapping[str, Any]] = None, identity: Optional[Identity | Mapping[str, Any]] = None, properties: Optional[Dict[str, Any]] = None)

Response for Read a resource

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource Id

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource name

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Resource type

location class-attribute instance-attribute

location: Optional[str] = dataclass_field(default=None, kw_only=True)

Resource location

tags class-attribute instance-attribute

tags: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

Resource tags

kind class-attribute instance-attribute

kind: Optional[str] = dataclass_field(default=None, kw_only=True)

The kind of the resource.

managed_by class-attribute instance-attribute

managed_by: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'managedBy'})

Id of the resource that manages this resource.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The resource properties.

ResourcesInvokeInput dataclass

ResourcesInvokeInput(*, additional_properties: Dict[str, Any] = dict())

Invoke resource operation

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ResourcesInvokeResponse dataclass

ResourcesInvokeResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Invoke resource operation

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ProviderResourcesInvokeInput dataclass

ProviderResourcesInvokeInput(*, additional_properties: Dict[str, Any] = dict())

Invoke resource operation in provider

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ProviderResourcesInvokeResponse dataclass

ProviderResourcesInvokeResponse(*, additional_properties: Dict[str, Any] = dict())

Response for Invoke resource operation in provider

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TagValue dataclass

TagValue(*, id: Optional[str] = None, tag_value: Optional[str] = None, count: Optional[TagCount | Mapping[str, Any]] = None)

Response for Create or update a subscription resource tag value

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The tag ID.

tag_value class-attribute instance-attribute

tag_value: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tagValue'})

The tag value.

TagDetails dataclass

TagDetails(*, id: Optional[str] = None, tag_name: Optional[str] = None, count: Optional[TagCount | Mapping[str, Any]] = None, values: Optional[List[TagValue | Mapping[str, Any]]] = None)

Response for Create or update a subscription resource tag name

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The tag ID.

tag_name class-attribute instance-attribute

tag_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tagName'})

The tag name.

values class-attribute instance-attribute

values: Optional[List[TagValue | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of tag values.

TagsListResult dataclass

TagsListResult(*, value: Optional[List[TagDetails | Mapping[str, Any]]] = None, next_link: Optional[str] = None)

Response for List subscription resource tags

Attributes

value class-attribute instance-attribute

value: Optional[List[TagDetails | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of tags.

next_link class-attribute instance-attribute

next_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextLink'})

The URL to get the next set of results.

Location dataclass

Location(*, id: Optional[str] = None, subscription_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, latitude: Optional[str] = None, longitude: Optional[str] = None)

Definition: Location

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The fully qualified Id of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.

subscription_id class-attribute instance-attribute

subscription_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'subscriptionId'})

The subscription Id.

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The location name.

display_name class-attribute instance-attribute

display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})

The display name of the location.

latitude class-attribute instance-attribute

latitude: Optional[str] = dataclass_field(default=None, kw_only=True)

The latitude of the location.

longitude class-attribute instance-attribute

longitude: Optional[str] = dataclass_field(default=None, kw_only=True)

The longitude of the location.

SubscriptionPolicies dataclass

SubscriptionPolicies(*, location_placement_id: Optional[str] = None, quota_id: Optional[str] = None, spending_limit: Optional[str] = None)

Definition: SubscriptionPolicies

Attributes

location_placement_id class-attribute instance-attribute

location_placement_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'locationPlacementId'})

The subscription location placement Id. The Id indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions.

quota_id class-attribute instance-attribute

quota_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'quotaId'})

The subscription quota Id.

spending_limit class-attribute instance-attribute

spending_limit: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'spendingLimit'})

The subscription spending limit.

TemplateLink dataclass

TemplateLink(uri: str, *, content_version: Optional[str] = None)

Definition: TemplateLink

Attributes

uri instance-attribute

uri: str

URI referencing the template.

content_version class-attribute instance-attribute

content_version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentVersion'})

If included it must match the ContentVersion in the template.

ParametersLink dataclass

ParametersLink(uri: str, *, content_version: Optional[str] = None)

Definition: ParametersLink

Attributes

uri instance-attribute

uri: str

URI referencing the template.

content_version class-attribute instance-attribute

content_version: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentVersion'})

If included it must match the ContentVersion in the template.

DeploymentProperties dataclass

DeploymentProperties(mode: str, *, template: Optional[Dict[str, Any]] = None, template_link: Optional[TemplateLink | Mapping[str, Any]] = None, parameters: Optional[Dict[str, Any]] = None, parameters_link: Optional[ParametersLink | Mapping[str, Any]] = None, debug_setting: Optional[DebugSetting | Mapping[str, Any]] = None)

Definition: DeploymentProperties

Attributes

template class-attribute instance-attribute

template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.

mode instance-attribute

mode: str

The deployment mode.

DebugSetting dataclass

DebugSetting(*, detail_level: Optional[str] = None)

Definition: DebugSetting

Attributes

detail_level class-attribute instance-attribute

detail_level: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'detailLevel'})

The debug detail level.

Deployment dataclass

Deployment(*, properties: Optional[DeploymentProperties | Mapping[str, Any]] = None)

Definition: Deployment

ResourceManagementErrorWithDetails dataclass

ResourceManagementErrorWithDetails(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[Dict[str, Any]]] = None)

Definition: ResourceManagementErrorWithDetails

Attributes

code class-attribute instance-attribute

code: Optional[str] = dataclass_field(default=None, kw_only=True)

The error code returned from the server.

message class-attribute instance-attribute

message: Optional[str] = dataclass_field(default=None, kw_only=True)

The error message returned from the server.

target class-attribute instance-attribute

target: Optional[str] = dataclass_field(default=None, kw_only=True)

The target of the error.

details class-attribute instance-attribute

details: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

Validation error.

AliasPathType dataclass

AliasPathType(*, path: Optional[str] = None, api_versions: Optional[List[str]] = None)

Definition: AliasPathType

Attributes

path class-attribute instance-attribute

path: Optional[str] = dataclass_field(default=None, kw_only=True)

The path of an alias.

api_versions class-attribute instance-attribute

api_versions: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'apiVersions'})

The api versions.

AliasType dataclass

AliasType(*, name: Optional[str] = None, paths: Optional[List[AliasPathType | Mapping[str, Any]]] = None)

Definition: AliasType

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The alias name.

paths class-attribute instance-attribute

paths: Optional[List[AliasPathType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The paths for an alias.

ProviderResourceType dataclass

ProviderResourceType(*, resource_type: Optional[str] = None, locations: Optional[List[ObjectWithoutType | Mapping[str, Any]]] = None, aliases: Optional[List[AliasType | Mapping[str, Any]]] = None, api_versions: Optional[List[str]] = None, properties: Optional[Dict[str, str]] = None)

Definition: ProviderResourceType

Attributes

resource_type class-attribute instance-attribute

resource_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceType'})

The resource type.

locations class-attribute instance-attribute

locations: Optional[List[ObjectWithoutType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The collection of locations where this resource type can be created in.

aliases class-attribute instance-attribute

aliases: Optional[List[AliasType | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The aliases that are supported by this resource type.

api_versions class-attribute instance-attribute

api_versions: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'apiVersions'})

The api version.

properties class-attribute instance-attribute

properties: Optional[Dict[str, str]] = dataclass_field(default=None, kw_only=True)

The properties.

BasicDependency dataclass

BasicDependency(*, id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None)

Definition: BasicDependency

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the dependency.

resource_type class-attribute instance-attribute

resource_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceType'})

The dependency resource type.

resource_name class-attribute instance-attribute

resource_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceName'})

The dependency resource name.

Dependency dataclass

Dependency(*, depends_on: Optional[List[BasicDependency | Mapping[str, Any]]] = None, id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None)

Definition: Dependency

Attributes

depends_on class-attribute instance-attribute

depends_on: Optional[List[BasicDependency | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'dependsOn'})

The list of dependencies.

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the dependency.

resource_type class-attribute instance-attribute

resource_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceType'})

The dependency resource type.

resource_name class-attribute instance-attribute

resource_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceName'})

The dependency resource name.

DeploymentPropertiesExtended dataclass

DeploymentPropertiesExtended(mode: str, *, provisioning_state: Optional[str] = None, correlation_id: Optional[str] = None, timestamp: Optional[str] = None, outputs: Optional[Dict[str, Any]] = None, providers: Optional[List[Provider | Mapping[str, Any]]] = None, dependencies: Optional[List[Dependency | Mapping[str, Any]]] = None, template: Optional[Dict[str, Any]] = None, template_link: Optional[TemplateLink | Mapping[str, Any]] = None, parameters: Optional[Dict[str, Any]] = None, parameters_link: Optional[ParametersLink | Mapping[str, Any]] = None, debug_setting: Optional[DebugSetting | Mapping[str, Any]] = None)

Definition: DeploymentPropertiesExtended

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The state of the provisioning.

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'correlationId'})

The correlation ID of the deployment.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

The timestamp of the template deployment.

outputs class-attribute instance-attribute

outputs: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Key/value pairs that represent deploymentoutput.

providers class-attribute instance-attribute

providers: Optional[List[Provider | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of resource providers needed for the deployment.

dependencies class-attribute instance-attribute

dependencies: Optional[List[Dependency | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

The list of deployment dependencies.

template class-attribute instance-attribute

template: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

The template content. Use only one of Template or TemplateLink.

parameters class-attribute instance-attribute

parameters: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

Deployment parameters. Use only one of Parameters or ParametersLink.

mode instance-attribute

mode: str

The deployment mode.

Plan dataclass

Plan(*, name: Optional[str] = None, publisher: Optional[str] = None, product: Optional[str] = None, promotion_code: Optional[str] = None)

Definition: Plan

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The plan ID.

publisher class-attribute instance-attribute

publisher: Optional[str] = dataclass_field(default=None, kw_only=True)

The publisher ID.

product class-attribute instance-attribute

product: Optional[str] = dataclass_field(default=None, kw_only=True)

The offer ID.

promotion_code class-attribute instance-attribute

promotion_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'promotionCode'})

The promotion code.

Sku dataclass

Sku(*, name: Optional[str] = None, tier: Optional[str] = None, size: Optional[str] = None, family: Optional[str] = None, model: Optional[str] = None, capacity: Optional[int] = None)

Definition: Sku

Attributes

name class-attribute instance-attribute

name: Optional[str] = dataclass_field(default=None, kw_only=True)

The sku name.

tier class-attribute instance-attribute

tier: Optional[str] = dataclass_field(default=None, kw_only=True)

The sku tier.

size class-attribute instance-attribute

size: Optional[str] = dataclass_field(default=None, kw_only=True)

The sku size.

family class-attribute instance-attribute

family: Optional[str] = dataclass_field(default=None, kw_only=True)

The sku family.

model class-attribute instance-attribute

model: Optional[str] = dataclass_field(default=None, kw_only=True)

The sku model.

capacity class-attribute instance-attribute

capacity: Optional[int] = dataclass_field(default=None, kw_only=True)

The sku capacity.

Identity dataclass

Identity(*, principal_id: Optional[str] = None, tenant_id: Optional[str] = None, type_: Optional[str] = None)

Definition: Identity

Attributes

principal_id class-attribute instance-attribute

principal_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'principalId'})

The principal id of resource identity.

tenant_id class-attribute instance-attribute

tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'tenantId'})

The tenant id of resource.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

The identity type.

ResourceGroupProperties dataclass

ResourceGroupProperties(*, provisioning_state: Optional[str] = None)

Definition: ResourceGroupProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The provisioning state.

ExportTemplateRequest dataclass

ExportTemplateRequest(*, resources: Optional[List[str]] = None, options: Optional[str] = None)

Definition: ExportTemplateRequest

Attributes

resources class-attribute instance-attribute

resources: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources.

options class-attribute instance-attribute

options: Optional[str] = dataclass_field(default=None, kw_only=True)

The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments

TagCount dataclass

TagCount(*, type_: Optional[str] = None, value: Optional[int] = None)

Definition: TagCount

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'type'})

Type of count.

value class-attribute instance-attribute

value: Optional[int] = dataclass_field(default=None, kw_only=True)

Value of count.

TargetResource dataclass

TargetResource(*, id: Optional[str] = None, resource_name: Optional[str] = None, resource_type: Optional[str] = None)

Definition: TargetResource

Attributes

id class-attribute instance-attribute

id: Optional[str] = dataclass_field(default=None, kw_only=True)

The ID of the resource.

resource_name class-attribute instance-attribute

resource_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceName'})

The name of the resource.

resource_type class-attribute instance-attribute

resource_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceType'})

The type of the resource.

HttpMessage dataclass

HttpMessage(*, content: Optional[Dict[str, Any]] = None)

Definition: HttpMessage

Attributes

content class-attribute instance-attribute

content: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

HTTP message content.

DeploymentOperationProperties dataclass

DeploymentOperationProperties(*, provisioning_state: Optional[str] = None, timestamp: Optional[str] = None, service_request_id: Optional[str] = None, status_code: Optional[str] = None, status_message: Optional[Dict[str, Any]] = None, target_resource: Optional[TargetResource | Mapping[str, Any]] = None, request: Optional[HttpMessage | Mapping[str, Any]] = None, response: Optional[HttpMessage | Mapping[str, Any]] = None)

Definition: DeploymentOperationProperties

Attributes

provisioning_state class-attribute instance-attribute

provisioning_state: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'provisioningState'})

The state of the provisioning.

timestamp class-attribute instance-attribute

timestamp: Optional[str] = dataclass_field(default=None, kw_only=True)

The date and time of the operation.

service_request_id class-attribute instance-attribute

service_request_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'serviceRequestId'})

Deployment operation service request id.

status_code class-attribute instance-attribute

status_code: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'statusCode'})

Operation status code.

status_message class-attribute instance-attribute

status_message: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'statusMessage'})

Operation status message.

ObjectWithoutType dataclass

ObjectWithoutType(*, additional_properties: Dict[str, Any] = dict())

Definition: ObjectWithoutType

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = dataclass_field(default_factory=dict, kw_only=True)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ArmClient

ArmClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for arm connector.

Initialize a ArmClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

list_subscriptions_list_locations

list_subscriptions_list_locations(subscription_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Lists the subscription locations

Lists the locations available for the subscription.

Returns a single-page Azure Core async collection.

Swagger operation ID: Subscriptions_ListLocations.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

subscriptions_get async

subscriptions_get(subscription_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a subscription

Reads the details for a particular subscription.

Swagger operation ID: Subscriptions_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_subscriptions

list_subscriptions(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List subscriptions

Gets a list of all the subscriptions to which the principal has access.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Subscriptions_List.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_get async

deployments_get(subscription_id: str, resource_group_name: str, deployment_name: str, *, wait: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a template deployment

Reads a template deployment within a resource group.

Swagger operation ID: Deployments_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
wait	Optional[bool]	If the action should wait until deployment is completed.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_create_or_update async

deployments_create_or_update(input: Deployment | Mapping[str, Any], subscription_id: str, resource_group_name: str, deployment_name: str, *, wait: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a template deployment

Create or update a named resource group template deployment. A template and parameters are expected for the request to succeed.

Swagger operation ID: Deployments_CreateOrUpdate.

Parameters:

Name	Type	Description	Default
input	Deployment | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the deployment.	required
wait	Optional[bool]	If the action should wait until deployment is completed.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_delete async

deployments_delete(subscription_id: str, resource_group_name: str, deployment_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete template deployment

Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment.

Swagger operation ID: Deployments_Delete.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_cancel async

deployments_cancel(subscription_id: str, resource_group_name: str, deployment_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Cancel a template deployment

Cancel a currently running template deployment. All pending template operations will be suspended.

Swagger operation ID: Deployments_Cancel.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_validate async

deployments_validate(input: Deployment | Mapping[str, Any], subscription_id: str, resource_group_name: str, deployment_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Validate a template deployment

Validates a deployment template. This operation does not have side effects and can be used to test a template deployment for syntax or logical errors.

Swagger operation ID: Deployments_Validate.

Parameters:

Name	Type	Description	Default
input	Deployment | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployments_export_template async

deployments_export_template(subscription_id: str, resource_group_name: str, deployment_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Export deployment template

Exports a template from a past resource group deployment.

Swagger operation ID: Deployments_ExportTemplate.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_deployments

list_deployments(subscription_id: str, resource_group_name: str, *, filter: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List template deployments

Lists all the resource group template deployments. This operation is useful to know what has been provisioned thus far.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Deployments_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
filter	Optional[str]	The filter to apply on the operation.	None
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

deployment_operations_get async

deployment_operations_get(subscription_id: str, resource_group_name: str, deployment_name: str, operation_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a template deployment operation

Reads a particular resource group template deployment operation. This is useful for troubleshooting failed template deployments.

Swagger operation ID: DeploymentOperations_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
operation_id	str	Operation Id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_deployment_operations

list_deployment_operations(subscription_id: str, resource_group_name: str, deployment_name: str, *, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Lists template deployment operations

Lists all the template deployment operations. This is useful for troubleshooting failed template deployments.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: DeploymentOperations_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
deployment_name	str	The name of the resource group template deployment.	required
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

providers_unregister async

providers_unregister(subscription_id: str, resource_provider_namespace: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Unregister resource provider

Unregisters provider from a subscription. This operation will fail if there are any resources from that resource provider in the subscription.

Swagger operation ID: Providers_Unregister.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

providers_register async

providers_register(subscription_id: str, resource_provider_namespace: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Register resource provider

Registers a resource provider to be used with a subscription. This will provision permissions for the service into your subscription.

Swagger operation ID: Providers_Register.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_providers

list_providers(subscription_id: str, *, top: Optional[int] = None, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List resource providers

Lists the resource providers available for the subscription.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Providers_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
expand	Optional[str]	The $expand query parameter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

providers_get async

providers_get(subscription_id: str, resource_provider_namespace: str, *, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read resource provider

Reads a particular resource provider within the subscription.

Swagger operation ID: Providers_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
expand	Optional[str]	The $expand query parameter.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resource_groups_list_resources

list_resource_groups_list_resources(subscription_id: str, resource_group_name: str, *, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List resources by resource group

Lists all the resources under a resource group.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ResourceGroups_ListResources.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
filter	Optional[str]	The filter to apply on the operation.	None
expand	Optional[str]	The $expand query parameter.	None
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resource_groups_get async

resource_groups_get(subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a resource group

Reads a particular resource group within the subscription.

Swagger operation ID: ResourceGroups_Get.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resource_groups_create_or_update async

resource_groups_create_or_update(input: ResourceGroup | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a resource group

Creates or updates a resource group. The response code can be used to distinguish between a create (201) or update (200).

Swagger operation ID: ResourceGroups_CreateOrUpdate.

Parameters:

Name	Type	Description	Default
input	ResourceGroup | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	The name of the resource group to be created or updated.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resource_groups_delete async

resource_groups_delete(subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a resource group

Delete a particular resource group within the subscription.

Swagger operation ID: ResourceGroups_Delete.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resource_groups_patch async

resource_groups_patch(input: ResourceGroup | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Update an existing resource group

Updates an existing resource group. If the resource does not exist, this request will fail.

Swagger operation ID: ResourceGroups_Patch.

Parameters:

Name	Type	Description	Default
input	ResourceGroup | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resource_groups_export_template async

resource_groups_export_template(input: ExportTemplateRequest | Mapping[str, Any], subscription_id: str, resource_group_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Export a resource group template

Exports a deployment template from an existing resource group. This can only be successful if the underlying resources have a schema defined by Microsoft.

Swagger operation ID: ResourceGroups_ExportTemplate.

Parameters:

Name	Type	Description	Default
input	ExportTemplateRequest | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resource_groups

list_resource_groups(subscription_id: str, *, filter: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List resource groups

Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: ResourceGroups_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
filter	Optional[str]	The filter to apply on the operation.	None
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_resources

list_resources(subscription_id: str, *, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List resources by subscription

Reads all of the resources under a particular subscription. The results are paginated at 1,000+ records.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Resources_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
filter	Optional[str]	The filter to apply on the operation.	None
expand	Optional[str]	The $expand query parameter.	None
top	Optional[int]	Query parameters. If nothing is passed returns all values.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resources_get_by_id async

resources_get_by_id(subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a resource

Reads a resource object.

Swagger operation ID: Resources_GetById.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resources_create_or_update_by_id async

resources_create_or_update_by_id(input: GenericResource | Mapping[str, Any], subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a resource

Creates or updates a resource. The response code can be used to distinguish between a create (201) or update (200).

Swagger operation ID: Resources_CreateOrUpdateById.

Parameters:

Name	Type	Description	Default
input	GenericResource | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resources_delete_by_id async

resources_delete_by_id(subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a resource

Deletes a resource.

Swagger operation ID: Resources_DeleteById.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

resources_invoke async

resources_invoke(input: ResourcesInvokeInput | Mapping[str, Any], subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, action_name: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Invoke resource operation

Invokes an operation on an Azure resource.

Swagger operation ID: Resources_Invoke.

Parameters:

Name	Type	Description	Default
input	ResourcesInvokeInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_group_name	str	Resource group name.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
action_name	str	Name of the resource action to invoke.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

provider_resources_get_by_id async

provider_resources_get_by_id(subscription_id: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Read a resource in provider

Reads a resource object.

Swagger operation ID: Provider_Resources_GetById.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

provider_resources_invoke async

provider_resources_invoke(input: ProviderResourcesInvokeInput | Mapping[str, Any], subscription_id: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Invoke resource operation in provider

Invokes an operation on an Azure resource.

Swagger operation ID: Provider_Resources_Invoke.

Parameters:

Name	Type	Description	Default
input	ProviderResourcesInvokeInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
resource_provider_namespace	str	Namespace of the resource provider.	required
short_resource_id	str	The short Id of the resource, including the resource name and resource type. For example, sites/mySite.	required
x_ms_api_version	str	Api Version to be used.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

tags_create_or_update_value async

tags_create_or_update_value(subscription_id: str, tag_name: str, tag_value: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a subscription resource tag value

Create or update a subscription resource tag value.

Swagger operation ID: Tags_CreateOrUpdateValue.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
tag_name	str	The name of the tag.	required
tag_value	str	The value of the tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

tags_delete_value async

tags_delete_value(subscription_id: str, tag_name: str, tag_value: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a subscription resource tag value

Delete a subscription resource tag value.

Swagger operation ID: Tags_DeleteValue.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
tag_name	str	The name of the tag.	required
tag_value	str	The value of the tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

tags_create_or_update async

tags_create_or_update(subscription_id: str, tag_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create or update a subscription resource tag name

Create or update a subscription resource tag name.

Swagger operation ID: Tags_CreateOrUpdate.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
tag_name	str	The name of the tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

tags_delete async

tags_delete(subscription_id: str, tag_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete a subscription resource tag name

Delete a subscription resource tag name.

Swagger operation ID: Tags_Delete.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
tag_name	str	The name of the tag.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_tags

list_tags(subscription_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List subscription resource tags

Lists all the subscription resource tags.

Returns an Azure Core async pager that follows the connector continuation URL.

Swagger operation ID: Tags_List.

Parameters:

Name	Type	Description	Default
subscription_id	str	The unique identifier for the Microsoft Azure subscription. The subscription ID forms part of the ID for every Azure resource.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.