azure.mgmt.storage.v2017_10_01.models module

class azure.mgmt.storage.v2017_10_01.models.AccessTier(*values)[source]

Bases: str, Enum

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

COOL = 'Cool'

HOT = 'Hot'

class azure.mgmt.storage.v2017_10_01.models.AccountSasParameters(*, services: str | _models.Services, resource_types: str | _models.SignedResourceTypes, permissions: str | _models.Permissions, shared_access_expiry_time: datetime, ip_address_or_range: str | None = None, protocols: str | _models.HttpProtocol | None = None, shared_access_start_time: datetime | None = None, key_to_sign: str | None = None, **kwargs: Any)[source]

Bases: Model

The parameters to list SAS credentials of a storage account.

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

Variables:

services (str or Services) – The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). Required. Known values are: “b”, “q”, “t”, and “f”.
resource_types (str or SignedResourceTypes) – 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. Required. Known values are: “s”, “c”, and “o”.
permissions (str or Permissions) – 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). Required. Known values are: “r”, “d”, “w”, “l”, “a”, “c”, “u”, and “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. Known values are: “https,http” and “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. Required.
key_to_sign (str) – The key to sign the account SAS token with.

Keyword Arguments:

services (str or Services) – The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). Required. Known values are: “b”, “q”, “t”, and “f”.
resource_types (str or SignedResourceTypes) – 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. Required. Known values are: “s”, “c”, and “o”.
permissions (str or Permissions) – 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). Required. Known values are: “r”, “d”, “w”, “l”, “a”, “c”, “u”, and “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. Known values are: “https,http” and “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. Required.
key_to_sign (str) – The key to sign the account SAS token with.

class azure.mgmt.storage.v2017_10_01.models.AccountStatus(*values)[source]

Bases: str, Enum

Gets the status indicating whether the primary location of the storage account is available or unavailable.

AVAILABLE = 'available'

UNAVAILABLE = 'unavailable'

class azure.mgmt.storage.v2017_10_01.models.Bypass(*values)[source]

Bases: str, Enum

Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, “Logging, Metrics”), or None to bypass none of those traffics.

AZURE_SERVICES = 'AzureServices'

LOGGING = 'Logging'

METRICS = 'Metrics'

NONE = 'None'

class azure.mgmt.storage.v2017_10_01.models.CheckNameAvailabilityResult(**kwargs: Any)[source]

Bases: 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. Known values are: “AccountNameInvalid” and “AlreadyExists”.
message (str) – Gets an error message explaining the Reason value in more detail.

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

Bases: 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 server.

Variables:

name (str) – Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. Required.
use_sub_domain_name (bool) – Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

Keyword Arguments:

name (str) – Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. Required.
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.v2017_10_01.models.DefaultAction(*values)[source]

Bases: str, Enum

Specifies the default action of allow or deny when no other rules match.

ALLOW = 'Allow'

DENY = 'Deny'

