azure.mgmt.resource.subscriptions.v2022_12_01.models module

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.AvailabilityZoneMappings(**kwargs: Any)[source]

Bases: Model

Availability zone mappings for the region.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

logical_zone (str) – The logical zone id for the availability zone.
physical_zone (str) – The fully qualified physical zone id of availability zone to which logical zone id is mapped to.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.AvailabilityZonePeers(*, peers: List[_models.Peers] | None = None, **kwargs: Any)[source]

Bases: Model

List of availability zones shared by the subscriptions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

availability_zone (str) – The availabilityZone.
peers (list[Peers]) – Details of shared availability zone.

Keyword Arguments:

peers (list[Peers]) – Details of shared availability zone.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.CheckResourceNameResult(*, name: str | None = None, type: str | None = None, status: str | _models.ResourceNameStatus | None = None, **kwargs: Any)[source]

Bases: Model

Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word.

Variables:

name (str) – Name of Resource.
type (str) – Type of Resource.
status (str or ResourceNameStatus) – Is the resource name Allowed or Reserved. Known values are: “Allowed” and “Reserved”.

Keyword Arguments:

name (str) – Name of Resource.
type (str) – Type of Resource.
status (str or ResourceNameStatus) – Is the resource name Allowed or Reserved. Known values are: “Allowed” and “Reserved”.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.CheckZonePeersRequest(*, location: str | None = None, subscription_ids: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Check zone peers request parameters.

Variables:

location (str) – The Microsoft location.
subscription_ids (list[str]) – The peer Microsoft Azure subscription ID.

Keyword Arguments:

location (str) – The Microsoft location.
subscription_ids (list[str]) – The peer Microsoft Azure subscription ID.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.CheckZonePeersResult(*, location: str | None = None, availability_zone_peers: List[_models.AvailabilityZonePeers] | None = None, **kwargs: Any)[source]

Bases: Model

Result of the Check zone peers operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

subscription_id (str) – The subscription ID.
location (str) – the location of the subscription.
availability_zone_peers (list[AvailabilityZonePeers]) – The Availability Zones shared by the subscriptions.

Keyword Arguments:

location (str) – the location of the subscription.
availability_zone_peers (list[AvailabilityZonePeers]) – The Availability Zones shared by the subscriptions.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ErrorResponse(**kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorResponse]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ErrorResponseAutoGenerated(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.Location(*, metadata: _models.LocationMetadata | None = None, availability_zone_mappings: List[_models.AvailabilityZoneMappings] | None = None, **kwargs: Any)[source]

Bases: Model

Location information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
subscription_id (str) – The subscription ID.
name (str) – The location name.
type (str or LocationType) – The location type. Known values are: “Region” and “EdgeZone”.
display_name (str) – The display name of the location.
regional_display_name (str) – The display name of the location and its region.
metadata (LocationMetadata) – Metadata of the location, such as lat/long, paired region, and others.
availability_zone_mappings (list[AvailabilityZoneMappings]) – The availability zone mappings for this region.

Keyword Arguments:

metadata (LocationMetadata) – Metadata of the location, such as lat/long, paired region, and others.
availability_zone_mappings (list[AvailabilityZoneMappings]) – The availability zone mappings for this region.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.LocationListResult(*, value: List[_models.Location] | None = None, **kwargs: Any)[source]

Bases: Model

Location list operation response.

Variables:: value (list[Location]) – An array of locations.
Keyword Arguments:: value (list[Location]) – An array of locations.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.LocationMetadata(*, paired_region: List[_models.PairedRegion] | None = None, **kwargs: Any)[source]

Bases: Model

Location metadata information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

region_type (str or RegionType) – The type of the region. Known values are: “Physical” and “Logical”.
region_category (str or RegionCategory) – The category of the region. Known values are: “Recommended”, “Extended”, and “Other”.
geography (str) – The geography of the location.
geography_group (str) – The geography group of the location.
longitude (str) – The longitude of the location.
latitude (str) – The latitude of the location.
physical_location (str) – The physical location of the Azure location.
paired_region (list[PairedRegion]) – The regions paired to this region.
home_location (str) – The home location of an edge zone.

Keyword Arguments:

paired_region (list[PairedRegion]) – The regions paired to this region.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.LocationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The location type.

EDGE_ZONE = 'EdgeZone'

REGION = 'Region'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ManagedByTenant(**kwargs: Any)[source]

Bases: Model

Information about a tenant managing the subscription.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:: tenant_id (str) – The tenant ID of the managing tenant. This is a GUID.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments:

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.OperationAutoGenerated(*, name: str | None = None, display: _models.OperationDisplayAutoGenerated | None = None, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplayAutoGenerated) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayAutoGenerated) – Localized display information for this particular operation.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

Localized display information for this particular operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.OperationDisplayAutoGenerated(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Localized display information for this particular operation.

Variables:

provider (str) – Service provider: Microsoft.Resources.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of the operation.

Keyword Arguments:

provider (str) – Service provider: Microsoft.Resources.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Description of the operation.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.OperationListResult(**kwargs: Any)[source]

Bases: Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.resource.subscriptions.v2022_12_01.models.OperationListResultAutoGenerated(*, value: List[_models.OperationAutoGenerated] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables:

value (list[OperationAutoGenerated]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

Keyword Arguments:

value (list[OperationAutoGenerated]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.resource.subscriptions.v2022_12_01.models.Origin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'

USER = 'user'

USER_SYSTEM = 'user,system'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.PairedRegion(**kwargs: Any)[source]

Bases: Model

Information regarding paired region.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

name (str) – The name of the paired region.
id (str) – The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
subscription_id (str) – The subscription ID.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.Peers(**kwargs: Any)[source]

Bases: Model

Information about shared availability zone.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

subscription_id (str) – The subscription ID.
availability_zone (str) – The availabilityZone.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.RegionCategory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The category of the region.

EXTENDED = 'Extended'

OTHER = 'Other'

RECOMMENDED = 'Recommended'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.RegionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of the region.

LOGICAL = 'Logical'

PHYSICAL = 'Physical'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ResourceName(*, name: str, type: str, **kwargs: Any)[source]

Bases: Model

Name and Type of the Resource.

All required parameters must be populated in order to send to server.

Variables:

name (str) – Name of the resource. Required.
type (str) – The type of the resource. Required.

Keyword Arguments:

name (str) – Name of the resource. Required.
type (str) – The type of the resource. Required.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.ResourceNameStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Is the resource name Allowed or Reserved.

ALLOWED = 'Allowed'

RESERVED = 'Reserved'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.SpendingLimit(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The subscription spending limit.

CURRENT_PERIOD_OFF = 'CurrentPeriodOff'

OFF = 'Off'

ON = 'On'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.Subscription(*, subscription_policies: _models.SubscriptionPolicies | None = None, authorization_source: str | None = None, managed_by_tenants: List[_models.ManagedByTenant] | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Subscription information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The fully qualified ID for the subscription. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74.
subscription_id (str) – The subscription ID.
display_name (str) – The subscription display name.
tenant_id (str) – The subscription tenant ID.
state (str or SubscriptionState) – The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. Known values are: “Enabled”, “Warned”, “PastDue”, “Disabled”, and “Deleted”.
subscription_policies (SubscriptionPolicies) – The subscription policies.
authorization_source (str) – The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, ‘Legacy, RoleBased’.
managed_by_tenants (list[ManagedByTenant]) – An array containing the tenants managing the subscription.
tags (dict[str, str]) – The tags attached to the subscription.

Keyword Arguments:

subscription_policies (SubscriptionPolicies) – The subscription policies.
authorization_source (str) – The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, ‘Legacy, RoleBased’.
managed_by_tenants (list[ManagedByTenant]) – An array containing the tenants managing the subscription.
tags (dict[str, str]) – The tags attached to the subscription.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.SubscriptionListResult(*, next_link: str, value: List[_models.Subscription] | None = None, **kwargs: Any)[source]

Bases: Model

Subscription list operation response.

All required parameters must be populated in order to send to server.

Variables:

value (list[Subscription]) – An array of subscriptions.
next_link (str) – The URL to get the next set of results. Required.

Keyword Arguments:

value (list[Subscription]) – An array of subscriptions.
next_link (str) – The URL to get the next set of results. Required.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.SubscriptionPolicies(**kwargs: Any)[source]

Bases: Model

Subscription policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

location_placement_id (str) – 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 (str) – The subscription quota ID.
spending_limit (str or SpendingLimit) – The subscription spending limit. Known values are: “On”, “Off”, and “CurrentPeriodOff”.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.SubscriptionState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

DELETED = 'Deleted'

DISABLED = 'Disabled'

ENABLED = 'Enabled'

PAST_DUE = 'PastDue'

WARNED = 'Warned'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.TenantCategory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Category of the tenant.

HOME = 'Home'

MANAGED_BY = 'ManagedBy'

PROJECTED_BY = 'ProjectedBy'

class azure.mgmt.resource.subscriptions.v2022_12_01.models.TenantIdDescription(**kwargs: Any)[source]

Bases: Model

Tenant Id information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

id (str) – The fully qualified ID of the tenant. For example, /tenants/8d65815f-a5b6-402f-9298-045155da7d74.
tenant_id (str) – The tenant ID. For example, 8d65815f-a5b6-402f-9298-045155da7d74.
tenant_category (str or TenantCategory) – Category of the tenant. Known values are: “Home”, “ProjectedBy”, and “ManagedBy”.
country (str) – Country/region name of the address for the tenant.
country_code (str) – Country/region abbreviation for the tenant.
display_name (str) – The display name of the tenant.
domains (list[str]) – The list of domains for the tenant.
default_domain (str) – The default domain for the tenant.
tenant_type (str) – The tenant type. Only available for ‘Home’ tenant category.
tenant_branding_logo_url (str) – The tenant’s branding logo URL. Only available for ‘Home’ tenant category.

class azure.mgmt.resource.subscriptions.v2022_12_01.models.TenantListResult(*, next_link: str, value: List[_models.TenantIdDescription] | None = None, **kwargs: Any)[source]

Bases: Model

Tenant Ids information.

All required parameters must be populated in order to send to server.

Variables:

value (list[TenantIdDescription]) – An array of tenants.
next_link (str) – The URL to use for getting the next set of results. Required.

Keyword Arguments:

value (list[TenantIdDescription]) – An array of tenants.
next_link (str) – The URL to use for getting the next set of results. Required.