azure.mgmt.storage.v2018_02_01.models module

class azure.mgmt.storage.v2018_02_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 Services) – 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 SignedResourceTypes) – 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 Permissions) – 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.v2018_02_01.models.AzureEntityResource(**kwargs)[source]

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

The resource model definition for a Azure Resource Manager resource with an etag.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

class azure.mgmt.storage.v2018_02_01.models.BlobContainer(*, public_access=None, metadata=None, **kwargs)[source]

Bases: azure.mgmt.storage.v2018_02_01.models._models_py3.AzureEntityResource

Properties of the blob container, including Id, resource name, resource type, Etag.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

  • last_modified_time (datetime) – Returns the date and time the container was last modified.

  • lease_status (str or LeaseStatus) – The lease status of the container. Possible values include: ‘Locked’, ‘Unlocked’

  • lease_state (str or LeaseState) – Lease state of the container. Possible values include: ‘Available’, ‘Leased’, ‘Expired’, ‘Breaking’, ‘Broken’

  • lease_duration (str or LeaseDuration) – Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. Possible values include: ‘Infinite’, ‘Fixed’

  • immutability_policy (ImmutabilityPolicyProperties) – The ImmutabilityPolicy property of the container.

  • legal_hold (LegalHoldProperties) – The LegalHold property of the container.

  • has_legal_hold (bool) – The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.

  • has_immutability_policy (bool) – The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.

Parameters

  • public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: ‘Container’, ‘Blob’, ‘None’

  • metadata (dict[str, str]) – A name-value pair to associate with the container as metadata.