class azure.mgmt.storage.v2017_10_01.models.Dimension(*, name: str | None = None, display_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Dimension of blobs, possibly be blob type or access tier.

Variables:

name (str) – Display name of dimension.
display_name (str) – Display name of dimension.

Keyword Arguments:

name (str) – Display name of dimension.
display_name (str) – Display name of dimension.

class azure.mgmt.storage.v2017_10_01.models.Encryption(*, key_source: str | _models.KeySource = 'Microsoft.Storage', services: _models.EncryptionServices | None = None, key_vault_properties: _models.KeyVaultProperties | None = None, **kwargs: Any)[source]

Bases: Model

The encryption settings on the storage account.

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

Variables:

services (EncryptionServices) – List of services which support encryption.
key_source (str or KeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Known values are: “Microsoft.Storage” and “Microsoft.Keyvault”.
key_vault_properties (KeyVaultProperties) – Properties provided by key vault.

Keyword Arguments:

services (EncryptionServices) – List of services which support encryption.
key_source (str or KeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Known values are: “Microsoft.Storage” and “Microsoft.Keyvault”.
key_vault_properties (KeyVaultProperties) – Properties provided by key vault.

class azure.mgmt.storage.v2017_10_01.models.EncryptionService(*, enabled: bool | None = None, **kwargs: Any)[source]

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

Variables:

enabled (bool) – A boolean indicating whether or not the service encrypts the data as it is stored.
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.

Keyword Arguments:

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

class azure.mgmt.storage.v2017_10_01.models.EncryptionServices(*, blob: _models.EncryptionService | None = None, file: _models.EncryptionService | None = None, **kwargs: Any)[source]

Bases: Model

A list of services that support encryption.

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

Variables:

blob (EncryptionService) – The encryption function of the blob storage service.
file (EncryptionService) – The encryption function of the file storage service.
table (EncryptionService) – The encryption function of the table storage service.
queue (EncryptionService) – The encryption function of the queue storage service.

Keyword Arguments:

blob (EncryptionService) – The encryption function of the blob storage service.
file (EncryptionService) – The encryption function of the file storage service.

class azure.mgmt.storage.v2017_10_01.models.Endpoints(**kwargs: Any)[source]

Bases: 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.v2017_10_01.models.HttpProtocol(*values)[source]

Bases: str, Enum

The protocol permitted for a request made with the account SAS.

HTTPS = 'https'

HTTPS_HTTP = 'https,http'

class azure.mgmt.storage.v2017_10_01.models.IPRule(*, ip_address_or_range: str, action: Literal['Allow'] | None = None, **kwargs: Any)[source]

Bases: Model

IP rule with specific IP or IP range in CIDR format.

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

Variables:

ip_address_or_range (str) – Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. Required.
action (str) – The action of IP ACL rule. Default value is “Allow”.

Keyword Arguments:

ip_address_or_range (str) – Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. Required.
action (str) – The action of IP ACL rule. Default value is “Allow”.

class azure.mgmt.storage.v2017_10_01.models.Identity(**kwargs: Any)[source]

Bases: Model

Identity for the resource.

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 server.

Variables:

principal_id (str) – The principal ID of resource identity.
tenant_id (str) – The tenant ID of resource.
type (str) – The identity type. Required. Default value is “SystemAssigned”.

type = 'SystemAssigned'

class azure.mgmt.storage.v2017_10_01.models.KeyPermission(*values)[source]

Bases: str, Enum

Permissions for the key – read-only or full permissions.

FULL = 'Full'

READ = 'Read'

class azure.mgmt.storage.v2017_10_01.models.KeySource(*values)[source]

Bases: str, Enum

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.

MICROSOFT_KEYVAULT = 'Microsoft.Keyvault'

MICROSOFT_STORAGE = 'Microsoft.Storage'

class azure.mgmt.storage.v2017_10_01.models.KeyVaultProperties(*, key_name: str | None = None, key_version: str | None = None, key_vault_uri: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties of key vault.

Variables:

key_name (str) – The name of KeyVault key.
key_version (str) – The version of KeyVault key.
key_vault_uri (str) – The Uri of KeyVault.

Keyword Arguments:

key_name (str) – The name of KeyVault key.
key_version (str) – The version of KeyVault key.
key_vault_uri (str) – The Uri of KeyVault.

class azure.mgmt.storage.v2017_10_01.models.Kind(*values)[source]

Bases: str, Enum

Indicates the type of storage account.

BLOB_STORAGE = 'BlobStorage'

STORAGE = 'Storage'

STORAGE_V2 = 'StorageV2'

class azure.mgmt.storage.v2017_10_01.models.ListAccountSasResponse(**kwargs: Any)[source]

Bases: 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.v2017_10_01.models.ListServiceSasResponse(**kwargs: Any)[source]

Bases: 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.v2017_10_01.models.MetricSpecification(*, name: str | None = None, display_name: str | None = None, display_description: str | None = None, unit: str | None = None, dimensions: List[_models.Dimension] | None = None, aggregation_type: str | None = None, fill_gap_with_zero: bool | None = None, category: str | None = None, resource_id_dimension_name_override: str | None = None, **kwargs: Any)[source]

Bases: Model

Metric specification of operation.

Variables:

name (str) – Name of metric specification.
display_name (str) – Display name of metric specification.
display_description (str) – Display description of metric specification.
unit (str) – Unit could be Bytes or Count.
dimensions (list[Dimension]) – Dimensions of blobs, including blob type and access tier.
aggregation_type (str) – Aggregation type could be Average.
fill_gap_with_zero (bool) – The property to decide fill gap with zero or not.
category (str) – The category this metric specification belong to, could be Capacity.
resource_id_dimension_name_override (str) – Account Resource Id.

Keyword Arguments:

name (str) – Name of metric specification.
display_name (str) – Display name of metric specification.
display_description (str) – Display description of metric specification.
unit (str) – Unit could be Bytes or Count.
dimensions (list[Dimension]) – Dimensions of blobs, including blob type and access tier.
aggregation_type (str) – Aggregation type could be Average.
fill_gap_with_zero (bool) – The property to decide fill gap with zero or not.
category (str) – The category this metric specification belong to, could be Capacity.
resource_id_dimension_name_override (str) – Account Resource Id.

class azure.mgmt.storage.v2017_10_01.models.NetworkRuleSet(*, default_action: str | _models.DefaultAction = 'Allow', bypass: str | _models.Bypass = 'AzureServices', virtual_network_rules: List[_models.VirtualNetworkRule] | None = None, ip_rules: List[_models.IPRule] | None = None, **kwargs: Any)[source]

Bases: Model

Network rule set.

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

Variables:

bypass (str or Bypass) – Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, “Logging, Metrics”), or None to bypass none of those traffics. Known values are: “None”, “Logging”, “Metrics”, and “AzureServices”.
virtual_network_rules (list[VirtualNetworkRule]) – Sets the virtual network rules.
ip_rules (list[IPRule]) – Sets the IP ACL rules.
default_action (str or DefaultAction) – Specifies the default action of allow or deny when no other rules match. Known values are: “Allow” and “Deny”.

Keyword Arguments:

bypass (str or Bypass) – Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, “Logging, Metrics”), or None to bypass none of those traffics. Known values are: “None”, “Logging”, “Metrics”, and “AzureServices”.
virtual_network_rules (list[VirtualNetworkRule]) – Sets the virtual network rules.
ip_rules (list[IPRule]) – Sets the IP ACL rules.
default_action (str or DefaultAction) – Specifies the default action of allow or deny when no other rules match. Known values are: “Allow” and “Deny”.

class azure.mgmt.storage.v2017_10_01.models.Operation(*, name: str | None = None, display: _models.OperationDisplay | None = None, origin: str | None = None, service_specification: _models.ServiceSpecification | None = None, **kwargs: Any)[source]

Bases: Model

Storage REST API operation definition.

Variables:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
origin (str) – The origin of operations.
service_specification (ServiceSpecification) – One property of operation, include metric specifications.

Keyword Arguments:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
origin (str) – The origin of operations.
service_specification (ServiceSpecification) – One property of operation, include metric specifications.

class azure.mgmt.storage.v2017_10_01.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, **kwargs: Any)[source]

Bases: Model

Display metadata associated with the operation.

Variables:

provider (str) – Service provider: Microsoft Storage.
resource (str) – Resource on which the operation is performed etc.
operation (str) – Type of operation: get, read, delete, etc.

Keyword Arguments:

provider (str) – Service provider: Microsoft Storage.
resource (str) – Resource on which the operation is performed etc.
operation (str) – Type of operation: get, read, delete, etc.

class azure.mgmt.storage.v2017_10_01.models.OperationListResult(*, value: List[_models.Operation] | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:: value (list[Operation]) – List of Storage operations supported by the Storage resource provider.
Keyword Arguments:: value (list[Operation]) – List of Storage operations supported by the Storage resource provider.

class azure.mgmt.storage.v2017_10_01.models.Permissions(*values)[source]

Bases: str, Enum

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).

A = 'a'

C = 'c'

D = 'd'

L = 'l'

P = 'p'

R = 'r'

U = 'u'

W = 'w'

class azure.mgmt.storage.v2017_10_01.models.ProvisioningState(*values)[source]

Bases: str, Enum

Gets the status of the storage account at the time the operation was called.

CREATING = 'Creating'

RESOLVING_DNS = 'ResolvingDNS'

SUCCEEDED = 'Succeeded'

class azure.mgmt.storage.v2017_10_01.models.Reason(*values)[source]

Bases: str, Enum

Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.

ACCOUNT_NAME_INVALID = 'AccountNameInvalid'

ALREADY_EXISTS = 'AlreadyExists'

class azure.mgmt.storage.v2017_10_01.models.ReasonCode(*values)[source]

Bases: str, Enum

The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The “NotAvailableForSubscription” is related to capacity at DC.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'

QUOTA_ID = 'QuotaId'

class azure.mgmt.storage.v2017_10_01.models.Resource(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: 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.
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).

Keyword Arguments:

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.v2017_10_01.models.Restriction(*, reason_code: str | _models.ReasonCode | None = None, **kwargs: Any)[source]

Bases: Model

The restriction because of which SKU cannot be used.

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

Variables:

type (str) – The type of restrictions. As of now only possible value for this is location.
values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
reason_code (str or ReasonCode) – The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The “NotAvailableForSubscription” is related to capacity at DC. Known values are: “QuotaId” and “NotAvailableForSubscription”.

Keyword Arguments:

reason_code (str or ReasonCode) – The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The “NotAvailableForSubscription” is related to capacity at DC. Known values are: “QuotaId” and “NotAvailableForSubscription”.

class azure.mgmt.storage.v2017_10_01.models.SKUCapability(**kwargs: Any)[source]

Bases: Model

The capability information in the specified sku, including file encryption, network acls, change notification, etc.

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

Variables:

name (str) – The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc.
value (str) – A string value to indicate states of given capability. Possibly ‘true’ or ‘false’.

Bases: Model

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

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

Variables:

canonicalized_resource (str) – The canonical path to the signed resource. Required.
resource (str or SignedResource) – The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). Required. Known values are: “b”, “c”, “f”, and “s”.
permissions (str or Permissions) – 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). Known values are: “r”, “d”, “w”, “l”, “a”, “c”, “u”, and “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. Known values are: “https,http” and “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.

