azure.mgmt.storage.v2016_12_01.models module

class azure.mgmt.storage.v2016_12_01.models.AccountSasParameters(*, services, resource_types, permissions, shared_access_expiry_time, ip_address_or_range: str = None, protocols=None, shared_access_start_time=None, key_to_sign: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters to list SAS credentials of a storage account.

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

Parameters

  • services (str or enum) – Required. The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). Possible values include: ‘b’, ‘q’, ‘t’, ‘f’

  • resource_types (str or enum) – Required. The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. Possible values include: ‘s’, ‘c’, ‘o’

  • permissions (str or enum) – Required. The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). Possible values include: ‘r’, ‘d’, ‘w’, ‘l’, ‘a’, ‘c’, ‘u’, ‘p’

  • ip_address_or_range (str) – An IP address or a range of IP addresses from which to accept requests.

  • protocols (str or HttpProtocol) – The protocol permitted for a request made with the account SAS. Possible values include: ‘https,http’, ‘https’

  • shared_access_start_time (datetime) – The time at which the SAS becomes valid.

  • shared_access_expiry_time (datetime) – Required. The time at which the shared access signature becomes invalid.

  • key_to_sign (str) – The key to sign the account SAS token with.

class azure.mgmt.storage.v2016_12_01.models.CheckNameAvailabilityResult(**kwargs)[source]

Bases: msrest.serialization.Model

The CheckNameAvailability operation response.

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

