ArmClient
Classes
dataclass
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] = None, authorization_source: Optional[str] = None)
Response for Read a subscription
Attributes
class-attribute
instance-attribute
The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.
class-attribute
instance-attribute
The subscription Id.
class-attribute
instance-attribute
The tenant Id.
class-attribute
instance-attribute
The subscription display name.
class-attribute
instance-attribute
authorization_source: Optional[str] = field(default=None, 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'.
dataclass
Response for List subscriptions
dataclass
dataclass
DeploymentValidateResult(error: Optional[ResourceManagementErrorWithDetails] = None, properties: Optional[DeploymentPropertiesExtended] = None)
Response for Validate a template deployment
dataclass
dataclass
DeploymentListResult(value: Optional[List[DeploymentExtended]] = None, next_link: Optional[str] = None)
Response for List template deployments
dataclass
DeploymentOperation(id: Optional[str] = None, operation_id: Optional[str] = None, properties: Optional[DeploymentOperationProperties] = None)
Response for Read a template deployment operation
dataclass
DeploymentOperationsListResult(value: Optional[List[DeploymentOperation]] = None, next_link: Optional[str] = None)
Response for Lists template deployment operations
dataclass
Provider(id: Optional[str] = None, namespace: Optional[str] = None, registration_state: Optional[str] = None, resource_types: Optional[List[ProviderResourceType]] = None)
Response for Unregister resource provider
dataclass
Response for List resource providers
dataclass
Response for List resources by resource group
dataclass
ResourceGroup(id: Optional[str] = None, name: Optional[str] = None, location: Optional[str] = None, managed_by: Optional[str] = None, tags: Optional[Dict[str, Any]] = None, properties: Optional[ResourceGroupProperties] = None)
Response for Read a resource group
Attributes
class-attribute
instance-attribute
The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Id of the resource that manages this resource group.
dataclass
dataclass
ResourceGroupListResult(value: Optional[List[ResourceGroup]] = None, next_link: Optional[str] = None)
Response for List resource groups
dataclass
GenericResource(id: Optional[str] = None, name: Optional[str] = None, type_: Optional[str] = None, location: Optional[str] = None, tags: Optional[Dict[str, Any]] = None, plan: Optional[Plan] = None, kind: Optional[str] = None, managed_by: Optional[str] = None, sku: Optional[Sku] = None, identity: Optional[Identity] = None, properties: Optional[Dict[str, Any]] = None)
Response for Read a resource
Attributes
class-attribute
instance-attribute
Resource type
class-attribute
instance-attribute
Id of the resource that manages this resource.
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
TagDetails(id: Optional[str] = None, tag_name: Optional[str] = None, count: Optional[TagCount] = None, values: Optional[List[TagValue]] = None)
Response for Create or update a subscription resource tag name
Attributes
class-attribute
instance-attribute
The tag name.
dataclass
Response for List subscription resource tags
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
class-attribute
instance-attribute
The fully qualified Id of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.
class-attribute
instance-attribute
The subscription Id.
class-attribute
instance-attribute
The display name of the location.
class-attribute
instance-attribute
The latitude of the location.
dataclass
SubscriptionPolicies(location_placement_id: Optional[str] = None, quota_id: Optional[str] = None, spending_limit: Optional[str] = None)
Definition: SubscriptionPolicies
Attributes
class-attribute
instance-attribute
location_placement_id: Optional[str] = field(default=None, 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.
class-attribute
instance-attribute
The subscription quota Id.
dataclass
Definition: TemplateLink
Attributes
dataclass
Definition: ParametersLink
Attributes
dataclass
DeploymentProperties(template: Optional[Dict[str, Any]] = None, template_link: Optional[TemplateLink] = None, parameters: Optional[Dict[str, Any]] = None, parameters_link: Optional[ParametersLink] = None, mode: Optional[str] = None, debug_setting: Optional[DebugSetting] = None)
Definition: DeploymentProperties
Attributes
class-attribute
instance-attribute
The template content. It can be a JObject or a well formed JSON string. Use only one of Template or TemplateLink.
class-attribute
instance-attribute
Deployment parameters. It can be a JObject or a well formed JSON string. Use only one of Parameters or ParametersLink.
dataclass
dataclass
Definition: Deployment
dataclass
ResourceManagementErrorWithDetails(code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[Dict[str, Any]]] = None)
Definition: ResourceManagementErrorWithDetails
Attributes
class-attribute
instance-attribute
The error code returned from the server.
class-attribute
instance-attribute
The error message returned from the server.
dataclass
dataclass
dataclass
ProviderResourceType(resource_type: Optional[str] = None, locations: Optional[List[ObjectWithoutType]] = None, aliases: Optional[List[AliasType]] = None, api_versions: Optional[List[str]] = None, properties: Optional[Dict[str, Any]] = None)
Definition: ProviderResourceType
Attributes
class-attribute
instance-attribute
The resource type.
class-attribute
instance-attribute
The collection of locations where this resource type can be created in.
class-attribute
instance-attribute
The aliases that are supported by this resource type.
class-attribute
instance-attribute
The api version.
dataclass
BasicDependency(id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None)
Definition: BasicDependency
Attributes
class-attribute
instance-attribute
The dependency resource type.
dataclass
Dependency(depends_on: Optional[List[BasicDependency]] = None, id: Optional[str] = None, resource_type: Optional[str] = None, resource_name: Optional[str] = None)
dataclass
DeploymentPropertiesExtended(provisioning_state: Optional[str] = None, correlation_id: Optional[str] = None, timestamp: Optional[str] = None, outputs: Optional[Dict[str, Any]] = None, providers: Optional[List[Provider]] = None, dependencies: Optional[List[Dependency]] = None, template: Optional[Dict[str, Any]] = None, template_link: Optional[TemplateLink] = None, parameters: Optional[Dict[str, Any]] = None, parameters_link: Optional[ParametersLink] = None, mode: Optional[str] = None, debug_setting: Optional[DebugSetting] = None)
Definition: DeploymentPropertiesExtended
Attributes
class-attribute
instance-attribute
provisioning_state: Optional[str] = field(default=None, metadata={'wire_name': 'provisioningState'})
The state of the provisioning.
class-attribute
instance-attribute
The correlation ID of the deployment.
class-attribute
instance-attribute
The timestamp of the template deployment.
class-attribute
instance-attribute
Key/value pairs that represent deploymentoutput.
class-attribute
instance-attribute
The list of resource providers needed for the deployment.
class-attribute
instance-attribute
The list of deployment dependencies.
class-attribute
instance-attribute
The template content. Use only one of Template or TemplateLink.
class-attribute
instance-attribute
Deployment parameters. Use only one of Parameters or ParametersLink.
dataclass
Plan(name: Optional[str] = None, publisher: Optional[str] = None, product: Optional[str] = None, promotion_code: Optional[str] = None)
Definition: Plan
Attributes
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
dataclass
Identity(principal_id: Optional[str] = None, tenant_id: Optional[str] = None, type_: Optional[str] = None)
Definition: Identity
Attributes
class-attribute
instance-attribute
The principal id of resource identity.
class-attribute
instance-attribute
The tenant id of resource.
dataclass
dataclass
Definition: ExportTemplateRequest
Attributes
class-attribute
instance-attribute
The ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources.
dataclass
dataclass
TargetResource(id: Optional[str] = None, resource_name: Optional[str] = None, resource_type: Optional[str] = None)
Definition: TargetResource
Attributes
class-attribute
instance-attribute
The name of the resource.
dataclass
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] = None, request: Optional[HttpMessage] = None, response: Optional[HttpMessage] = None)
Definition: DeploymentOperationProperties
Attributes
class-attribute
instance-attribute
provisioning_state: Optional[str] = field(default=None, metadata={'wire_name': 'provisioningState'})
The state of the provisioning.
class-attribute
instance-attribute
The date and time of the operation.
class-attribute
instance-attribute
Deployment operation service request id.
class-attribute
instance-attribute
Operation status code.
dataclass
ArmClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)
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 |
token_provider
|
Optional[TokenProvider]
|
Optional token provider. Defaults to ManagedIdentityTokenProvider. |
None
|
options
|
Optional[ConnectorClientOptions]
|
Optional connector client options. |
None
|
Methods:
async
Lists the subscription locations
Lists the locations available for the subscription.
async
Read a subscription
Reads the details for a particular subscription.
async
List subscriptions
Gets a list of all the subscriptions to which the principal has access.
async
deployments_get_async(subscription_id: str, resource_group_name: str, deployment_name: str, wait: Optional[bool] = None) -> dict[str, Any] | None
Read a template deployment
Reads a template deployment within a resource group.
async
deployments_create_or_update_async(input: Deployment, subscription_id: str, resource_group_name: str, deployment_name: str, wait: Optional[bool] = 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.
async
deployments_delete_async(subscription_id: str, resource_group_name: str, deployment_name: str) -> None
Delete template deployment
Deletes a resource group template deployment. The resources will not be deleted; only the metadata about the template deployment.
async
deployments_cancel_async(subscription_id: str, resource_group_name: str, deployment_name: str) -> None
Cancel a template deployment
Cancel a currently running template deployment. All pending template operations will be suspended.
async
deployments_validate_async(input: Deployment, subscription_id: str, resource_group_name: str, deployment_name: str) -> 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.
async
deployments_export_template_async(subscription_id: str, resource_group_name: str, deployment_name: str) -> dict[str, Any] | None
Export deployment template
Exports a template from a past resource group deployment.
async
deployments_list_async(subscription_id: str, resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None
List template deployments
Lists all the resource group template deployments. This operation is useful to know what has been provisioned thus far.
async
deployment_operations_get_async(subscription_id: str, resource_group_name: str, deployment_name: str, operation_id: str) -> 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.
async
deployment_operations_list_async(subscription_id: str, resource_group_name: str, deployment_name: str, top: Optional[int] = None) -> dict[str, Any] | None
Lists template deployment operations
Lists all the template deployment operations. This is useful for troubleshooting failed template deployments.
async
providers_unregister_async(subscription_id: str, resource_provider_namespace: str) -> 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.
async
providers_register_async(subscription_id: str, resource_provider_namespace: str) -> 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.
async
providers_list_async(subscription_id: str, top: Optional[int] = None, expand: Optional[str] = None) -> dict[str, Any] | None
List resource providers
Lists the resource providers available for the subscription.
async
providers_get_async(subscription_id: str, resource_provider_namespace: str, expand: Optional[str] = None) -> dict[str, Any] | None
Read resource provider
Reads a particular resource provider within the subscription.
async
resource_groups_list_resources_async(subscription_id: str, resource_group_name: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None
List resources by resource group
Lists all the resources under a resource group.
async
Read a resource group
Reads a particular resource group within the subscription.
async
resource_groups_create_or_update_async(input: ResourceGroup, subscription_id: str, resource_group_name: str) -> 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).
async
Delete a resource group
Delete a particular resource group within the subscription.
async
resource_groups_patch_async(input: ResourceGroup, subscription_id: str, resource_group_name: str) -> dict[str, Any] | None
Update an existing resource group
Updates an existing resource group. If the resource does not exist, this request will fail.
async
resource_groups_export_template_async(input: ExportTemplateRequest, subscription_id: str, resource_group_name: str) -> 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.
async
resource_groups_list_async(subscription_id: str, filter: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None
List resource groups
Lists all the resource groups within the subscription. The results are paginated at 1,000+ records.
async
resources_list_async(subscription_id: str, filter: Optional[str] = None, expand: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None
List resources by subscription
Reads all of the resources under a particular subscription. The results are paginated at 1,000+ records.
async
resources_get_by_id_async(subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str) -> dict[str, Any] | None
Read a resource
Reads a resource object.
async
resources_create_or_update_by_id_async(input: GenericResource, subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str) -> 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).
async
resources_delete_by_id_async(subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str) -> None
Delete a resource
Deletes a resource.
async
resources_invoke_async(input: ResourcesInvokeInput, subscription_id: str, resource_group_name: str, resource_provider_namespace: str, short_resource_id: str, action_name: str, x_ms_api_version: str) -> dict[str, Any] | None
Invoke resource operation
Invokes an operation on an Azure resource.
async
provider_resources_get_by_id_async(subscription_id: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str) -> dict[str, Any] | None
Read a resource in provider
Reads a resource object.
async
provider_resources_invoke_async(input: ProviderResourcesInvokeInput, subscription_id: str, resource_provider_namespace: str, short_resource_id: str, x_ms_api_version: str) -> dict[str, Any] | None
Invoke resource operation in provider
Invokes an operation on an Azure resource.
async
tags_create_or_update_value_async(subscription_id: str, tag_name: str, tag_value: str) -> dict[str, Any] | None
Create or update a subscription resource tag value
Create or update a subscription resource tag value.
async
Delete a subscription resource tag value
Delete a subscription resource tag value.
async
Create or update a subscription resource tag name
Create or update a subscription resource tag name.
async
Delete a subscription resource tag name
Delete a subscription resource tag name.