Keyword Arguments:

canonicalized_resource (str) – The canonical path to the signed resource. Required.
resource (str or SignedResource) – The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). Required. Known values are: “b”, “c”, “f”, and “s”.
permissions (str or Permissions) – 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). Known values are: “r”, “d”, “w”, “l”, “a”, “c”, “u”, and “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. Known values are: “https,http” and “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.v2017_10_01.models.ServiceSpecification(*, metric_specifications: List[_models.MetricSpecification] | None = None, **kwargs: Any)[source]

Bases: Model

One property of operation, include metric specifications.

Variables:: metric_specifications (list[MetricSpecification]) – Metric specifications of operation.
Keyword Arguments:: metric_specifications (list[MetricSpecification]) – Metric specifications of operation.

class azure.mgmt.storage.v2017_10_01.models.Services(*values)[source]

Bases: str, Enum

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).

B = 'b'

F = 'f'

Q = 'q'

T = 't'

class azure.mgmt.storage.v2017_10_01.models.SignedResource(*values)[source]

Bases: str, Enum

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).

B = 'b'

C = 'c'

F = 'f'

S = 's'

class azure.mgmt.storage.v2017_10_01.models.SignedResourceTypes(*values)[source]

Bases: str, Enum

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.

C = 'c'

O = 'o'

