azure.mgmt.subscription.models module¶

class azure.mgmt.subscription.models.AcceptOwnership(value)[source]¶

Bases: str, enum.Enum

The accept ownership state of the resource.

COMPLETED = 'Completed'¶

EXPIRED = 'Expired'¶

PENDING = 'Pending'¶

class azure.mgmt.subscription.models.AcceptOwnershipRequest(*, properties: Optional[_models.AcceptOwnershipRequestProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The parameters required to accept subscription ownership.

Variables: properties (AcceptOwnershipRequestProperties) – Accept subscription ownership request properties.
Keyword Arguments: properties (AcceptOwnershipRequestProperties) – Accept subscription ownership request properties.

class azure.mgmt.subscription.models.AcceptOwnershipRequestProperties(*, display_name: str, management_group_id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Accept subscription ownership request properties.

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

Variables

display_name (str) – The friendly name of the subscription. Required.
management_group_id (str) – Management group Id for the subscription.
tags (dict[str, str]) – Tags for the subscription.

Keyword Arguments

display_name (str) – The friendly name of the subscription. Required.
management_group_id (str) – Management group Id for the subscription.
tags (dict[str, str]) – Tags for the subscription.

class azure.mgmt.subscription.models.AcceptOwnershipStatusResponse(*, subscription_tenant_id: Optional[str] = None, display_name: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Subscription Accept Ownership Response.

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

Variables

subscription_id (str) – Newly created subscription Id.
accept_ownership_state (str or AcceptOwnership) – The accept ownership state of the resource. Known values are: “Pending”, “Completed”, and “Expired”.
provisioning_state (str or Provisioning) – The provisioning state of the resource. Known values are: “Pending”, “Accepted”, and “Succeeded”.
billing_owner (str) – UPN of the billing owner.
subscription_tenant_id (str) – Tenant Id of the subscription.
display_name (str) – The display name of the subscription.
tags (dict[str, str]) – Tags for the subscription.

Keyword Arguments

subscription_tenant_id (str) – Tenant Id of the subscription.
display_name (str) – The display name of the subscription.
tags (dict[str, str]) – Tags for the subscription.

class azure.mgmt.subscription.models.BillingAccountPoliciesResponse(*, properties: Optional[_models.BillingAccountPoliciesResponseProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Billing account policies information.

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

Variables

id (str) – Fully qualified ID for the policy.
name (str) – Policy name.
type (str) – Resource type.
properties (BillingAccountPoliciesResponseProperties) – Billing account policies response properties.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

properties (BillingAccountPoliciesResponseProperties) – Billing account policies response properties.

class azure.mgmt.subscription.models.BillingAccountPoliciesResponseProperties(*, service_tenants: Optional[List[_models.ServiceTenantResponse]] = None, allow_transfers: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Put billing account policies response properties.

Variables

service_tenants (list[ServiceTenantResponse]) – Service tenant for the billing account.
allow_transfers (bool) – Determine if the transfers are allowed for the billing account.

Keyword Arguments

service_tenants (list[ServiceTenantResponse]) – Service tenant for the billing account.
allow_transfers (bool) – Determine if the transfers are allowed for the billing account.

class azure.mgmt.subscription.models.CanceledSubscriptionId(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The ID of the canceled subscription.

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

Variables: subscription_id (str) – The ID of the canceled subscription.

class azure.mgmt.subscription.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.subscription.models.EnabledSubscriptionId(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The ID of the subscriptions that is being enabled.

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

Variables: subscription_id (str) – The ID of the subscriptions that is being enabled.

class azure.mgmt.subscription.models.ErrorResponse(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Describes the format of Error response.

Variables

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

Keyword Arguments

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

class azure.mgmt.subscription.models.ErrorResponseBody(*, error: Optional[_models.ErrorResponse] = None, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Variables

error (ErrorResponse) – The details of the error.
code (str) – Error code.
message (str) – Error message indicating why the operation failed.

Keyword Arguments

error (ErrorResponse) – The details of the error.
code (str) – Error code.
message (str) – Error message indicating why the operation failed.

class azure.mgmt.subscription.models.GetTenantPolicyListResponse(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Tenant policy information list.

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

Variables

value (list[GetTenantPolicyResponse]) – The list of tenant policies.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.subscription.models.GetTenantPolicyResponse(*, properties: Optional[_models.TenantPolicy] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Tenant policy Information.

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

Variables

id (str) – Policy Id.
name (str) – Policy name.
type (str) – Resource type.
properties (TenantPolicy) – Tenant policy properties.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

properties (TenantPolicy) – Tenant policy properties.

class azure.mgmt.subscription.models.Location(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.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/00000000-0000-0000-0000-000000000000/locations/westus.
subscription_id (str) – The subscription ID.
name (str) – The location name.
display_name (str) – The display name of the location.
latitude (str) – The latitude of the location.
longitude (str) – The longitude of the location.

class azure.mgmt.subscription.models.LocationListResult(*, value: Optional[List[_models.Location]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.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.subscription.models.Operation(*, name: Optional[str] = None, is_data_action: Optional[bool] = None, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

REST API operation.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Indicates whether the operation is a data action.
display (OperationDisplay) – The object that represents the operation.

Keyword Arguments

name (str) – Operation name: {provider}/{resource}/{operation}.
is_data_action (bool) – Indicates whether the operation is a data action.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.subscription.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The object that represents the operation.

Variables

provider (str) – Service provider: Microsoft.Subscription.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Localized friendly description for the operation.

Keyword Arguments

provider (str) – Service provider: Microsoft.Subscription.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.
description (str) – Localized friendly description for the operation.

class azure.mgmt.subscription.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Result of the request to list operations. It contains a list of operations and a URL link to get the next set of results.

Variables

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

Keyword Arguments

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

class azure.mgmt.subscription.models.Provisioning(value)[source]¶

Bases: str, enum.Enum

The provisioning state of the resource.

ACCEPTED = 'Accepted'¶

PENDING = 'Pending'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.subscription.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

The provisioning state of the resource.

ACCEPTED = 'Accepted'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.subscription.models.PutAliasRequest(*, properties: Optional[_models.PutAliasRequestProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The parameters required to create a new subscription.

Variables: properties (PutAliasRequestProperties) – Put alias request properties.
Keyword Arguments: properties (PutAliasRequestProperties) – Put alias request properties.

class azure.mgmt.subscription.models.PutAliasRequestAdditionalProperties(*, management_group_id: Optional[str] = None, subscription_tenant_id: Optional[str] = None, subscription_owner_id: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Put subscription additional properties.

Variables

management_group_id (str) – Management group Id for the subscription.
subscription_tenant_id (str) – Tenant Id of the subscription.
subscription_owner_id (str) – Owner Id of the subscription.
tags (dict[str, str]) – Tags for the subscription.

Keyword Arguments

management_group_id (str) – Management group Id for the subscription.
subscription_tenant_id (str) – Tenant Id of the subscription.
subscription_owner_id (str) – Owner Id of the subscription.
tags (dict[str, str]) – Tags for the subscription.

class azure.mgmt.subscription.models.PutAliasRequestProperties(*, display_name: Optional[str] = None, workload: Optional[Union[str, _models.Workload]] = None, billing_scope: Optional[str] = None, subscription_id: Optional[str] = None, reseller_id: Optional[str] = None, additional_properties: Optional[_models.PutAliasRequestAdditionalProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Put subscription properties.

Variables

display_name (str) – The friendly name of the subscription.
workload (str or Workload) – The workload type of the subscription. It can be either Production or DevTest. Known values are: “Production” and “DevTest”.
billing_scope (str) – Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}.
subscription_id (str) – This parameter can be used to create alias for existing subscription Id.
reseller_id (str) – Reseller Id.
additional_properties (PutAliasRequestAdditionalProperties) – Put alias request additional properties.

Keyword Arguments

display_name (str) – The friendly name of the subscription.
workload (str or Workload) – The workload type of the subscription. It can be either Production or DevTest. Known values are: “Production” and “DevTest”.
billing_scope (str) – Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}.
subscription_id (str) – This parameter can be used to create alias for existing subscription Id.
reseller_id (str) – Reseller Id.
additional_properties (PutAliasRequestAdditionalProperties) – Put alias request additional properties.

class azure.mgmt.subscription.models.PutTenantPolicyRequestProperties(*, block_subscriptions_leaving_tenant: Optional[bool] = None, block_subscriptions_into_tenant: Optional[bool] = None, exempted_principals: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Put tenant policy request properties.

Variables

block_subscriptions_leaving_tenant (bool) – Blocks the leaving of subscriptions from user’s tenant.
block_subscriptions_into_tenant (bool) – Blocks the entering of subscriptions into user’s tenant.
exempted_principals (list[str]) – List of user objectIds that are exempted from the set subscription tenant policies for the user’s tenant.

Keyword Arguments

block_subscriptions_leaving_tenant (bool) – Blocks the leaving of subscriptions from user’s tenant.
block_subscriptions_into_tenant (bool) – Blocks the entering of subscriptions into user’s tenant.
exempted_principals (list[str]) – List of user objectIds that are exempted from the set subscription tenant policies for the user’s tenant.

class azure.mgmt.subscription.models.RenamedSubscriptionId(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The ID of the subscriptions that is being renamed.

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

Variables: subscription_id (str) – The ID of the subscriptions that is being renamed.

class azure.mgmt.subscription.models.ServiceTenantResponse(*, tenant_id: Optional[str] = None, tenant_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Billing account service tenant.

Variables

tenant_id (str) – Service tenant id.
tenant_name (str) – Service tenant name.

Keyword Arguments

tenant_id (str) – Service tenant id.
tenant_name (str) – Service tenant name.

class azure.mgmt.subscription.models.SpendingLimit(value)[source]¶

Bases: str, enum.Enum

The subscription spending limit.

CURRENT_PERIOD_OFF = 'CurrentPeriodOff'¶

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.subscription.models.Subscription(*, tags: Optional[Dict[str, str]] = None, subscription_policies: Optional[_models.SubscriptionPolicies] = None, authorization_source: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.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/00000000-0000-0000-0000-000000000000.
subscription_id (str) – The subscription ID.
display_name (str) – The subscription display name.
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”.
tenant_id (str) – The tenant ID. For example, 00000000-0000-0000-0000-000000000000.
tags (dict[str, str]) – Tags for the subscription.
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’.

Keyword Arguments

tags (dict[str, str]) – Tags for the subscription.
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’.

class azure.mgmt.subscription.models.SubscriptionAliasListResult(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The list of aliases.

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

Variables

value (list[SubscriptionAliasResponse]) – The list of alias.
next_link (str) – The link (url) to the next page of results.

class azure.mgmt.subscription.models.SubscriptionAliasResponse(*, properties: Optional[_models.SubscriptionAliasResponseProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Subscription Information with the alias.

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

Variables

id (str) – Fully qualified ID for the alias resource.
name (str) – Alias ID.
type (str) – Resource type, Microsoft.Subscription/aliases.
properties (SubscriptionAliasResponseProperties) – Subscription Alias response properties.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

Keyword Arguments

properties (SubscriptionAliasResponseProperties) – Subscription Alias response properties.

class azure.mgmt.subscription.models.SubscriptionAliasResponseProperties(*, display_name: Optional[str] = None, provisioning_state: Optional[Union[str, _models.ProvisioningState]] = None, billing_scope: Optional[str] = None, workload: Optional[Union[str, _models.Workload]] = None, reseller_id: Optional[str] = None, subscription_owner_id: Optional[str] = None, management_group_id: Optional[str] = None, created_time: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Put subscription creation result properties.

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

Variables

subscription_id (str) – Newly created subscription Id.
display_name (str) – The display name of the subscription.
provisioning_state (str or ProvisioningState) – The provisioning state of the resource. Known values are: “Accepted”, “Succeeded”, and “Failed”.
accept_ownership_url (str) – Url to accept ownership of the subscription.
accept_ownership_state (str or AcceptOwnership) – The accept ownership state of the resource. Known values are: “Pending”, “Completed”, and “Expired”.
billing_scope (str) – Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}.
workload (str or Workload) – The workload type of the subscription. It can be either Production or DevTest. Known values are: “Production” and “DevTest”.
reseller_id (str) – Reseller Id.
subscription_owner_id (str) – Owner Id of the subscription.
management_group_id (str) – The Management Group Id.
created_time (str) – Created Time.
tags (dict[str, str]) – Tags for the subscription.

Keyword Arguments

display_name (str) – The display name of the subscription.
provisioning_state (str or ProvisioningState) – The provisioning state of the resource. Known values are: “Accepted”, “Succeeded”, and “Failed”.
billing_scope (str) – Billing scope of the subscription. For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}.
workload (str or Workload) – The workload type of the subscription. It can be either Production or DevTest. Known values are: “Production” and “DevTest”.
reseller_id (str) – Reseller Id.
subscription_owner_id (str) – Owner Id of the subscription.
management_group_id (str) – The Management Group Id.
created_time (str) – Created Time.
tags (dict[str, str]) – Tags for the subscription.

class azure.mgmt.subscription.models.SubscriptionListResult(*, value: Optional[List[_models.Subscription]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Subscription list operation response.

Variables

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

Keyword Arguments

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

class azure.mgmt.subscription.models.SubscriptionName(*, subscription_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

The new name of the subscription.

Variables: subscription_name (str) – New subscription name.
Keyword Arguments: subscription_name (str) – New subscription name.

class azure.mgmt.subscription.models.SubscriptionPolicies(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.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.subscription.models.SubscriptionState(value)[source]¶

Bases: str, enum.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.subscription.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.subscription.models.TenantIdDescription(**kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.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/00000000-0000-0000-0000-000000000000.
tenant_id (str) – The tenant ID. For example, 00000000-0000-0000-0000-000000000000.
tenant_category (str) – The category of the tenant. Possible values are TenantCategoryHome,TenantCategoryProjectedBy,TenantCategoryManagedBy.
country (str) – The country/region name of the address for the tenant.
country_code (str) – The Country/region abbreviation for the tenant.
display_name (str) – The display name of the tenant.
domains (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.

class azure.mgmt.subscription.models.TenantListResult(*, next_link: str, value: Optional[List[_models.TenantIdDescription]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Tenant Ids information.

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

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.

class azure.mgmt.subscription.models.TenantPolicy(*, block_subscriptions_leaving_tenant: Optional[bool] = None, block_subscriptions_into_tenant: Optional[bool] = None, exempted_principals: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.subscription._serialization.Model

Tenant policy.

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

Variables

policy_id (str) – Policy Id.
block_subscriptions_leaving_tenant (bool) – Blocks the leaving of subscriptions from user’s tenant.
block_subscriptions_into_tenant (bool) – Blocks the entering of subscriptions into user’s tenant.
exempted_principals (list[str]) – List of user objectIds that are exempted from the set subscription tenant policies for the user’s tenant.

Keyword Arguments

block_subscriptions_leaving_tenant (bool) – Blocks the leaving of subscriptions from user’s tenant.
block_subscriptions_into_tenant (bool) – Blocks the entering of subscriptions into user’s tenant.
exempted_principals (list[str]) – List of user objectIds that are exempted from the set subscription tenant policies for the user’s tenant.

class azure.mgmt.subscription.models.Workload(value)[source]¶

Bases: str, enum.Enum

The workload type of the subscription. It can be either Production or DevTest.

DEV_TEST = 'DevTest'¶

PRODUCTION = 'Production'¶