Variables

  • name_available (bool) – 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.

  • reason (str or 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’

  • message (str) – Gets an error message explaining the Reason value in more detail.

class azure.mgmt.storage.v2016_12_01.models.CustomDomain(*, name: str, use_sub_domain_name: bool = None, **kwargs)[source]

Bases: msrest.serialization.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.

Parameters

  • name (str) – Required. Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

  • use_sub_domain_name (bool) – Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

class azure.mgmt.storage.v2016_12_01.models.Encryption(*, services=None, **kwargs)[source]

Bases: msrest.serialization.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.

Parameters

services (EncryptionServices) – List of services which support encryption.

Variables

key_source (str) – Required. The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage. Default value: “Microsoft.Storage” .

key_source = 'Microsoft.Storage'
class azure.mgmt.storage.v2016_12_01.models.EncryptionService(*, enabled: bool = None, **kwargs)[source]

Bases: msrest.serialization.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.

Parameters

enabled (bool) – A boolean indicating whether or not the service encrypts the data as it is stored.

Variables

last_enabled_time (datetime) – 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.

class azure.mgmt.storage.v2016_12_01.models.EncryptionServices(*, blob=None, file=None, **kwargs)[source]

Bases: msrest.serialization.Model

A list of services that support encryption.

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

Parameters
Variables
class azure.mgmt.storage.v2016_12_01.models.Endpoints(**kwargs)[source]

Bases: msrest.serialization.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.

Variables

  • blob (str) – Gets the blob endpoint.

  • queue (str) – Gets the queue endpoint.

  • table (str) – Gets the table endpoint.

  • file (str) – Gets the file endpoint.

class azure.mgmt.storage.v2016_12_01.models.ListAccountSasResponse(**kwargs)[source]

Bases: msrest.serialization.Model

The List SAS credentials operation response.

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

Variables

account_sas_token (str) – List SAS credentials of storage account.

class azure.mgmt.storage.v2016_12_01.models.ListServiceSasResponse(**kwargs)[source]

Bases: msrest.serialization.Model

The List service SAS credentials operation response.

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

Variables

service_sas_token (str) – List service SAS credentials of specific resource.

class azure.mgmt.storage.v2016_12_01.models.Resource(*, location: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a storage resource.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

class azure.mgmt.storage.v2016_12_01.models.ServiceSasParameters(*, canonicalized_resource: str, resource, permissions=None, ip_address_or_range: str = None, protocols=None, shared_access_start_time=None, shared_access_expiry_time=None, identifier: str = None, partition_key_start: str = None, partition_key_end: str = None, row_key_start: str = None, row_key_end: str = None, key_to_sign: str = None, cache_control: str = None, content_disposition: str = None, content_encoding: str = None, content_language: str = None, content_type: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters to list service SAS credentials of a specific resource.

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

Parameters

  • canonicalized_resource (str) – Required. The canonical path to the signed resource.

  • resource (str or enum) – Required. The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). Possible values include: ‘b’, ‘c’, ‘f’, ‘s’

  • permissions (str or enum) – The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). Possible values include: ‘r’, ‘d’, ‘w’, ‘l’, ‘a’, ‘c’, ‘u’, ‘p’

  • ip_address_or_range (str) – An IP address or a range of IP addresses from which to accept requests.

  • protocols (str or HttpProtocol) – The protocol permitted for a request made with the account SAS. Possible values include: ‘https,http’, ‘https’

  • shared_access_start_time (datetime) – The time at which the SAS becomes valid.

  • shared_access_expiry_time (datetime) – The time at which the shared access signature becomes invalid.

  • identifier (str) – A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.

  • partition_key_start (str) – The start of partition key.

  • partition_key_end (str) – The end of partition key.

  • row_key_start (str) – The start of row key.

  • row_key_end (str) – The end of row key.

  • key_to_sign (str) – The key to sign the account SAS token with.

  • cache_control (str) – The response header override for cache control.

  • content_disposition (str) – The response header override for content disposition.

  • content_encoding (str) – The response header override for content encoding.

  • content_language (str) – The response header override for content language.

  • content_type (str) – The response header override for content type.

class azure.mgmt.storage.v2016_12_01.models.Sku(*, name, **kwargs)[source]

Bases: msrest.serialization.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.

Parameters

name (str or SkuName) – 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’

Variables

tier (str or SkuTier) – Gets the sku tier. This is based on the SKU name. Possible values include: ‘Standard’, ‘Premium’

class azure.mgmt.storage.v2016_12_01.models.StorageAccount(*, location: str = None, tags=None, enable_https_traffic_only: bool = False, **kwargs)[source]

Bases: azure.mgmt.storage.v2016_12_01.models._models_py3.Resource

The storage account.

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

Variables

  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

  • sku (Sku) – Gets the SKU.

  • kind (str or Kind) – Gets the Kind. Possible values include: ‘Storage’, ‘BlobStorage’

  • provisioning_state (str or ProvisioningState) – Gets the status of the storage account at the time the operation was called. Possible values include: ‘Creating’, ‘ResolvingDNS’, ‘Succeeded’

  • primary_endpoints (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.

  • primary_location (str) – Gets the location of the primary data center for the storage account.

  • status_of_primary (str or AccountStatus) – Gets the status indicating whether the primary location of the storage account is available or unavailable. Possible values include: ‘available’, ‘unavailable’

  • last_geo_failover_time (datetime) – 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.

  • secondary_location (str) – Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

  • status_of_secondary (str or AccountStatus) – 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’

  • creation_time (datetime) – Gets the creation date and time of the storage account in UTC.

  • custom_domain (CustomDomain) – Gets the custom domain the user assigned to this storage account.

  • secondary_endpoints (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.

  • encryption (Encryption) – Gets the encryption settings on the account. If unspecified, the account is unencrypted.

  • access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: ‘Hot’, ‘Cool’

Parameters

  • location (str) – Resource location

  • tags (dict[str, str]) – Tags assigned to a resource; can be used for viewing and grouping a resource (across resource groups).

  • enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true. Default value: False .

class azure.mgmt.storage.v2016_12_01.models.StorageAccountCheckNameAvailabilityParameters(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters used to check the availability of the storage account name.

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.

Parameters

name (str) – Required.

Variables

type (str) – Required. Default value: “Microsoft.Storage/storageAccounts” .

type = 'Microsoft.Storage/storageAccounts'
class azure.mgmt.storage.v2016_12_01.models.StorageAccountCreateParameters(*, sku, kind, location: str, tags=None, custom_domain=None, encryption=None, access_tier=None, enable_https_traffic_only: bool = False, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters used when creating a storage account.

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

Parameters

  • sku (Sku) – Required. Required. Gets or sets the sku name.

  • kind (str or Kind) – Required. Required. Indicates the type of storage account. Possible values include: ‘Storage’, ‘BlobStorage’

  • location (str) – 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.

  • tags (dict[str, str]) – 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.

  • custom_domain (CustomDomain) – 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.

  • encryption (Encryption) – Provides the encryption settings on the account. If left unspecified the account encryption settings will remain the same. The default setting is unencrypted.

  • access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: ‘Hot’, ‘Cool’

  • enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true. Default value: False .

class azure.mgmt.storage.v2016_12_01.models.StorageAccountKey(**kwargs)[source]

Bases: msrest.serialization.Model

An access key for the storage account.

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

Variables

  • key_name (str) – Name of the key.

  • value (str) – Base 64-encoded value of the key.

  • permissions (str or KeyPermission) – Permissions for the key – read-only or full permissions. Possible values include: ‘Read’, ‘Full’

class azure.mgmt.storage.v2016_12_01.models.StorageAccountListKeysResult(**kwargs)[source]

Bases: msrest.serialization.Model

The response from the ListKeys operation.

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

Variables

keys (list[StorageAccountKey]) – Gets the list of storage account keys and their properties for the specified storage account.

class azure.mgmt.storage.v2016_12_01.models.StorageAccountRegenerateKeyParameters(*, key_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters used to regenerate the storage account key.

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

Parameters

key_name (str) – Required.

class azure.mgmt.storage.v2016_12_01.models.StorageAccountUpdateParameters(*, sku=None, tags=None, custom_domain=None, encryption=None, access_tier=None, enable_https_traffic_only: bool = False, **kwargs)[source]

Bases: msrest.serialization.Model

The parameters that can be provided when updating the storage account properties.

Parameters

  • sku (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.

  • tags (dict[str, str]) – 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.

  • custom_domain (CustomDomain) – 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.

  • encryption (Encryption) – Provides the encryption settings on the account. The default setting is unencrypted.

  • access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: ‘Hot’, ‘Cool’

  • enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true. Default value: False .

class azure.mgmt.storage.v2016_12_01.models.Usage(**kwargs)[source]

Bases: msrest.serialization.Model

Describes Storage Resource Usage.

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

Variables

  • unit (str or UsageUnit) – Gets the unit of measurement. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘Percent’, ‘CountsPerSecond’, ‘BytesPerSecond’

  • current_value (int) – Gets the current count of the allocated resources in the subscription.

  • limit (int) – Gets the maximum count of the resources that can be allocated in the subscription.

  • name (UsageName) – Gets the name of the type of usage.

class azure.mgmt.storage.v2016_12_01.models.UsageName(**kwargs)[source]

Bases: msrest.serialization.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.

Variables

  • value (str) – Gets a string describing the resource name.

  • localized_value (str) – Gets a localized string describing the resource name.

class azure.mgmt.storage.v2016_12_01.models.StorageAccountPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of StorageAccount object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storage.v2016_12_01.models.UsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Usage object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storage.v2016_12_01.models.Reason[source]

Bases: str, enum.Enum

An enumeration.

account_name_invalid = 'AccountNameInvalid'
already_exists = 'AlreadyExists'
class azure.mgmt.storage.v2016_12_01.models.SkuName[source]

Bases: str, enum.Enum

An enumeration.

premium_lrs = 'Premium_LRS'
standard_grs = 'Standard_GRS'
standard_lrs = 'Standard_LRS'
standard_ragrs = 'Standard_RAGRS'
standard_zrs = 'Standard_ZRS'
class azure.mgmt.storage.v2016_12_01.models.SkuTier[source]

Bases: str, enum.Enum

An enumeration.

premium = 'Premium'
standard = 'Standard'
class azure.mgmt.storage.v2016_12_01.models.AccessTier[source]

Bases: str, enum.Enum

An enumeration.

cool = 'Cool'
hot = 'Hot'
class azure.mgmt.storage.v2016_12_01.models.Kind[source]

Bases: str, enum.Enum

An enumeration.

blob_storage = 'BlobStorage'
storage = 'Storage'
class azure.mgmt.storage.v2016_12_01.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
resolving_dns = 'ResolvingDNS'
succeeded = 'Succeeded'
class azure.mgmt.storage.v2016_12_01.models.AccountStatus[source]

Bases: str, enum.Enum

An enumeration.

available = 'available'
unavailable = 'unavailable'
class azure.mgmt.storage.v2016_12_01.models.KeyPermission[source]

Bases: str, enum.Enum

An enumeration.

full = 'Full'
read = 'Read'
class azure.mgmt.storage.v2016_12_01.models.UsageUnit[source]

Bases: str, enum.Enum

An enumeration.

bytes = 'Bytes'
bytes_per_second = 'BytesPerSecond'
count = 'Count'
counts_per_second = 'CountsPerSecond'
percent = 'Percent'
seconds = 'Seconds'
class azure.mgmt.storage.v2016_12_01.models.HttpProtocol[source]

Bases: str, enum.Enum

An enumeration.

https = 'https'
httpshttp = 'https,http'