S = 's'

class azure.mgmt.storage.v2017_10_01.models.Sku(*, name: str | _models.SkuName, restrictions: List[_models.Restriction] | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

name (str or SkuName) – Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Required. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, and “Premium_LRS”.
tier (str or SkuTier) – Gets the sku tier. This is based on the SKU name. Known values are: “Standard” and “Premium”.
resource_type (str) – The type of the resource, usually it is ‘storageAccounts’.
kind (str or Kind) – Indicates the type of storage account. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
locations (list[str]) – The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.).
capabilities (list[SKUCapability]) – The capability information in the specified sku, including file encryption, network acls, change notification, etc.
restrictions (list[Restriction]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

Keyword Arguments:

name (str or SkuName) – Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Required. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, and “Premium_LRS”.
restrictions (list[Restriction]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

class azure.mgmt.storage.v2017_10_01.models.SkuName(*values)[source]

Bases: str, Enum

Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.

PREMIUM_LRS = 'Premium_LRS'

STANDARD_GRS = 'Standard_GRS'

STANDARD_LRS = 'Standard_LRS'

STANDARD_RAGRS = 'Standard_RAGRS'

STANDARD_ZRS = 'Standard_ZRS'

class azure.mgmt.storage.v2017_10_01.models.SkuTier(*values)[source]

Bases: str, Enum

Gets the sku tier. This is based on the SKU name.

PREMIUM = 'Premium'

STANDARD = 'Standard'

class azure.mgmt.storage.v2017_10_01.models.State(*values)[source]

Bases: str, Enum

Gets the state of virtual network rule.

DEPROVISIONING = 'deprovisioning'

FAILED = 'failed'

NETWORK_SOURCE_DELETED = 'networkSourceDeleted'

PROVISIONING = 'provisioning'

SUCCEEDED = 'succeeded'

class azure.mgmt.storage.v2017_10_01.models.StorageAccount(*, location: str | None = None, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, enable_https_traffic_only: bool = False, **kwargs: Any)[source]

Bases: 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.
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).
sku (Sku) – Gets the SKU.
kind (str or Kind) – Gets the Kind. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
identity (Identity) – The identity of the resource.
provisioning_state (str or ProvisioningState) – Gets the status of the storage account at the time the operation was called. Known values are: “Creating”, “ResolvingDNS”, and “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. Known values are: “available” and “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. Known values are: “available” and “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. Known values are: “Hot” and “Cool”.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.
network_rule_set (NetworkRuleSet) – Network rule set.

Keyword Arguments:

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).
identity (Identity) – The identity of the resource.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.

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

