Source code for azure.mgmt.storage.v2016_01_01.models._models_py3

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------

from msrest.serialization import Model


[docs]class CheckNameAvailabilityResult(Model): """The CheckNameAvailability operation response. Variables are only populated by the server, and will be ignored when sending a request. :ivar name_available: Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used. :vartype name_available: bool :ivar reason: Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'AccountNameInvalid', 'AlreadyExists' :vartype reason: str or ~azure.mgmt.storage.v2016_01_01.models.Reason :ivar message: Gets an error message explaining the Reason value in more detail. :vartype message: str """ _validation = { 'name_available': {'readonly': True}, 'reason': {'readonly': True}, 'message': {'readonly': True}, } _attribute_map = { 'name_available': {'key': 'nameAvailable', 'type': 'bool'}, 'reason': {'key': 'reason', 'type': 'Reason'}, 'message': {'key': 'message', 'type': 'str'}, } def __init__(self, **kwargs) -> None: super(CheckNameAvailabilityResult, self).__init__(**kwargs) self.name_available = None self.reason = None self.message = None
class CloudError(Model): """CloudError. """ _attribute_map = { }
[docs]class CustomDomain(Model): """The custom domain assigned to this storage account. This can be set via Update. All required parameters must be populated in order to send to Azure. :param name: Required. Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. :type name: str :param use_sub_domain_name: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. :type use_sub_domain_name: bool """ _validation = { 'name': {'required': True}, } _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'use_sub_domain_name': {'key': 'useSubDomainName', 'type': 'bool'}, } def __init__(self, *, name: str, use_sub_domain_name: bool=None, **kwargs) -> None: super(CustomDomain, self).__init__(**kwargs) self.name = name self.use_sub_domain_name = use_sub_domain_name
[docs]class Encryption(Model): """The encryption settings on the storage account. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. :param services: List of services which support encryption. :type services: ~azure.mgmt.storage.v2016_01_01.models.EncryptionServices :ivar key_source: Required. The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage. Default value: "Microsoft.Storage" . :vartype key_source: str """ _validation = { 'key_source': {'required': True, 'constant': True}, } _attribute_map = { 'services': {'key': 'services', 'type': 'EncryptionServices'}, 'key_source': {'key': 'keySource', 'type': 'str'}, } key_source = "Microsoft.Storage" def __init__(self, *, services=None, **kwargs) -> None: super(Encryption, self).__init__(**kwargs) self.services = services
[docs]class EncryptionService(Model): """A service that allows server-side encryption to be used. Variables are only populated by the server, and will be ignored when sending a request. :param enabled: A boolean indicating whether or not the service encrypts the data as it is stored. :type enabled: bool :ivar last_enabled_time: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. :vartype last_enabled_time: datetime """ _validation = { 'last_enabled_time': {'readonly': True}, } _attribute_map = { 'enabled': {'key': 'enabled', 'type': 'bool'}, 'last_enabled_time': {'key': 'lastEnabledTime', 'type': 'iso-8601'}, } def __init__(self, *, enabled: bool=None, **kwargs) -> None: super(EncryptionService, self).__init__(**kwargs) self.enabled = enabled self.last_enabled_time = None
[docs]class EncryptionServices(Model): """A list of services that support encryption. :param blob: The encryption function of the blob storage service. :type blob: ~azure.mgmt.storage.v2016_01_01.models.EncryptionService """ _attribute_map = { 'blob': {'key': 'blob', 'type': 'EncryptionService'}, } def __init__(self, *, blob=None, **kwargs) -> None: super(EncryptionServices, self).__init__(**kwargs) self.blob = blob
[docs]class Endpoints(Model): """The URIs that are used to perform a retrieval of a public blob, queue, or table object. Variables are only populated by the server, and will be ignored when sending a request. :ivar blob: Gets the blob endpoint. :vartype blob: str :ivar queue: Gets the queue endpoint. :vartype queue: str :ivar table: Gets the table endpoint. :vartype table: str :ivar file: Gets the file endpoint. :vartype file: str """ _validation = { 'blob': {'readonly': True}, 'queue': {'readonly': True}, 'table': {'readonly': True}, 'file': {'readonly': True}, } _attribute_map = { 'blob': {'key': 'blob', 'type': 'str'}, 'queue': {'key': 'queue', 'type': 'str'}, 'table': {'key': 'table', 'type': 'str'}, 'file': {'key': 'file', 'type': 'str'}, } def __init__(self, **kwargs) -> None: super(Endpoints, self).__init__(**kwargs) self.blob = None self.queue = None self.table = None self.file = None
[docs]class Resource(Model): """Resource. Variables are only populated by the server, and will be ignored when sending a request. :ivar id: Resource Id :vartype id: str :ivar name: Resource name :vartype name: str :ivar type: Resource type :vartype type: str :param location: Resource location :type location: str :param tags: Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups). :type tags: dict[str, str] """ _validation = { 'id': {'readonly': True}, 'name': {'readonly': True}, 'type': {'readonly': True}, } _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'str'}, 'location': {'key': 'location', 'type': 'str'}, 'tags': {'key': 'tags', 'type': '{str}'}, } def __init__(self, *, location: str=None, tags=None, **kwargs) -> None: super(Resource, self).__init__(**kwargs) self.id = None self.name = None self.type = None self.location = location self.tags = tags
[docs]class Sku(Model): """The SKU of the storage account. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. :param name: Required. Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS' :type name: str or ~azure.mgmt.storage.v2016_01_01.models.SkuName :ivar tier: Gets the sku tier. This is based on the SKU name. Possible values include: 'Standard', 'Premium' :vartype tier: str or ~azure.mgmt.storage.v2016_01_01.models.SkuTier """ _validation = { 'name': {'required': True}, 'tier': {'readonly': True}, } _attribute_map = { 'name': {'key': 'name', 'type': 'SkuName'}, 'tier': {'key': 'tier', 'type': 'SkuTier'}, } def __init__(self, *, name, **kwargs) -> None: super(Sku, self).__init__(**kwargs) self.name = name self.tier = None
[docs]class StorageAccount(Resource): """The storage account. Variables are only populated by the server, and will be ignored when sending a request. :ivar id: Resource Id :vartype id: str :ivar name: Resource name :vartype name: str :ivar type: Resource type :vartype type: str :param location: Resource location :type location: str :param tags: Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups). :type tags: dict[str, str] :ivar sku: Gets the SKU. :vartype sku: ~azure.mgmt.storage.v2016_01_01.models.Sku :ivar kind: Gets the Kind. Possible values include: 'Storage', 'BlobStorage' :vartype kind: str or ~azure.mgmt.storage.v2016_01_01.models.Kind :ivar provisioning_state: Gets the status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded' :vartype provisioning_state: str or ~azure.mgmt.storage.v2016_01_01.models.ProvisioningState :ivar primary_endpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint. :vartype primary_endpoints: ~azure.mgmt.storage.v2016_01_01.models.Endpoints :ivar primary_location: Gets the location of the primary data center for the storage account. :vartype primary_location: str :ivar status_of_primary: Gets the status indicating whether the primary location of the storage account is available or unavailable. Possible values include: 'Available', 'Unavailable' :vartype status_of_primary: str or ~azure.mgmt.storage.v2016_01_01.models.AccountStatus :ivar last_geo_failover_time: Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. :vartype last_geo_failover_time: datetime :ivar secondary_location: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. :vartype secondary_location: str :ivar status_of_secondary: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. Possible values include: 'Available', 'Unavailable' :vartype status_of_secondary: str or ~azure.mgmt.storage.v2016_01_01.models.AccountStatus :ivar creation_time: Gets the creation date and time of the storage account in UTC. :vartype creation_time: datetime :ivar custom_domain: Gets the custom domain the user assigned to this storage account. :vartype custom_domain: ~azure.mgmt.storage.v2016_01_01.models.CustomDomain :ivar secondary_endpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS. :vartype secondary_endpoints: ~azure.mgmt.storage.v2016_01_01.models.Endpoints :ivar encryption: Gets the encryption settings on the account. If unspecified, the account is unencrypted. :vartype encryption: ~azure.mgmt.storage.v2016_01_01.models.Encryption :ivar access_tier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool' :vartype access_tier: str or ~azure.mgmt.storage.v2016_01_01.models.AccessTier """ _validation = { 'id': {'readonly': True}, 'name': {'readonly': True}, 'type': {'readonly': True}, 'sku': {'readonly': True}, 'kind': {'readonly': True}, 'provisioning_state': {'readonly': True}, 'primary_endpoints': {'readonly': True}, 'primary_location': {'readonly': True}, 'status_of_primary': {'readonly': True}, 'last_geo_failover_time': {'readonly': True}, 'secondary_location': {'readonly': True}, 'status_of_secondary': {'readonly': True}, 'creation_time': {'readonly': True}, 'custom_domain': {'readonly': True}, 'secondary_endpoints': {'readonly': True}, 'encryption': {'readonly': True}, 'access_tier': {'readonly': True}, } _attribute_map = { 'id': {'key': 'id', 'type': 'str'}, 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'str'}, 'location': {'key': 'location', 'type': 'str'}, 'tags': {'key': 'tags', 'type': '{str}'}, 'sku': {'key': 'sku', 'type': 'Sku'}, 'kind': {'key': 'kind', 'type': 'Kind'}, 'provisioning_state': {'key': 'properties.provisioningState', 'type': 'ProvisioningState'}, 'primary_endpoints': {'key': 'properties.primaryEndpoints', 'type': 'Endpoints'}, 'primary_location': {'key': 'properties.primaryLocation', 'type': 'str'}, 'status_of_primary': {'key': 'properties.statusOfPrimary', 'type': 'AccountStatus'}, 'last_geo_failover_time': {'key': 'properties.lastGeoFailoverTime', 'type': 'iso-8601'}, 'secondary_location': {'key': 'properties.secondaryLocation', 'type': 'str'}, 'status_of_secondary': {'key': 'properties.statusOfSecondary', 'type': 'AccountStatus'}, 'creation_time': {'key': 'properties.creationTime', 'type': 'iso-8601'}, 'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'}, 'secondary_endpoints': {'key': 'properties.secondaryEndpoints', 'type': 'Endpoints'}, 'encryption': {'key': 'properties.encryption', 'type': 'Encryption'}, 'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'}, } def __init__(self, *, location: str=None, tags=None, **kwargs) -> None: super(StorageAccount, self).__init__(location=location, tags=tags, **kwargs) self.sku = None self.kind = None self.provisioning_state = None self.primary_endpoints = None self.primary_location = None self.status_of_primary = None self.last_geo_failover_time = None self.secondary_location = None self.status_of_secondary = None self.creation_time = None self.custom_domain = None self.secondary_endpoints = None self.encryption = None self.access_tier = None
[docs]class StorageAccountCheckNameAvailabilityParameters(Model): """StorageAccountCheckNameAvailabilityParameters. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. :param name: Required. :type name: str :ivar type: Required. Default value: "Microsoft.Storage/storageAccounts" . :vartype type: str """ _validation = { 'name': {'required': True}, 'type': {'required': True, 'constant': True}, } _attribute_map = { 'name': {'key': 'name', 'type': 'str'}, 'type': {'key': 'type', 'type': 'str'}, } type = "Microsoft.Storage/storageAccounts" def __init__(self, *, name: str, **kwargs) -> None: super(StorageAccountCheckNameAvailabilityParameters, self).__init__(**kwargs) self.name = name
[docs]class StorageAccountCreateParameters(Model): """The parameters used when creating a storage account. All required parameters must be populated in order to send to Azure. :param sku: Required. Required. Gets or sets the sku name. :type sku: ~azure.mgmt.storage.v2016_01_01.models.Sku :param kind: Required. Required. Indicates the type of storage account. Possible values include: 'Storage', 'BlobStorage' :type kind: str or ~azure.mgmt.storage.v2016_01_01.models.Kind :param location: Required. Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. :type location: str :param tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. :type tags: dict[str, str] :param custom_domain: User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. :type custom_domain: ~azure.mgmt.storage.v2016_01_01.models.CustomDomain :param encryption: Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted. :type encryption: ~azure.mgmt.storage.v2016_01_01.models.Encryption :param access_tier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool' :type access_tier: str or ~azure.mgmt.storage.v2016_01_01.models.AccessTier """ _validation = { 'sku': {'required': True}, 'kind': {'required': True}, 'location': {'required': True}, } _attribute_map = { 'sku': {'key': 'sku', 'type': 'Sku'}, 'kind': {'key': 'kind', 'type': 'Kind'}, 'location': {'key': 'location', 'type': 'str'}, 'tags': {'key': 'tags', 'type': '{str}'}, 'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'}, 'encryption': {'key': 'properties.encryption', 'type': 'Encryption'}, 'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'}, } def __init__(self, *, sku, kind, location: str, tags=None, custom_domain=None, encryption=None, access_tier=None, **kwargs) -> None: super(StorageAccountCreateParameters, self).__init__(**kwargs) self.sku = sku self.kind = kind self.location = location self.tags = tags self.custom_domain = custom_domain self.encryption = encryption self.access_tier = access_tier
[docs]class StorageAccountKey(Model): """An access key for the storage account. Variables are only populated by the server, and will be ignored when sending a request. :ivar key_name: Name of the key. :vartype key_name: str :ivar value: Base 64-encoded value of the key. :vartype value: str :ivar permissions: Permissions for the key -- read-only or full permissions. Possible values include: 'READ', 'FULL' :vartype permissions: str or ~azure.mgmt.storage.v2016_01_01.models.KeyPermission """ _validation = { 'key_name': {'readonly': True}, 'value': {'readonly': True}, 'permissions': {'readonly': True}, } _attribute_map = { 'key_name': {'key': 'keyName', 'type': 'str'}, 'value': {'key': 'value', 'type': 'str'}, 'permissions': {'key': 'permissions', 'type': 'KeyPermission'}, } def __init__(self, **kwargs) -> None: super(StorageAccountKey, self).__init__(**kwargs) self.key_name = None self.value = None self.permissions = None
[docs]class StorageAccountListKeysResult(Model): """The response from the ListKeys operation. Variables are only populated by the server, and will be ignored when sending a request. :ivar keys: Gets the list of storage account keys and their properties for the specified storage account. :vartype keys: list[~azure.mgmt.storage.v2016_01_01.models.StorageAccountKey] """ _validation = { 'keys': {'readonly': True}, } _attribute_map = { 'keys': {'key': 'keys', 'type': '[StorageAccountKey]'}, } def __init__(self, **kwargs) -> None: super(StorageAccountListKeysResult, self).__init__(**kwargs) self.keys = None
[docs]class StorageAccountRegenerateKeyParameters(Model): """StorageAccountRegenerateKeyParameters. All required parameters must be populated in order to send to Azure. :param key_name: Required. :type key_name: str """ _validation = { 'key_name': {'required': True}, } _attribute_map = { 'key_name': {'key': 'keyName', 'type': 'str'}, } def __init__(self, *, key_name: str, **kwargs) -> None: super(StorageAccountRegenerateKeyParameters, self).__init__(**kwargs) self.key_name = key_name
[docs]class StorageAccountUpdateParameters(Model): """The parameters that can be provided when updating the storage account properties. :param sku: Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS or Premium_LRS, nor can accounts of those sku names be updated to any other value. :type sku: ~azure.mgmt.storage.v2016_01_01.models.Sku :param tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters. :type tags: dict[str, str] :param custom_domain: Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. :type custom_domain: ~azure.mgmt.storage.v2016_01_01.models.CustomDomain :param encryption: Provides the encryption settings on the account. The default setting is unencrypted. :type encryption: ~azure.mgmt.storage.v2016_01_01.models.Encryption :param access_tier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool' :type access_tier: str or ~azure.mgmt.storage.v2016_01_01.models.AccessTier """ _attribute_map = { 'sku': {'key': 'sku', 'type': 'Sku'}, 'tags': {'key': 'tags', 'type': '{str}'}, 'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'}, 'encryption': {'key': 'properties.encryption', 'type': 'Encryption'}, 'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'}, } def __init__(self, *, sku=None, tags=None, custom_domain=None, encryption=None, access_tier=None, **kwargs) -> None: super(StorageAccountUpdateParameters, self).__init__(**kwargs) self.sku = sku self.tags = tags self.custom_domain = custom_domain self.encryption = encryption self.access_tier = access_tier
[docs]class Usage(Model): """Describes Storage Resource Usage. Variables are only populated by the server, and will be ignored when sending a request. :ivar unit: Gets the unit of measurement. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond', 'BytesPerSecond' :vartype unit: str or ~azure.mgmt.storage.v2016_01_01.models.UsageUnit :ivar current_value: Gets the current count of the allocated resources in the subscription. :vartype current_value: int :ivar limit: Gets the maximum count of the resources that can be allocated in the subscription. :vartype limit: int :ivar name: Gets the name of the type of usage. :vartype name: ~azure.mgmt.storage.v2016_01_01.models.UsageName """ _validation = { 'unit': {'readonly': True}, 'current_value': {'readonly': True}, 'limit': {'readonly': True}, 'name': {'readonly': True}, } _attribute_map = { 'unit': {'key': 'unit', 'type': 'UsageUnit'}, 'current_value': {'key': 'currentValue', 'type': 'int'}, 'limit': {'key': 'limit', 'type': 'int'}, 'name': {'key': 'name', 'type': 'UsageName'}, } def __init__(self, **kwargs) -> None: super(Usage, self).__init__(**kwargs) self.unit = None self.current_value = None self.limit = None self.name = None
[docs]class UsageName(Model): """The usage names that can be used; currently limited to StorageAccount. Variables are only populated by the server, and will be ignored when sending a request. :ivar value: Gets a string describing the resource name. :vartype value: str :ivar localized_value: Gets a localized string describing the resource name. :vartype localized_value: str """ _validation = { 'value': {'readonly': True}, 'localized_value': {'readonly': True}, } _attribute_map = { 'value': {'key': 'value', 'type': 'str'}, 'localized_value': {'key': 'localizedValue', 'type': 'str'}, } def __init__(self, **kwargs) -> None: super(UsageName, self).__init__(**kwargs) self.value = None self.localized_value = None