class azure.mgmt.storage.v2018_02_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.v2018_02_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.v2018_02_01.models.Dimension(*, name: str = None, display_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

Parameters

  • name (str) – Display name of dimension.

  • display_name (str) – Display name of dimension.

class azure.mgmt.storage.v2018_02_01.models.Encryption(*, services=None, key_source='Microsoft.Storage', key_vault_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

The encryption settings on the storage account.

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

Parameters

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

  • key_source (str or KeySource) – Required. The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Possible values include: ‘Microsoft.Storage’, ‘Microsoft.Keyvault’. Default value: “Microsoft.Storage” .

  • key_vault_properties (KeyVaultProperties) – Properties provided by key vault.

class azure.mgmt.storage.v2018_02_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.v2018_02_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.v2018_02_01.models.Endpoints(**kwargs)[source]

Bases: msrest.serialization.Model

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs 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.

  • web (str) – Gets the web endpoint.

  • dfs (str) – Gets the dfs endpoint.

class azure.mgmt.storage.v2018_02_01.models.Identity(**kwargs)[source]

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

Variables

  • principal_id (str) – The principal ID of resource identity.

  • tenant_id (str) – The tenant ID of resource.

  • type (str) – Required. The identity type. Default value: “SystemAssigned” .

type = 'SystemAssigned'
class azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicy(*, immutability_period_since_creation_in_days: int, **kwargs)[source]

Bases: azure.mgmt.storage.v2018_02_01.models._models_py3.AzureEntityResource

The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag.

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.

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

  • state (str or ImmutabilityPolicyState) – The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Possible values include: ‘Locked’, ‘Unlocked’

Parameters

immutability_period_since_creation_in_days (int) – Required. The immutability period for the blobs in the container since the policy creation, in days.

class azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyProperties(*, immutability_period_since_creation_in_days: int, **kwargs)[source]

Bases: msrest.serialization.Model

The properties of an ImmutabilityPolicy of a blob container.

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

immutability_period_since_creation_in_days (int) – Required. The immutability period for the blobs in the container since the policy creation, in days.

Variables

  • state (str or ImmutabilityPolicyState) – The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Possible values include: ‘Locked’, ‘Unlocked’

  • etag (str) – ImmutabilityPolicy Etag.

  • update_history (list[UpdateHistoryProperty]) – The ImmutabilityPolicy update history of the blob container.

class azure.mgmt.storage.v2018_02_01.models.IPRule(*, ip_address_or_range: str, action='Allow', **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters

  • ip_address_or_range (str) – Required. Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

  • action (str or Action) – The action of IP ACL rule. Possible values include: ‘Allow’. Default value: “Allow” .

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

Bases: msrest.serialization.Model

Properties of key vault.

Parameters

  • 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.v2018_02_01.models.LeaseContainerRequest(*, action, lease_id: str = None, break_period: int = None, lease_duration: int = None, proposed_lease_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Lease Container request schema.

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

Parameters

  • action (str or enum) – Required. Specifies the lease action. Can be one of the available actions. Possible values include: ‘Acquire’, ‘Renew’, ‘Change’, ‘Release’, ‘Break’

  • lease_id (str) – Identifies the lease. Can be specified in any valid GUID string format.

  • break_period (int) – Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.

  • lease_duration (int) – Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.

  • proposed_lease_id (str) – Optional for acquire, required for change. Proposed lease ID, in a GUID string format.

class azure.mgmt.storage.v2018_02_01.models.LeaseContainerResponse(*, lease_id: str = None, lease_time_seconds: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Lease Container response schema.

Parameters

  • lease_id (str) – Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease.

  • lease_time_seconds (str) – Approximate time remaining in the lease period, in seconds.

class azure.mgmt.storage.v2018_02_01.models.LegalHold(*, tags, **kwargs)[source]

Bases: msrest.serialization.Model

The LegalHold property of a blob container.

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.

Variables

has_legal_hold (bool) – The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.

Parameters

tags (list[str]) – Required. Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP.

class azure.mgmt.storage.v2018_02_01.models.LegalHoldProperties(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The LegalHold property of a blob container.

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

Variables

has_legal_hold (bool) – The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.

Parameters

tags (list[TagProperty]) – The list of LegalHold tags of a blob container.

class azure.mgmt.storage.v2018_02_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.v2018_02_01.models.ListContainerItem(*, public_access=None, metadata=None, **kwargs)[source]

Bases: azure.mgmt.storage.v2018_02_01.models._models_py3.AzureEntityResource

The blob container properties be listed out.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

  • last_modified_time (datetime) – Returns the date and time the container was last modified.

  • lease_status (str or LeaseStatus) – The lease status of the container. Possible values include: ‘Locked’, ‘Unlocked’

  • lease_state (str or LeaseState) – Lease state of the container. Possible values include: ‘Available’, ‘Leased’, ‘Expired’, ‘Breaking’, ‘Broken’

  • lease_duration (str or LeaseDuration) – Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. Possible values include: ‘Infinite’, ‘Fixed’

  • immutability_policy (ImmutabilityPolicyProperties) – The ImmutabilityPolicy property of the container.

  • legal_hold (LegalHoldProperties) – The LegalHold property of the container.

  • has_legal_hold (bool) – The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account.

  • has_immutability_policy (bool) – The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container.

Parameters

  • public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Possible values include: ‘Container’, ‘Blob’, ‘None’

  • metadata (dict[str, str]) – A name-value pair to associate with the container as metadata.

class azure.mgmt.storage.v2018_02_01.models.ListContainerItems(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The list of blob containers.

Parameters

value (list[ListContainerItem]) – The list of blob containers.

class azure.mgmt.storage.v2018_02_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.v2018_02_01.models.MetricSpecification(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, dimensions=None, aggregation_type: str = None, fill_gap_with_zero: bool = None, category: str = None, resource_id_dimension_name_override: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metric specification of operation.

Parameters

  • 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.v2018_02_01.models.NetworkRuleSet(*, bypass='AzureServices', virtual_network_rules=None, ip_rules=None, default_action='Allow', **kwargs)[source]

Bases: msrest.serialization.Model

Network rule set.

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

Parameters

  • 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. Possible values include: ‘None’, ‘Logging’, ‘Metrics’, ‘AzureServices’. Default value: “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) – Required. Specifies the default action of allow or deny when no other rules match. Possible values include: ‘Allow’, ‘Deny’. Default value: “Allow” .

class azure.mgmt.storage.v2018_02_01.models.Operation(*, name: str = None, display=None, origin: str = None, service_specification=None, **kwargs)[source]

Bases: msrest.serialization.Model

Storage REST API operation definition.

Parameters

  • 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.v2018_02_01.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Parameters

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

  • description (str) – Description of the operation.

class azure.mgmt.storage.v2018_02_01.models.ProxyResource(**kwargs)[source]

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

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.storage.v2018_02_01.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

Resource.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.storage.v2018_02_01.models.Restriction(*, reason_code=None, **kwargs)[source]

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

Parameters

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. Possible values include: ‘QuotaId’, ‘NotAvailableForSubscription’

class azure.mgmt.storage.v2018_02_01.models.ServiceSasParameters(*, canonicalized_resource: str, resource=None, 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 SignedResource) – 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 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). 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.v2018_02_01.models.ServiceSpecification(*, metric_specifications=None, **kwargs)[source]

Bases: msrest.serialization.Model

One property of operation, include metric specifications.

Parameters

metric_specifications (list[MetricSpecification]) – Metric specifications of operation.

class azure.mgmt.storage.v2018_02_01.models.Sku(*, name, restrictions=None, **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’

  • restrictions (list[Restriction]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

Variables

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

  • resource_type (str) – The type of the resource, usually it is ‘storageAccounts’.

  • kind (str or Kind) – Indicates the type of storage account. Possible values include: ‘Storage’, ‘StorageV2’, ‘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.

class azure.mgmt.storage.v2018_02_01.models.SKUCapability(**kwargs)[source]

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

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

Bases: azure.mgmt.storage.v2018_02_01.models._models_py3.TrackedResource

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.

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • sku (Sku) – Gets the SKU.

  • kind (str or Kind) – Gets the Kind. Possible values include: ‘Storage’, ‘StorageV2’, ‘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’

  • network_rule_set (NetworkRuleSet) – Network rule set

Parameters

  • tags (dict[str, str]) – Resource tags.

  • location (str) – Required. The geo-location where the resource lives

  • identity (Identity) – The identity of the resource.

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

  • is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true. Default value: False .

class azure.mgmt.storage.v2018_02_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. The storage account name.

Variables

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

type = 'Microsoft.Storage/storageAccounts'
class azure.mgmt.storage.v2018_02_01.models.StorageAccountCreateParameters(*, sku, kind, location: str, tags=None, identity=None, custom_domain=None, encryption=None, network_rule_set=None, access_tier=None, enable_https_traffic_only: bool = False, is_hns_enabled: 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’, ‘StorageV2’, ‘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.

  • 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. Possible values include: ‘Hot’, ‘Cool’

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

  • is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true. Default value: False .

class azure.mgmt.storage.v2018_02_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.v2018_02_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.v2018_02_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. The name of storage keys that want to be regenerated, possible values are key1, key2.

class azure.mgmt.storage.v2018_02_01.models.StorageAccountUpdateParameters(*, sku=None, tags=None, identity=None, custom_domain=None, encryption=None, access_tier=None, enable_https_traffic_only: bool = False, network_rule_set=None, kind=None, **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.

  • identity (Identity) – The identity of the resource.

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

  • network_rule_set (NetworkRuleSet) – Network rule set

  • kind (str or Kind) – Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. Possible values include: ‘Storage’, ‘StorageV2’, ‘BlobStorage’

class azure.mgmt.storage.v2018_02_01.models.TagProperty(**kwargs)[source]

Bases: msrest.serialization.Model

A tag of the LegalHold of a blob container.

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

Variables

  • tag (str) – The tag value.

  • timestamp (datetime) – Returns the date and time the tag was added.

  • object_identifier (str) – Returns the Object ID of the user who added the tag.

  • tenant_id (str) – Returns the Tenant ID that issued the token for the user who added the tag.

  • upn (str) – Returns the User Principal Name of the user who added the tag.

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

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

The resource model definition for a ARM tracked top level 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 Azure.

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

  • tags (dict[str, str]) – Resource tags.

  • location (str) – Required. The geo-location where the resource lives

class azure.mgmt.storage.v2018_02_01.models.UpdateHistoryProperty(**kwargs)[source]

Bases: msrest.serialization.Model

An update history of the ImmutabilityPolicy of a blob container.

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

Variables

  • update (str or ImmutabilityPolicyUpdateType) – The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. Possible values include: ‘put’, ‘lock’, ‘extend’

  • immutability_period_since_creation_in_days (int) – The immutability period for the blobs in the container since the policy creation, in days.

  • timestamp (datetime) – Returns the date and time the ImmutabilityPolicy was updated.

  • object_identifier (str) – Returns the Object ID of the user who updated the ImmutabilityPolicy.

  • tenant_id (str) – Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy.

  • upn (str) – Returns the User Principal Name of the user who updated the ImmutabilityPolicy.

class azure.mgmt.storage.v2018_02_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.v2018_02_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.v2018_02_01.models.VirtualNetworkRule(*, virtual_network_resource_id: str, action='Allow', state=None, **kwargs)[source]

Bases: msrest.serialization.Model

Virtual Network rule.

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

Parameters

  • virtual_network_resource_id (str) – Required. Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.

  • action (str or Action) – The action of virtual network rule. Possible values include: ‘Allow’. Default value: “Allow” .

  • state (str or State) – Gets the state of virtual network rule. Possible values include: ‘provisioning’, ‘deprovisioning’, ‘succeeded’, ‘failed’, ‘networkSourceDeleted’

class azure.mgmt.storage.v2018_02_01.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

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

class azure.mgmt.storage.v2018_02_01.models.SkuPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Sku object

Bring async to Paging.

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

class azure.mgmt.storage.v2018_02_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.v2018_02_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.v2018_02_01.models.ReasonCode[source]

Bases: str, enum.Enum

An enumeration.

not_available_for_subscription = 'NotAvailableForSubscription'
quota_id = 'QuotaId'
class azure.mgmt.storage.v2018_02_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.v2018_02_01.models.SkuTier[source]

Bases: str, enum.Enum

An enumeration.

premium = 'Premium'
standard = 'Standard'
class azure.mgmt.storage.v2018_02_01.models.Kind[source]

Bases: str, enum.Enum

An enumeration.

blob_storage = 'BlobStorage'
storage = 'Storage'
storage_v2 = 'StorageV2'
class azure.mgmt.storage.v2018_02_01.models.Reason[source]

Bases: str, enum.Enum

An enumeration.

account_name_invalid = 'AccountNameInvalid'
already_exists = 'AlreadyExists'
class azure.mgmt.storage.v2018_02_01.models.KeySource[source]

Bases: str, enum.Enum

An enumeration.

microsoft_keyvault = 'Microsoft.Keyvault'
microsoft_storage = 'Microsoft.Storage'
class azure.mgmt.storage.v2018_02_01.models.Action[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
class azure.mgmt.storage.v2018_02_01.models.State[source]

Bases: str, enum.Enum

An enumeration.

deprovisioning = 'deprovisioning'
failed = 'failed'
network_source_deleted = 'networkSourceDeleted'
provisioning = 'provisioning'
succeeded = 'succeeded'
class azure.mgmt.storage.v2018_02_01.models.Bypass[source]

Bases: str, enum.Enum

An enumeration.

azure_services = 'AzureServices'
logging = 'Logging'
metrics = 'Metrics'
none = 'None'
class azure.mgmt.storage.v2018_02_01.models.DefaultAction[source]

Bases: str, enum.Enum

An enumeration.

allow = 'Allow'
deny = 'Deny'
class azure.mgmt.storage.v2018_02_01.models.AccessTier[source]

Bases: str, enum.Enum

An enumeration.

cool = 'Cool'
hot = 'Hot'
class azure.mgmt.storage.v2018_02_01.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

full = 'Full'
read = 'Read'
class azure.mgmt.storage.v2018_02_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.v2018_02_01.models.Services[source]

Bases: str, enum.Enum

An enumeration.

b = 'b'
f = 'f'
q = 'q'
t = 't'
class azure.mgmt.storage.v2018_02_01.models.SignedResourceTypes[source]

Bases: str, enum.Enum

An enumeration.

c = 'c'
o = 'o'
s = 's'
class azure.mgmt.storage.v2018_02_01.models.Permissions[source]

Bases: str, enum.Enum

An enumeration.

a = 'a'
c = 'c'
d = 'd'
l = 'l'
p = 'p'
r = 'r'
u = 'u'
w = 'w'
class azure.mgmt.storage.v2018_02_01.models.HttpProtocol[source]

Bases: str, enum.Enum

An enumeration.

https = 'https'
httpshttp = 'https,http'
class azure.mgmt.storage.v2018_02_01.models.SignedResource[source]

Bases: str, enum.Enum

An enumeration.

b = 'b'
c = 'c'
f = 'f'
s = 's'
class azure.mgmt.storage.v2018_02_01.models.PublicAccess[source]

Bases: str, enum.Enum

An enumeration.

blob = 'Blob'
container = 'Container'
none = 'None'
class azure.mgmt.storage.v2018_02_01.models.LeaseStatus[source]

Bases: str, enum.Enum

An enumeration.

locked = 'Locked'
unlocked = 'Unlocked'
class azure.mgmt.storage.v2018_02_01.models.LeaseState[source]

Bases: str, enum.Enum

An enumeration.

available = 'Available'
breaking = 'Breaking'
broken = 'Broken'
expired = 'Expired'
leased = 'Leased'
class azure.mgmt.storage.v2018_02_01.models.LeaseDuration[source]

Bases: str, enum.Enum

An enumeration.

fixed = 'Fixed'
infinite = 'Infinite'
class azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyState[source]

Bases: str, enum.Enum

An enumeration.

locked = 'Locked'
unlocked = 'Unlocked'
class azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyUpdateType[source]

Bases: str, enum.Enum

An enumeration.

extend = 'extend'
lock = 'lock'
put = 'put'