Bases: 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 server.

Variables:

name (str) – The storage account name. Required.
type (str) – The type of resource, Microsoft.Storage/storageAccounts. Required. Default value is “Microsoft.Storage/storageAccounts”.

Keyword Arguments:

name (str) – The storage account name. Required.

type = 'Microsoft.Storage/storageAccounts'

class azure.mgmt.storage.v2017_10_01.models.StorageAccountCreateParameters(*, sku: _models.Sku, kind: str | _models.Kind, location: str, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, custom_domain: _models.CustomDomain | None = None, encryption: _models.Encryption | None = None, network_rule_set: _models.NetworkRuleSet | None = None, access_tier: str | _models.AccessTier | None = None, enable_https_traffic_only: bool = False, **kwargs: Any)[source]

Bases: Model

The parameters used when creating a storage account.

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

Variables:

sku (Sku) – Required. Gets or sets the sku name. Required.
kind (str or Kind) – Required. Indicates the type of storage account. Required. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
location (str) – 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. Required.
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.
identity (Identity) – The identity of the resource.
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.
network_rule_set (NetworkRuleSet) – Network rule set.
access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier used for billing. Known values are: “Hot” and “Cool”.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.

Keyword Arguments:

sku (Sku) – Required. Gets or sets the sku name. Required.
kind (str or Kind) – Required. Indicates the type of storage account. Required. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
location (str) – 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. Required.
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.
identity (Identity) – The identity of the resource.
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.
network_rule_set (NetworkRuleSet) – Network rule set.
access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier used for billing. Known values are: “Hot” and “Cool”.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.

class azure.mgmt.storage.v2017_10_01.models.StorageAccountKey(**kwargs: Any)[source]

Bases: 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. Known values are: “Read” and “Full”.

class azure.mgmt.storage.v2017_10_01.models.StorageAccountListKeysResult(**kwargs: Any)[source]

Bases: 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.v2017_10_01.models.StorageAccountListResult(**kwargs: Any)[source]

Bases: Model

The response from the List Storage Accounts operation.

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

Variables:: value (list[StorageAccount]) – Gets the list of storage accounts and their properties.

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

Bases: Model

The parameters used to regenerate the storage account key.

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

Variables:: key_name (str) – The name of storage keys that want to be regenerated, possible values are key1, key2. Required.
Keyword Arguments:: key_name (str) – The name of storage keys that want to be regenerated, possible values are key1, key2. Required.

class azure.mgmt.storage.v2017_10_01.models.StorageAccountUpdateParameters(*, sku: _models.Sku | None = None, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, kind: str | _models.Kind | None = None, custom_domain: _models.CustomDomain | None = None, encryption: _models.Encryption | None = None, access_tier: str | _models.AccessTier | None = None, enable_https_traffic_only: bool = False, network_rule_set: _models.NetworkRuleSet | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

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.
identity (Identity) – The identity of the resource.
kind (str or Kind) – Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
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. Known values are: “Hot” and “Cool”.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.
network_rule_set (NetworkRuleSet) – Network rule set.

Keyword Arguments:

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.
identity (Identity) – The identity of the resource.
kind (str or Kind) – Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. Known values are: “Storage”, “StorageV2”, and “BlobStorage”.
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. Known values are: “Hot” and “Cool”.
enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true.
network_rule_set (NetworkRuleSet) – Network rule set.

class azure.mgmt.storage.v2017_10_01.models.StorageSkuListResult(**kwargs: Any)[source]

Bases: Model

The response from the List Storage SKUs operation.

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

Variables:: value (list[Sku]) – Get the list result of storage SKUs and their properties.

class azure.mgmt.storage.v2017_10_01.models.Usage(**kwargs: Any)[source]

Bases: 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. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountsPerSecond”, and “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.v2017_10_01.models.UsageListResult(*, value: List[_models.Usage] | None = None, **kwargs: Any)[source]

Bases: Model

The response from the List Usages operation.

Variables:: value (list[Usage]) – Gets or sets the list of Storage Resource Usages.
Keyword Arguments:: value (list[Usage]) – Gets or sets the list of Storage Resource Usages.

class azure.mgmt.storage.v2017_10_01.models.UsageName(**kwargs: Any)[source]

Bases: 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.v2017_10_01.models.UsageUnit(*values)[source]

Bases: str, Enum

Gets the unit of measurement.

BYTES = 'Bytes'

BYTES_PER_SECOND = 'BytesPerSecond'

COUNT = 'Count'

COUNTS_PER_SECOND = 'CountsPerSecond'

PERCENT = 'Percent'

SECONDS = 'Seconds'

class azure.mgmt.storage.v2017_10_01.models.VirtualNetworkRule(*, virtual_network_resource_id: str, action: Literal['Allow'] | None = None, state: str | _models.State | None = None, **kwargs: Any)[source]

Bases: Model

Virtual Network rule.

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

Variables:

virtual_network_resource_id (str) – Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. # pylint: disable=line-too-long Required.
action (str) – The action of virtual network rule. Default value is “Allow”.
state (str or State) – Gets the state of virtual network rule. Known values are: “provisioning”, “deprovisioning”, “succeeded”, “failed”, and “networkSourceDeleted”.

Keyword Arguments:

virtual_network_resource_id (str) – Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. # pylint: disable=line-too-long Required.
action (str) – The action of virtual network rule. Default value is “Allow”.
state (str or State) – Gets the state of virtual network rule. Known values are: “provisioning”, “deprovisioning”, “succeeded”, “failed”, and “networkSourceDeleted”.