azure.mgmt.storage.v2024_01_01.models module

class azure.mgmt.storage.v2024_01_01.models.AccessPolicy(*, start_time: datetime | None = None, expiry_time: datetime | None = None, permission: str | None = None, **kwargs: Any)

Bases: Model

AccessPolicy.

Variables:

• start_time (datetime) – Start time of the access policy.

• expiry_time (datetime) – Expiry time of the access policy.

• permission (str) – List of abbreviated permissions.

Keyword Arguments:

• start_time (datetime) – Start time of the access policy.

• expiry_time (datetime) – Expiry time of the access policy.

• permission (str) – List of abbreviated permissions.

class azure.mgmt.storage.v2024_01_01.models.AccessTier(*values)

Bases: str, Enum

Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type.

COLD = 'Cold'

COOL = 'Cool'

HOT = 'Hot'

PREMIUM = 'Premium'

class azure.mgmt.storage.v2024_01_01.models.AccountImmutabilityPolicyProperties(*, immutability_period_since_creation_in_days: int | None = None, state: str | _models.AccountImmutabilityPolicyState | None = None, allow_protected_append_writes: bool | None = None, **kwargs: Any)

Bases: Model

This defines account-level immutability policy properties.

Variables:

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

• state (str or AccountImmutabilityPolicyState) – The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. Known values are: “Unlocked”, “Locked”, and “Disabled”.

• allow_protected_append_writes (bool) – This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

Keyword Arguments:

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

• state (str or AccountImmutabilityPolicyState) – The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. Known values are: “Unlocked”, “Locked”, and “Disabled”.

• allow_protected_append_writes (bool) – This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

class azure.mgmt.storage.v2024_01_01.models.AccountImmutabilityPolicyState(*values)

Bases: str, Enum

The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted.

DISABLED = 'Disabled'

LOCKED = 'Locked'

UNLOCKED = 'Unlocked'

class azure.mgmt.storage.v2024_01_01.models.AccountLimits(**kwargs: Any)

Bases: Model

Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.

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

Variables:

• max_file_shares (int) – The maximum number of file shares limit for the storage account.

• max_provisioned_storage_gi_b (int) – The maximum provisioned storage quota limit in gibibytes for the storage account.

• max_provisioned_iops (int) – The maximum provisioned IOPS limit for the storage account.

• max_provisioned_bandwidth_mi_b_per_sec (int) – The maximum provisioned bandwidth limit in mebibytes per second for the storage account.

class azure.mgmt.storage.v2024_01_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)

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.v2024_01_01.models.AccountStatus(*values)

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.v2024_01_01.models.AccountType(*values)

Bases: str, Enum

Specifies the Active Directory account type for Azure Storage.

COMPUTER = 'Computer'

USER = 'User'

class azure.mgmt.storage.v2024_01_01.models.AccountUsage(**kwargs: Any)

Bases: Model

Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.

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

Variables:

• live_shares (AccountUsageElements) – Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.

• soft_deleted_shares (AccountUsageElements) – Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.

class azure.mgmt.storage.v2024_01_01.models.AccountUsageElements(**kwargs: Any)

Bases: Model

Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account.

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

Variables:

• file_share_count (int) – The total number of file shares.

• provisioned_storage_gi_b (int) – The total provisioned storage quota in gibibytes.

• provisioned_iops (int) – The total provisioned IOPS.

• provisioned_bandwidth_mi_b_per_sec (int) – The total provisioned bandwidth in mebibytes per second.

class azure.mgmt.storage.v2024_01_01.models.ActiveDirectoryProperties(*, domain_name: str, domain_guid: str, net_bios_domain_name: str | None = None, forest_name: str | None = None, domain_sid: str | None = None, azure_storage_sid: str | None = None, sam_account_name: str | None = None, account_type: str | _models.AccountType | None = None, **kwargs: Any)

Bases: Model

Settings properties for Active Directory (AD).

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

Variables:

• domain_name (str) – Specifies the primary domain that the AD DNS server is authoritative for. Required.

• net_bios_domain_name (str) – Specifies the NetBIOS domain name.

• forest_name (str) – Specifies the Active Directory forest to get.

• domain_guid (str) – Specifies the domain GUID. Required.

• domain_sid (str) – Specifies the security identifier (SID).

• azure_storage_sid (str) – Specifies the security identifier (SID) for Azure Storage.

• sam_account_name (str) – Specifies the Active Directory SAMAccountName for Azure Storage.

• account_type (str or AccountType) – Specifies the Active Directory account type for Azure Storage. Known values are: “User” and “Computer”.

Keyword Arguments:

• domain_name (str) – Specifies the primary domain that the AD DNS server is authoritative for. Required.

• net_bios_domain_name (str) – Specifies the NetBIOS domain name.

• forest_name (str) – Specifies the Active Directory forest to get.

• domain_guid (str) – Specifies the domain GUID. Required.

• domain_sid (str) – Specifies the security identifier (SID).

• azure_storage_sid (str) – Specifies the security identifier (SID) for Azure Storage.

• sam_account_name (str) – Specifies the Active Directory SAMAccountName for Azure Storage.

• account_type (str or AccountType) – Specifies the Active Directory account type for Azure Storage. Known values are: “User” and “Computer”.

class azure.mgmt.storage.v2024_01_01.models.AllowedCopyScope(*values)

Bases: str, Enum

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.

AAD = 'AAD'

PRIVATE_LINK = 'PrivateLink'

class azure.mgmt.storage.v2024_01_01.models.AllowedMethods(*values)

Bases: str, Enum

AllowedMethods.

CONNECT = 'CONNECT'

DELETE = 'DELETE'

GET = 'GET'

HEAD = 'HEAD'

MERGE = 'MERGE'

OPTIONS = 'OPTIONS'

PATCH = 'PATCH'

POST = 'POST'

PUT = 'PUT'

TRACE = 'TRACE'

class azure.mgmt.storage.v2024_01_01.models.AzureEntityResource(**kwargs: Any)

Bases: Resource

The resource model definition for an 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

class azure.mgmt.storage.v2024_01_01.models.AzureFilesIdentityBasedAuthentication(*, directory_service_options: str | _models.DirectoryServiceOptions, active_directory_properties: _models.ActiveDirectoryProperties | None = None, default_share_permission: str | _models.DefaultSharePermission | None = None, **kwargs: Any)

Bases: Model

Settings for Azure Files identity based authentication.

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

Variables:

• directory_service_options (str or DirectoryServiceOptions) – Indicates the directory service used. Note that this enum may be extended in the future. Required. Known values are: “None”, “AADDS”, “AD”, and “AADKERB”.

• active_directory_properties (ActiveDirectoryProperties) – Required if directoryServiceOptions are AD, optional if they are AADKERB.

• default_share_permission (str or DefaultSharePermission) – Default share permission for users using Kerberos authentication if RBAC role is not assigned. Known values are: “None”, “StorageFileDataSmbShareReader”, “StorageFileDataSmbShareContributor”, and “StorageFileDataSmbShareElevatedContributor”.

Keyword Arguments:

• directory_service_options (str or DirectoryServiceOptions) – Indicates the directory service used. Note that this enum may be extended in the future. Required. Known values are: “None”, “AADDS”, “AD”, and “AADKERB”.

• active_directory_properties (ActiveDirectoryProperties) – Required if directoryServiceOptions are AD, optional if they are AADKERB.

• default_share_permission (str or DefaultSharePermission) – Default share permission for users using Kerberos authentication if RBAC role is not assigned. Known values are: “None”, “StorageFileDataSmbShareReader”, “StorageFileDataSmbShareContributor”, and “StorageFileDataSmbShareElevatedContributor”.

class azure.mgmt.storage.v2024_01_01.models.BlobContainer(*, default_encryption_scope: str | None = None, deny_encryption_scope_override: bool | None = None, public_access: str | _models.PublicAccess | None = None, metadata: Dict[str, str] | None = None, immutable_storage_with_versioning: _models.ImmutableStorageWithVersioning | None = None, enable_nfs_v3_root_squash: bool | None = None, enable_nfs_v3_all_squash: bool | None = None, **kwargs: Any)

Bases: 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• version (str) – The version of the deleted blob container.

• deleted (bool) – Indicates whether the blob container was deleted.

• deleted_time (datetime) – Blob container deletion time.

• remaining_retention_days (int) – Remaining retention days for soft deleted blob container.

• default_encryption_scope (str) – Default the container to use specified encryption scope for all writes.

• deny_encryption_scope_override (bool) – Block override of encryption scope from the container default.

• public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Known values are: “Container”, “Blob”, and “None”.

• 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. Known values are: “Locked” and “Unlocked”.

• lease_state (str or LeaseState) – Lease state of the container. Known values are: “Available”, “Leased”, “Expired”, “Breaking”, and “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. Known values are: “Infinite” and “Fixed”.

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

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

• immutable_storage_with_versioning (ImmutableStorageWithVersioning) – The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.

• enable_nfs_v3_root_squash (bool) – Enable NFSv3 root squash on blob container.

• enable_nfs_v3_all_squash (bool) – Enable NFSv3 all squash on blob container.

Keyword Arguments:

• default_encryption_scope (str) – Default the container to use specified encryption scope for all writes.

• deny_encryption_scope_override (bool) – Block override of encryption scope from the container default.

• public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Known values are: “Container”, “Blob”, and “None”.

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

• immutable_storage_with_versioning (ImmutableStorageWithVersioning) – The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.

• enable_nfs_v3_root_squash (bool) – Enable NFSv3 root squash on blob container.

• enable_nfs_v3_all_squash (bool) – Enable NFSv3 all squash on blob container.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryCreationTime(*, last_n_days: int | None = None, **kwargs: Any)

Bases: Model

This property defines the creation time based filtering condition. Blob Inventory schema parameter ‘Creation-Time’ is mandatory with this filter.

Variables:

last_n_days (int) – When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500.

Keyword Arguments:

last_n_days (int) – When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicy(*, policy: _models.BlobInventoryPolicySchema | None = None, **kwargs: Any)

Bases: Resource

The storage account blob inventory policy.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

• last_modified_time (datetime) – Returns the last modified date and time of the blob inventory policy.

• policy (BlobInventoryPolicySchema) – The storage account blob inventory policy object. It is composed of policy rules.

Keyword Arguments:

policy (BlobInventoryPolicySchema) – The storage account blob inventory policy object. It is composed of policy rules.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicyDefinition(*, format: str | _models.Format, schedule: str | _models.Schedule, object_type: str | _models.ObjectType, schema_fields: List[str], filters: _models.BlobInventoryPolicyFilter | None = None, **kwargs: Any)

Bases: Model

An object that defines the blob inventory rule.

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

Variables:

• filters (BlobInventoryPolicyFilter) – An object that defines the filter set.

• format (str or Format) – This is a required field, it specifies the format for the inventory files. Required. Known values are: “Csv” and “Parquet”.

• schedule (str or Schedule) – This is a required field. This field is used to schedule an inventory formation. Required. Known values are: “Daily” and “Weekly”.

• object_type (str or ObjectType) – This is a required field. This field specifies the scope of the inventory created either at the blob or container level. Required. Known values are: “Blob” and “Container”.

• schema_fields (list[str]) – This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value ‘Name’ is always required. The valid values for this field for the ‘Blob’ definition.objectType include ‘Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount’. For Blob object type schema field value ‘DeletedTime’ is applicable only for Hns enabled accounts. The valid values for ‘Container’ definition.objectType include ‘Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays’. Schema field values ‘Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId’ are valid only for Hns enabled accounts.Schema field values ‘Tags, TagCount’ are only valid for Non-Hns accounts. Required.

Keyword Arguments:

• filters (BlobInventoryPolicyFilter) – An object that defines the filter set.

• format (str or Format) – This is a required field, it specifies the format for the inventory files. Required. Known values are: “Csv” and “Parquet”.

• schedule (str or Schedule) – This is a required field. This field is used to schedule an inventory formation. Required. Known values are: “Daily” and “Weekly”.

• object_type (str or ObjectType) – This is a required field. This field specifies the scope of the inventory created either at the blob or container level. Required. Known values are: “Blob” and “Container”.

• schema_fields (list[str]) – This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value ‘Name’ is always required. The valid values for this field for the ‘Blob’ definition.objectType include ‘Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount’. For Blob object type schema field value ‘DeletedTime’ is applicable only for Hns enabled accounts. The valid values for ‘Container’ definition.objectType include ‘Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays’. Schema field values ‘Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId’ are valid only for Hns enabled accounts.Schema field values ‘Tags, TagCount’ are only valid for Non-Hns accounts. Required.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicyFilter(*, prefix_match: List[str] | None = None, exclude_prefix: List[str] | None = None, blob_types: List[str] | None = None, include_blob_versions: bool | None = None, include_snapshots: bool | None = None, include_deleted: bool | None = None, creation_time: _models.BlobInventoryCreationTime | None = None, **kwargs: Any)

Bases: Model

An object that defines the blob inventory rule filter conditions. For ‘Blob’ definition.objectType all filter properties are applicable, ‘blobTypes’ is required and others are optional. For ‘Container’ definition.objectType only prefixMatch is applicable and is optional.

Variables:

• prefix_match (list[str]) – An array of strings with maximum 10 blob prefixes to be included in the inventory.

• exclude_prefix (list[str]) – An array of strings with maximum 10 blob prefixes to be excluded from the inventory.

• blob_types (list[str]) – An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to ‘Blob’.

• include_blob_versions (bool) – Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values ‘VersionId and IsCurrentVersion’ are required if this property is set to true, else they must be excluded.

• include_snapshots (bool) – Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value ‘Snapshot’ is required if this property is set to true, else it must be excluded.

• include_deleted (bool) – For ‘Container’ definition.objectType the definition.schemaFields must include ‘Deleted, Version, DeletedTime and RemainingRetentionDays’. For ‘Blob’ definition.objectType and HNS enabled storage accounts the definition.schemaFields must include ‘DeletionId, Deleted, DeletedTime and RemainingRetentionDays’ and for Hns disabled accounts the definition.schemaFields must include ‘Deleted and RemainingRetentionDays’, else it must be excluded.

• creation_time (BlobInventoryCreationTime) – This property is used to filter objects based on the object creation time.

Keyword Arguments:

• prefix_match (list[str]) – An array of strings with maximum 10 blob prefixes to be included in the inventory.

• exclude_prefix (list[str]) – An array of strings with maximum 10 blob prefixes to be excluded from the inventory.

• blob_types (list[str]) – An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to ‘Blob’.

• include_blob_versions (bool) – Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values ‘VersionId and IsCurrentVersion’ are required if this property is set to true, else they must be excluded.

• include_snapshots (bool) – Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value ‘Snapshot’ is required if this property is set to true, else it must be excluded.

• include_deleted (bool) – For ‘Container’ definition.objectType the definition.schemaFields must include ‘Deleted, Version, DeletedTime and RemainingRetentionDays’. For ‘Blob’ definition.objectType and HNS enabled storage accounts the definition.schemaFields must include ‘DeletionId, Deleted, DeletedTime and RemainingRetentionDays’ and for Hns disabled accounts the definition.schemaFields must include ‘Deleted and RemainingRetentionDays’, else it must be excluded.

• creation_time (BlobInventoryCreationTime) – This property is used to filter objects based on the object creation time.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicyName(*values)

Bases: str, Enum

BlobInventoryPolicyName.

DEFAULT = 'default'

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicyRule(*, enabled: bool, name: str, destination: str, definition: _models.BlobInventoryPolicyDefinition, **kwargs: Any)

Bases: Model

An object that wraps the blob inventory rule. Each rule is uniquely defined by name.

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

Variables:

• enabled (bool) – Rule is enabled when set to true. Required.

• name (str) – A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. Required.

• destination (str) – Container name where blob inventory files are stored. Must be pre-created. Required.

• definition (BlobInventoryPolicyDefinition) – An object that defines the blob inventory policy rule. Required.

Keyword Arguments:

• enabled (bool) – Rule is enabled when set to true. Required.

• name (str) – A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. Required.

• destination (str) – Container name where blob inventory files are stored. Must be pre-created. Required.

• definition (BlobInventoryPolicyDefinition) – An object that defines the blob inventory policy rule. Required.

class azure.mgmt.storage.v2024_01_01.models.BlobInventoryPolicySchema(*, enabled: bool, type: str | _models.InventoryRuleType, rules: List[_models.BlobInventoryPolicyRule], **kwargs: Any)

Bases: Model

The storage account blob inventory policy rules.

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:

• enabled (bool) – Policy is enabled if set to true. Required.

• destination (str) – Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level ‘policy.rule.destination’.

• type (str or InventoryRuleType) – The valid value is Inventory. Required. “Inventory”

• rules (list[BlobInventoryPolicyRule]) – The storage account blob inventory policy rules. The rule is applied when it is enabled. Required.

Keyword Arguments:

• enabled (bool) – Policy is enabled if set to true. Required.

• type (str or InventoryRuleType) – The valid value is Inventory. Required. “Inventory”

• rules (list[BlobInventoryPolicyRule]) – The storage account blob inventory policy rules. The rule is applied when it is enabled. Required.

class azure.mgmt.storage.v2024_01_01.models.BlobRestoreParameters(*, time_to_restore: datetime, blob_ranges: List[_models.BlobRestoreRange], **kwargs: Any)

Bases: Model

Blob restore parameters.

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

Variables:

• time_to_restore (datetime) – Restore blob to the specified time. Required.

• blob_ranges (list[BlobRestoreRange]) – Blob ranges to restore. Required.

Keyword Arguments:

• time_to_restore (datetime) – Restore blob to the specified time. Required.

• blob_ranges (list[BlobRestoreRange]) – Blob ranges to restore. Required.

class azure.mgmt.storage.v2024_01_01.models.BlobRestoreProgressStatus(*values)

Bases: str, Enum

The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed.

COMPLETE = 'Complete'

FAILED = 'Failed'

IN_PROGRESS = 'InProgress'

class azure.mgmt.storage.v2024_01_01.models.BlobRestoreRange(*, start_range: str, end_range: str, **kwargs: Any)

Bases: Model

Blob range.

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

Variables:

• start_range (str) – Blob start range. This is inclusive. Empty means account start. Required.

• end_range (str) – Blob end range. This is exclusive. Empty means account end. Required.

Keyword Arguments:

• start_range (str) – Blob start range. This is inclusive. Empty means account start. Required.

• end_range (str) – Blob end range. This is exclusive. Empty means account end. Required.

class azure.mgmt.storage.v2024_01_01.models.BlobRestoreStatus(**kwargs: Any)

Bases: Model

Blob restore status.

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

Variables:

• status (str or BlobRestoreProgressStatus) – The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. Known values are: “InProgress”, “Complete”, and “Failed”.

• failure_reason (str) – Failure reason when blob restore is failed.

• restore_id (str) – Id for tracking blob restore request.

• parameters (BlobRestoreParameters) – Blob restore request parameters.

class azure.mgmt.storage.v2024_01_01.models.BlobServiceItems(**kwargs: Any)

Bases: Model

BlobServiceItems.

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

Variables:

value (list[BlobServiceProperties]) – List of blob services returned.

class azure.mgmt.storage.v2024_01_01.models.BlobServiceProperties(*, cors: _models.CorsRules | None = None, default_service_version: str | None = None, delete_retention_policy: _models.DeleteRetentionPolicy | None = None, is_versioning_enabled: bool | None = None, automatic_snapshot_policy_enabled: bool | None = None, change_feed: _models.ChangeFeed | None = None, restore_policy: _models.RestorePolicyProperties | None = None, container_delete_retention_policy: _models.DeleteRetentionPolicy | None = None, last_access_time_tracking_policy: _models.LastAccessTimeTrackingPolicy | None = None, **kwargs: Any)

Bases: Resource

The properties of a storage account’s Blob service.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• sku (Sku) – Sku name and tier.

• cors (CorsRules) – Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.

• default_service_version (str) – DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.

• delete_retention_policy (DeleteRetentionPolicy) – The blob service properties for blob soft delete.

• is_versioning_enabled (bool) – Versioning is enabled if set to true.

• automatic_snapshot_policy_enabled (bool) – Deprecated in favor of isVersioningEnabled property.

• change_feed (ChangeFeed) – The blob service properties for change feed events.

• restore_policy (RestorePolicyProperties) – The blob service properties for blob restore policy.

• container_delete_retention_policy (DeleteRetentionPolicy) – The blob service properties for container soft delete.

• last_access_time_tracking_policy (LastAccessTimeTrackingPolicy) – The blob service property to configure last access time based tracking policy.

Keyword Arguments:

• cors (CorsRules) – Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.

• default_service_version (str) – DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions.

• delete_retention_policy (DeleteRetentionPolicy) – The blob service properties for blob soft delete.

• is_versioning_enabled (bool) – Versioning is enabled if set to true.

• automatic_snapshot_policy_enabled (bool) – Deprecated in favor of isVersioningEnabled property.

• change_feed (ChangeFeed) – The blob service properties for change feed events.

• restore_policy (RestorePolicyProperties) – The blob service properties for blob restore policy.

• container_delete_retention_policy (DeleteRetentionPolicy) – The blob service properties for container soft delete.

• last_access_time_tracking_policy (LastAccessTimeTrackingPolicy) – The blob service property to configure last access time based tracking policy.

class azure.mgmt.storage.v2024_01_01.models.BurstingConstants(**kwargs: Any)

Bases: Model

Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.

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

Variables:

• burst_floor_iops (int) – The guaranteed floor of burst IOPS for small file shares.

• burst_io_scalar (float) – The scalar against provisioned IOPS in the file share included burst IOPS formula.

• burst_timeframe_seconds (int) – The time frame for bursting in seconds in the file share maximum burst credits for IOPS formula.

class azure.mgmt.storage.v2024_01_01.models.Bypass(*values)

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.v2024_01_01.models.ChangeFeed(*, enabled: bool | None = None, retention_in_days: int | None = None, **kwargs: Any)

Bases: Model

The blob service properties for change feed events.

Variables:

• enabled (bool) – Indicates whether change feed event logging is enabled for the Blob service.

• retention_in_days (int) – Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed.

Keyword Arguments:

• enabled (bool) – Indicates whether change feed event logging is enabled for the Blob service.

• retention_in_days (int) – Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed.

class azure.mgmt.storage.v2024_01_01.models.CheckNameAvailabilityResult(**kwargs: Any)

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.v2024_01_01.models.CloudErrorBody(*, code: str | None = None, message: str | None = None, target: str | None = None, details: List[_models.CloudErrorBody] | None = None, **kwargs: Any)

Bases: Model

An error response from the Storage service.

Variables:

• code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

• message (str) – A message describing the error, intended to be suitable for display in a user interface.

• target (str) – The target of the particular error. For example, the name of the property in error.

• details (list[CloudErrorBody]) – A list of additional details about the error.

Keyword Arguments:

• code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

• message (str) – A message describing the error, intended to be suitable for display in a user interface.

• target (str) – The target of the particular error. For example, the name of the property in error.

• details (list[CloudErrorBody]) – A list of additional details about the error.

class azure.mgmt.storage.v2024_01_01.models.CorsRule(*, allowed_origins: List[str], allowed_methods: List[str | _models.AllowedMethods], max_age_in_seconds: int, exposed_headers: List[str], allowed_headers: List[str], **kwargs: Any)

Bases: Model

Specifies a CORS rule for the Blob service.

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

Variables:

• allowed_origins (list[str]) – Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains. Required.

• allowed_methods (list[str or AllowedMethods]) – Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. Required.

• max_age_in_seconds (int) – Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. Required.

• exposed_headers (list[str]) – Required if CorsRule element is present. A list of response headers to expose to CORS clients. Required.

• allowed_headers (list[str]) – Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. Required.

Keyword Arguments:

• allowed_origins (list[str]) – Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains. Required.

• allowed_methods (list[str or AllowedMethods]) – Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. Required.

• max_age_in_seconds (int) – Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. Required.

• exposed_headers (list[str]) – Required if CorsRule element is present. A list of response headers to expose to CORS clients. Required.

• allowed_headers (list[str]) – Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. Required.

class azure.mgmt.storage.v2024_01_01.models.CorsRules(*, cors_rules: List[_models.CorsRule] | None = None, **kwargs: Any)

Bases: Model

Sets the CORS rules. You can include up to five CorsRule elements in the request.

Variables:

cors_rules (list[CorsRule]) – The List of CORS rules. You can include up to five CorsRule elements in the request.

Keyword Arguments:

cors_rules (list[CorsRule]) – The List of CORS rules. You can include up to five CorsRule elements in the request.

class azure.mgmt.storage.v2024_01_01.models.CreatedByType(*values)

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.storage.v2024_01_01.models.CustomDomain(*, name: str, use_sub_domain_name: bool | None = None, **kwargs: Any)

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.v2024_01_01.models.DateAfterCreation(*, days_after_creation_greater_than: float, days_after_last_tier_change_greater_than: float | None = None, **kwargs: Any)

Bases: Model

Object to define snapshot and version action conditions.

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

Variables:

• days_after_creation_greater_than (float) – Value indicating the age in days after creation. Required.

• days_after_last_tier_change_greater_than (float) – Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied.

Keyword Arguments:

• days_after_creation_greater_than (float) – Value indicating the age in days after creation. Required.

• days_after_last_tier_change_greater_than (float) – Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied.

class azure.mgmt.storage.v2024_01_01.models.DateAfterModification(*, days_after_modification_greater_than: float | None = None, days_after_last_access_time_greater_than: float | None = None, days_after_last_tier_change_greater_than: float | None = None, days_after_creation_greater_than: float | None = None, **kwargs: Any)

Bases: Model

Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan.

Variables:

• days_after_modification_greater_than (float) – Value indicating the age in days after last modification.

• days_after_last_access_time_greater_than (float) – Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy.

• days_after_last_tier_change_greater_than (float) – Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied.

• days_after_creation_greater_than (float) – Value indicating the age in days after blob creation.

Keyword Arguments:

• days_after_modification_greater_than (float) – Value indicating the age in days after last modification.

• days_after_last_access_time_greater_than (float) – Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy.

• days_after_last_tier_change_greater_than (float) – Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied.

• days_after_creation_greater_than (float) – Value indicating the age in days after blob creation.

class azure.mgmt.storage.v2024_01_01.models.DefaultAction(*values)

Bases: str, Enum

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

ALLOW = 'Allow'

DENY = 'Deny'

class azure.mgmt.storage.v2024_01_01.models.DefaultSharePermission(*values)

Bases: str, Enum

Default share permission for users using Kerberos authentication if RBAC role is not assigned.

NONE = 'None'

STORAGE_FILE_DATA_SMB_SHARE_CONTRIBUTOR = 'StorageFileDataSmbShareContributor'

STORAGE_FILE_DATA_SMB_SHARE_ELEVATED_CONTRIBUTOR = 'StorageFileDataSmbShareElevatedContributor'

STORAGE_FILE_DATA_SMB_SHARE_READER = 'StorageFileDataSmbShareReader'

class azure.mgmt.storage.v2024_01_01.models.DeleteRetentionPolicy(*, enabled: bool | None = None, days: int | None = None, allow_permanent_delete: bool | None = None, **kwargs: Any)

Bases: Model

The service properties for soft delete.

Variables:

• enabled (bool) – Indicates whether DeleteRetentionPolicy is enabled.

• days (int) – Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

• allow_permanent_delete (bool) – This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share.

Keyword Arguments:

• enabled (bool) – Indicates whether DeleteRetentionPolicy is enabled.

• days (int) – Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365.

• allow_permanent_delete (bool) – This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share.

class azure.mgmt.storage.v2024_01_01.models.DeletedAccount(**kwargs: Any)

Bases: ProxyResource

Deleted storage account.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• storage_account_resource_id (str) – Full resource id of the original storage account.

• location (str) – Location of the deleted account.

• restore_reference (str) – Can be used to attempt recovering this deleted account via PutStorageAccount API.

• creation_time (str) – Creation time of the deleted account.

• deletion_time (str) – Deletion time of the deleted account.

class azure.mgmt.storage.v2024_01_01.models.DeletedAccountListResult(**kwargs: Any)

Bases: Model

The response from the List Deleted Accounts operation.

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

Variables:

• value (list[DeletedAccount]) – Gets the list of deleted accounts and their properties.

• next_link (str) – Request URL that can be used to query next page of deleted accounts. Returned when total number of requested deleted accounts exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.DeletedShare(*, deleted_share_name: str, deleted_share_version: str, **kwargs: Any)

Bases: Model

The deleted share to be restored.

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

Variables:

• deleted_share_name (str) – Required. Identify the name of the deleted share that will be restored. Required.

• deleted_share_version (str) – Required. Identify the version of the deleted share that will be restored. Required.

Keyword Arguments:

• deleted_share_name (str) – Required. Identify the name of the deleted share that will be restored. Required.

• deleted_share_version (str) – Required. Identify the version of the deleted share that will be restored. Required.

class azure.mgmt.storage.v2024_01_01.models.Dimension(*, name: str | None = None, display_name: str | None = None, **kwargs: Any)

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.v2024_01_01.models.DirectoryServiceOptions(*values)

Bases: str, Enum

Indicates the directory service used. Note that this enum may be extended in the future.

AADDS = 'AADDS'

AADKERB = 'AADKERB'

AD = 'AD'

NONE = 'None'

class azure.mgmt.storage.v2024_01_01.models.DnsEndpointType(*values)

Bases: str, Enum

Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier.

AZURE_DNS_ZONE = 'AzureDnsZone'

STANDARD = 'Standard'

class azure.mgmt.storage.v2024_01_01.models.EnabledProtocols(*values)

Bases: str, Enum

The authentication protocol that is used for the file share. Can only be specified when creating a share.

NFS = 'NFS'

SMB = 'SMB'

class azure.mgmt.storage.v2024_01_01.models.Encryption(*, services: _models.EncryptionServices | None = None, key_source: str | _models.KeySource = 'Microsoft.Storage', require_infrastructure_encryption: bool | None = None, key_vault_properties: _models.KeyVaultProperties | None = None, encryption_identity: _models.EncryptionIdentity | None = None, **kwargs: Any)

Bases: Model

The encryption settings on the storage account.

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

• require_infrastructure_encryption (bool) – A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.

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

• encryption_identity (EncryptionIdentity) – The identity to be used with service-side encryption at rest.

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

• require_infrastructure_encryption (bool) – A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.

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

• encryption_identity (EncryptionIdentity) – The identity to be used with service-side encryption at rest.

class azure.mgmt.storage.v2024_01_01.models.EncryptionIdentity(*, encryption_user_assigned_identity: str | None = None, encryption_federated_identity_client_id: str | None = None, **kwargs: Any)

Bases: Model

Encryption identity for the storage account.

Variables:

• encryption_user_assigned_identity (str) – Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.

• encryption_federated_identity_client_id (str) – ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account.

Keyword Arguments:

• encryption_user_assigned_identity (str) – Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account.

• encryption_federated_identity_client_id (str) – ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account.

class azure.mgmt.storage.v2024_01_01.models.EncryptionScope(*, source: str | _models.EncryptionScopeSource | None = None, state: str | _models.EncryptionScopeState | None = None, key_vault_properties: _models.EncryptionScopeKeyVaultProperties | None = None, require_infrastructure_encryption: bool | None = None, **kwargs: Any)

Bases: Resource

The Encryption Scope 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• source (str or EncryptionScopeSource) – The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. Known values are: “Microsoft.Storage” and “Microsoft.KeyVault”.

• state (str or EncryptionScopeState) – The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. Known values are: “Enabled” and “Disabled”.

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

• last_modified_time (datetime) – Gets the last modification date and time of the encryption scope in UTC.

• key_vault_properties (EncryptionScopeKeyVaultProperties) – The key vault properties for the encryption scope. This is a required field if encryption scope ‘source’ attribute is set to ‘Microsoft.KeyVault’.

• require_infrastructure_encryption (bool) – A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.

Keyword Arguments:

• source (str or EncryptionScopeSource) – The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. Known values are: “Microsoft.Storage” and “Microsoft.KeyVault”.

• state (str or EncryptionScopeState) – The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. Known values are: “Enabled” and “Disabled”.

• key_vault_properties (EncryptionScopeKeyVaultProperties) – The key vault properties for the encryption scope. This is a required field if encryption scope ‘source’ attribute is set to ‘Microsoft.KeyVault’.

• require_infrastructure_encryption (bool) – A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest.

class azure.mgmt.storage.v2024_01_01.models.EncryptionScopeKeyVaultProperties(*, key_uri: str | None = None, **kwargs: Any)

Bases: Model

The key vault properties for the encryption scope. This is a required field if encryption scope ‘source’ attribute is set to ‘Microsoft.KeyVault’.

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

Variables:

• key_uri (str) – The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

• current_versioned_key_identifier (str) – The object identifier of the current versioned Key Vault Key in use.

• last_key_rotation_timestamp (datetime) – Timestamp of last rotation of the Key Vault Key.

Keyword Arguments:

key_uri (str) – The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope.

class azure.mgmt.storage.v2024_01_01.models.EncryptionScopeListResult(**kwargs: Any)

Bases: Model

List of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes.

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

Variables:

• value (list[EncryptionScope]) – List of encryption scopes requested.

• next_link (str) – Request URL that can be used to query next page of encryption scopes. Returned when total number of requested encryption scopes exceeds the maximum page size.

class azure.mgmt.storage.v2024_01_01.models.EncryptionScopeSource(*values)

Bases: str, Enum

The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.

MICROSOFT_KEY_VAULT = 'Microsoft.KeyVault'

MICROSOFT_STORAGE = 'Microsoft.Storage'

class azure.mgmt.storage.v2024_01_01.models.EncryptionScopeState(*values)

Bases: str, Enum

The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.storage.v2024_01_01.models.EncryptionService(*, enabled: bool | None = None, key_type: str | _models.KeyType | None = None, **kwargs: Any)

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. Encryption at rest is enabled by default today and cannot be disabled.

• last_enabled_time (datetime) – Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled.

• key_type (str or KeyType) – Encryption key type to be used for the encryption service. ‘Account’ key type implies that an account-scoped encryption key will be used. ‘Service’ key type implies that a default service key is used. Known values are: “Service” and “Account”.

Keyword Arguments:

• enabled (bool) – A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled.

• key_type (str or KeyType) – Encryption key type to be used for the encryption service. ‘Account’ key type implies that an account-scoped encryption key will be used. ‘Service’ key type implies that a default service key is used. Known values are: “Service” and “Account”.

class azure.mgmt.storage.v2024_01_01.models.EncryptionServices(*, blob: _models.EncryptionService | None = None, file: _models.EncryptionService | None = None, table: _models.EncryptionService | None = None, queue: _models.EncryptionService | None = None, **kwargs: Any)

Bases: Model

A list of services that support encryption.

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.

• table (EncryptionService) – The encryption function of the table storage service.

• queue (EncryptionService) – The encryption function of the queue storage service.

class azure.mgmt.storage.v2024_01_01.models.Endpoints(*, microsoft_endpoints: _models.StorageAccountMicrosoftEndpoints | None = None, internet_endpoints: _models.StorageAccountInternetEndpoints | None = None, **kwargs: Any)

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

• microsoft_endpoints (StorageAccountMicrosoftEndpoints) – Gets the microsoft routing storage endpoints.

• internet_endpoints (StorageAccountInternetEndpoints) – Gets the internet routing storage endpoints.

Keyword Arguments:

• microsoft_endpoints (StorageAccountMicrosoftEndpoints) – Gets the microsoft routing storage endpoints.

• internet_endpoints (StorageAccountInternetEndpoints) – Gets the internet routing storage endpoints.

class azure.mgmt.storage.v2024_01_01.models.ErrorAdditionalInfo(**kwargs: Any)

Bases: Model

The resource management error additional info.

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

Variables:

• type (str) – The additional info type.

• info (JSON) – The additional info.

class azure.mgmt.storage.v2024_01_01.models.ErrorDetail(**kwargs: Any)

Bases: Model

The error detail.

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

Variables:

• code (str) – The error code.

• message (str) – The error message.

• target (str) – The error target.

• details (list[ErrorDetail]) – The error details.

• additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.storage.v2024_01_01.models.ErrorResponse(*, error: _models.ErrorResponseBody | None = None, **kwargs: Any)

Bases: Model

An error response from the storage resource provider.

Variables:

error (ErrorResponseBody) – Azure Storage Resource Provider error response body.

Keyword Arguments:

error (ErrorResponseBody) – Azure Storage Resource Provider error response body.

class azure.mgmt.storage.v2024_01_01.models.ErrorResponseAutoGenerated(*, error: _models.ErrorDetail | None = None, **kwargs: Any)

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:

error (ErrorDetail) – The error object.

Keyword Arguments:

error (ErrorDetail) – The error object.

class azure.mgmt.storage.v2024_01_01.models.ErrorResponseBody(*, code: str | None = None, message: str | None = None, **kwargs: Any)

Bases: Model

Error response body contract.

Variables:

• code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

• message (str) – A message describing the error, intended to be suitable for display in a user interface.

Keyword Arguments:

• code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

• message (str) – A message describing the error, intended to be suitable for display in a user interface.

class azure.mgmt.storage.v2024_01_01.models.ExecutionTarget(*, prefix: List[str] | None = None, exclude_prefix: List[str] | None = None, **kwargs: Any)

Bases: Model

Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task.

Variables:

• prefix (list[str]) – Required list of object prefixes to be included for task execution.

• exclude_prefix (list[str]) – List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor.

Keyword Arguments:

• prefix (list[str]) – Required list of object prefixes to be included for task execution.

• exclude_prefix (list[str]) – List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor.

class azure.mgmt.storage.v2024_01_01.models.ExecutionTrigger(*, type: str | _models.TriggerType, parameters: _models.TriggerParameters, **kwargs: Any)

Bases: Model

Execution trigger for storage task assignment.

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

Variables:

• type (str or TriggerType) – The trigger type of the storage task assignment execution. Required. Known values are: “RunOnce” and “OnSchedule”.

• parameters (TriggerParameters) – The trigger parameters of the storage task assignment execution. Required.

Keyword Arguments:

• type (str or TriggerType) – The trigger type of the storage task assignment execution. Required. Known values are: “RunOnce” and “OnSchedule”.

• parameters (TriggerParameters) – The trigger parameters of the storage task assignment execution. Required.

class azure.mgmt.storage.v2024_01_01.models.ExecutionTriggerUpdate(*, type: str | _models.TriggerType | None = None, parameters: _models.TriggerParametersUpdate | None = None, **kwargs: Any)

Bases: Model

Execution trigger update for storage task assignment.

Variables:

• type (str or TriggerType) – The trigger type of the storage task assignment execution. Known values are: “RunOnce” and “OnSchedule”.

• parameters (TriggerParametersUpdate) – The trigger parameters of the storage task assignment execution.

Keyword Arguments:

• type (str or TriggerType) – The trigger type of the storage task assignment execution. Known values are: “RunOnce” and “OnSchedule”.

• parameters (TriggerParametersUpdate) – The trigger parameters of the storage task assignment execution.

class azure.mgmt.storage.v2024_01_01.models.ExpirationAction(*values)

Bases: str, Enum

The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The ‘Log’ action can be used for audit purposes and the ‘Block’ action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period.

BLOCK = 'Block'

LOG = 'Log'

class azure.mgmt.storage.v2024_01_01.models.ExtendedLocation(*, name: str | None = None, type: str | _models.ExtendedLocationTypes | None = None, **kwargs: Any)

Bases: Model

The complex type of the extended location.

Variables:

• name (str) – The name of the extended location.

• type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

Keyword Arguments:

• name (str) – The name of the extended location.

• type (str or ExtendedLocationTypes) – The type of the extended location. “EdgeZone”

class azure.mgmt.storage.v2024_01_01.models.ExtendedLocationTypes(*values)

Bases: str, Enum

The type of extendedLocation.

EDGE_ZONE = 'EdgeZone'

class azure.mgmt.storage.v2024_01_01.models.FileServiceItems(**kwargs: Any)

Bases: Model

FileServiceItems.

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

Variables:

value (list[FileServiceProperties]) – List of file services returned.

class azure.mgmt.storage.v2024_01_01.models.FileServiceProperties(*, cors: _models.CorsRules | None = None, share_delete_retention_policy: _models.DeleteRetentionPolicy | None = None, protocol_settings: _models.ProtocolSettings | None = None, **kwargs: Any)

Bases: Resource

The properties of File services in storage account.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• sku (Sku) – Sku name and tier.

• cors (CorsRules) – Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service.

• share_delete_retention_policy (DeleteRetentionPolicy) – The file service properties for share soft delete.

• protocol_settings (ProtocolSettings) – Protocol settings for file service.

Keyword Arguments:

• cors (CorsRules) – Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service.

• share_delete_retention_policy (DeleteRetentionPolicy) – The file service properties for share soft delete.

• protocol_settings (ProtocolSettings) – Protocol settings for file service.

class azure.mgmt.storage.v2024_01_01.models.FileServiceUsage(**kwargs: Any)

Bases: Resource

The usage of file service in storage account.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• properties (FileServiceUsageProperties) – File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

class azure.mgmt.storage.v2024_01_01.models.FileServiceUsageProperties(**kwargs: Any)

Bases: Model

File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

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

Variables:

• storage_account_limits (AccountLimits) – Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account.

• file_share_limits (FileShareLimits) – Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.

• file_share_recommendations (FileShareRecommendations) – Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.

• bursting_constants (BurstingConstants) – Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account.

• storage_account_usage (AccountUsage) – Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account.

class azure.mgmt.storage.v2024_01_01.models.FileServiceUsages(**kwargs: Any)

Bases: Model

List file service usages schema.

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

Variables:

• value (list[FileServiceUsage]) – List of file service usages returned.

• next_link (str) – Request URL that can be used to query next page of file service usages. Returned when total number of requested file service usages exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.FileShare(*, metadata: Dict[str, str] | None = None, share_quota: int | None = None, provisioned_iops: int | None = None, provisioned_bandwidth_mibps: int | None = None, enabled_protocols: str | _models.EnabledProtocols | None = None, root_squash: str | _models.RootSquashType | None = None, access_tier: str | _models.ShareAccessTier | None = None, signed_identifiers: List[_models.SignedIdentifier] | None = None, file_share_paid_bursting: _models.FileSharePropertiesFileSharePaidBursting | None = None, **kwargs: Any)

Bases: AzureEntityResource

Properties of the file share, 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

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

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

• share_quota (int) – The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.

• provisioned_iops (int) – The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.

• provisioned_bandwidth_mibps (int) – The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.

• included_burst_iops (int) – The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.

• max_burst_credits_for_iops (int) – The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.

• next_allowed_quota_downgrade_time (datetime) – Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type.

• next_allowed_provisioned_iops_downgrade_time (datetime) – Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

• next_allowed_provisioned_bandwidth_downgrade_time (datetime) – Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

• enabled_protocols (str or EnabledProtocols) – The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: “SMB” and “NFS”.

• root_squash (str or RootSquashType) – The property is for NFS share only. The default is NoRootSquash. Known values are: “NoRootSquash”, “RootSquash”, and “AllSquash”.

• version (str) – The version of the share.

• deleted (bool) – Indicates whether the share was deleted.

• deleted_time (datetime) – The deleted time if the share was deleted.

• remaining_retention_days (int) – Remaining retention days for share that was soft deleted.

• access_tier (str or ShareAccessTier) – Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: “TransactionOptimized”, “Hot”, “Cool”, and “Premium”.

• access_tier_change_time (datetime) – Indicates the last modification time for share access tier.

• access_tier_status (str) – Indicates if there is a pending transition for access tier.

• share_usage_bytes (int) – The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.

• lease_status (str or LeaseStatus) – The lease status of the share. Known values are: “Locked” and “Unlocked”.

• lease_state (str or LeaseState) – Lease state of the share. Known values are: “Available”, “Leased”, “Expired”, “Breaking”, and “Broken”.

• lease_duration (str or LeaseDuration) – Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. Known values are: “Infinite” and “Fixed”.

• signed_identifiers (list[SignedIdentifier]) – List of stored access policies specified on the share.

• snapshot_time (datetime) – Creation time of share snapshot returned in the response of list shares with expand param “snapshots”.

• file_share_paid_bursting (FileSharePropertiesFileSharePaidBursting) – File Share Paid Bursting properties.

Keyword Arguments:

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

• share_quota (int) – The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.

• provisioned_iops (int) – The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.

• provisioned_bandwidth_mibps (int) – The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.

• enabled_protocols (str or EnabledProtocols) – The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: “SMB” and “NFS”.

• root_squash (str or RootSquashType) – The property is for NFS share only. The default is NoRootSquash. Known values are: “NoRootSquash”, “RootSquash”, and “AllSquash”.

• access_tier (str or ShareAccessTier) – Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: “TransactionOptimized”, “Hot”, “Cool”, and “Premium”.

• signed_identifiers (list[SignedIdentifier]) – List of stored access policies specified on the share.

• file_share_paid_bursting (FileSharePropertiesFileSharePaidBursting) – File Share Paid Bursting properties.

class azure.mgmt.storage.v2024_01_01.models.FileShareItem(*, metadata: Dict[str, str] | None = None, share_quota: int | None = None, provisioned_iops: int | None = None, provisioned_bandwidth_mibps: int | None = None, enabled_protocols: str | _models.EnabledProtocols | None = None, root_squash: str | _models.RootSquashType | None = None, access_tier: str | _models.ShareAccessTier | None = None, signed_identifiers: List[_models.SignedIdentifier] | None = None, file_share_paid_bursting: _models.FileSharePropertiesFileSharePaidBursting | None = None, **kwargs: Any)

Bases: AzureEntityResource

The file share 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

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

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

• share_quota (int) – The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.

• provisioned_iops (int) – The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.

• provisioned_bandwidth_mibps (int) – The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.

• included_burst_iops (int) – The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.

• max_burst_credits_for_iops (int) – The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.

• next_allowed_quota_downgrade_time (datetime) – Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type.

• next_allowed_provisioned_iops_downgrade_time (datetime) – Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

• next_allowed_provisioned_bandwidth_downgrade_time (datetime) – Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

• enabled_protocols (str or EnabledProtocols) – The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: “SMB” and “NFS”.

• root_squash (str or RootSquashType) – The property is for NFS share only. The default is NoRootSquash. Known values are: “NoRootSquash”, “RootSquash”, and “AllSquash”.

• version (str) – The version of the share.

• deleted (bool) – Indicates whether the share was deleted.

• deleted_time (datetime) – The deleted time if the share was deleted.

• remaining_retention_days (int) – Remaining retention days for share that was soft deleted.

• access_tier (str or ShareAccessTier) – Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: “TransactionOptimized”, “Hot”, “Cool”, and “Premium”.

• access_tier_change_time (datetime) – Indicates the last modification time for share access tier.

• access_tier_status (str) – Indicates if there is a pending transition for access tier.

• share_usage_bytes (int) – The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.

• lease_status (str or LeaseStatus) – The lease status of the share. Known values are: “Locked” and “Unlocked”.

• lease_state (str or LeaseState) – Lease state of the share. Known values are: “Available”, “Leased”, “Expired”, “Breaking”, and “Broken”.

• lease_duration (str or LeaseDuration) – Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. Known values are: “Infinite” and “Fixed”.

• signed_identifiers (list[SignedIdentifier]) – List of stored access policies specified on the share.

• snapshot_time (datetime) – Creation time of share snapshot returned in the response of list shares with expand param “snapshots”.

• file_share_paid_bursting (FileSharePropertiesFileSharePaidBursting) – File Share Paid Bursting properties.

Keyword Arguments:

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

• share_quota (int) – The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.

• provisioned_iops (int) – The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.

• provisioned_bandwidth_mibps (int) – The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.

• enabled_protocols (str or EnabledProtocols) – The authentication protocol that is used for the file share. Can only be specified when creating a share. Known values are: “SMB” and “NFS”.

• root_squash (str or RootSquashType) – The property is for NFS share only. The default is NoRootSquash. Known values are: “NoRootSquash”, “RootSquash”, and “AllSquash”.

• access_tier (str or ShareAccessTier) – Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Known values are: “TransactionOptimized”, “Hot”, “Cool”, and “Premium”.

• signed_identifiers (list[SignedIdentifier]) – List of stored access policies specified on the share.

• file_share_paid_bursting (FileSharePropertiesFileSharePaidBursting) – File Share Paid Bursting properties.

class azure.mgmt.storage.v2024_01_01.models.FileShareItems(**kwargs: Any)

Bases: Model

Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares.

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

Variables:

• value (list[FileShareItem]) – List of file shares returned.

• next_link (str) – Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.FileShareLimits(**kwargs: Any)

Bases: Model

Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account.

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

Variables:

• min_provisioned_storage_gi_b (int) – The minimum provisioned storage quota limit in gibibytes for a file share in the storage account.

• max_provisioned_storage_gi_b (int) – The maximum provisioned storage quota limit in gibibytes for a file share in the storage account.

• min_provisioned_iops (int) – The minimum provisioned IOPS limit for a file share in the storage account.

• max_provisioned_iops (int) – The maximum provisioned IOPS limit for a file share in the storage account.

• min_provisioned_bandwidth_mi_b_per_sec (int) – The minimum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.

• max_provisioned_bandwidth_mi_b_per_sec (int) – The maximum provisioned bandwidth limit in mebibytes per second for a file share in the storage account.

class azure.mgmt.storage.v2024_01_01.models.FileSharePropertiesFileSharePaidBursting(*, paid_bursting_enabled: bool | None = None, paid_bursting_max_iops: int | None = None, paid_bursting_max_bandwidth_mibps: int | None = None, **kwargs: Any)

Bases: Model

File Share Paid Bursting properties.

Variables:

• paid_bursting_enabled (bool) – Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.

• paid_bursting_max_iops (int) – The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.

• paid_bursting_max_bandwidth_mibps (int) – The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.

Keyword Arguments:

• paid_bursting_enabled (bool) – Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.

• paid_bursting_max_iops (int) – The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.

• paid_bursting_max_bandwidth_mibps (int) – The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.

class azure.mgmt.storage.v2024_01_01.models.FileShareRecommendations(**kwargs: Any)

Bases: Model

Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account.

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

Variables:

• base_iops (int) – The base IOPS in the file share provisioned IOPS recommendation formula.

• io_scalar (float) – The scalar for IO in the file share provisioned IOPS recommendation formula.

• base_bandwidth_mi_b_per_sec (int) – The base bandwidth in the file share provisioned bandwidth recommendation formula.

• bandwidth_scalar (float) – The scalar for bandwidth in the file share provisioned bandwidth recommendation formula.

class azure.mgmt.storage.v2024_01_01.models.Format(*values)

Bases: str, Enum

This is a required field, it specifies the format for the inventory files.

CSV = 'Csv'

PARQUET = 'Parquet'

class azure.mgmt.storage.v2024_01_01.models.GeoReplicationStats(**kwargs: Any)

Bases: Model

Statistics related to replication for storage account’s Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account.

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

Variables:

• status (str or GeoReplicationStatus) – The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. Known values are: “Live”, “Bootstrap”, and “Unavailable”.

• last_sync_time (datetime) – All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap.

• can_failover (bool) – A boolean flag which indicates whether or not account failover is supported for the account.

• can_planned_failover (bool) – A boolean flag which indicates whether or not planned account failover is supported for the account.

• post_failover_redundancy (str or PostFailoverRedundancy) – The redundancy type of the account after an account failover is performed. Known values are: “Standard_LRS” and “Standard_ZRS”.

• post_planned_failover_redundancy (str or PostPlannedFailoverRedundancy) – The redundancy type of the account after a planned account failover is performed. Known values are: “Standard_GRS”, “Standard_GZRS”, “Standard_RAGRS”, and “Standard_RAGZRS”.

class azure.mgmt.storage.v2024_01_01.models.GeoReplicationStatus(*values)

Bases: str, Enum

The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable.

BOOTSTRAP = 'Bootstrap'

LIVE = 'Live'

UNAVAILABLE = 'Unavailable'

class azure.mgmt.storage.v2024_01_01.models.HttpProtocol(*values)

Bases: str, Enum

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

HTTPS = 'https'

HTTPS_HTTP = 'https,http'

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

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.v2024_01_01.models.Identity(*, type: str | _models.IdentityType, user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, **kwargs: Any)

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 or IdentityType) – The identity type. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

• user_assigned_identities (dict[str, UserAssignedIdentity]) – Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.

Keyword Arguments:

• type (str or IdentityType) – The identity type. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

• user_assigned_identities (dict[str, UserAssignedIdentity]) – Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.

class azure.mgmt.storage.v2024_01_01.models.IdentityType(*values)

Bases: str, Enum

The identity type.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.storage.v2024_01_01.models.ImmutabilityPolicy(*, immutability_period_since_creation_in_days: int | None = None, allow_protected_append_writes: bool | None = None, allow_protected_append_writes_all: bool | None = None, **kwargs: Any)

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

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

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

• state (str or ImmutabilityPolicyState) – The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Known values are: “Locked” and “Unlocked”.

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

Keyword Arguments:

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

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

class azure.mgmt.storage.v2024_01_01.models.ImmutabilityPolicyProperties(*, immutability_period_since_creation_in_days: int | None = None, allow_protected_append_writes: bool | None = None, allow_protected_append_writes_all: bool | None = None, **kwargs: Any)

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

Variables:

• etag (str) – ImmutabilityPolicy Etag.

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

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

• state (str or ImmutabilityPolicyState) – The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. Known values are: “Locked” and “Unlocked”.

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

Keyword Arguments:

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

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

class azure.mgmt.storage.v2024_01_01.models.ImmutabilityPolicyState(*values)

Bases: str, Enum

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.

LOCKED = 'Locked'

UNLOCKED = 'Unlocked'

class azure.mgmt.storage.v2024_01_01.models.ImmutabilityPolicyUpdateType(*values)

Bases: str, Enum

The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.

EXTEND = 'extend'

LOCK = 'lock'

PUT = 'put'

class azure.mgmt.storage.v2024_01_01.models.ImmutableStorageAccount(*, enabled: bool | None = None, immutability_policy: _models.AccountImmutabilityPolicyProperties | None = None, **kwargs: Any)

Bases: Model

This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning.

Variables:

• enabled (bool) – A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default.

• immutability_policy (AccountImmutabilityPolicyProperties) – Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy.

Keyword Arguments:

• enabled (bool) – A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default.

• immutability_policy (AccountImmutabilityPolicyProperties) – Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy.

class azure.mgmt.storage.v2024_01_01.models.ImmutableStorageWithVersioning(*, enabled: bool | None = None, **kwargs: Any)

Bases: Model

Object level immutability properties of the container.

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

Variables:

• enabled (bool) – This is an immutable property, when set to true it enables object level immutability at the container level.

• time_stamp (datetime) – Returns the date and time the object level immutability was enabled.

• migration_state (str or MigrationState) – This property denotes the container level immutability to object level immutability migration state. Known values are: “InProgress” and “Completed”.

Keyword Arguments:

enabled (bool) – This is an immutable property, when set to true it enables object level immutability at the container level.

class azure.mgmt.storage.v2024_01_01.models.InventoryRuleType(*values)

Bases: str, Enum

The valid value is Inventory.

INVENTORY = 'Inventory'

class azure.mgmt.storage.v2024_01_01.models.IssueType(*values)

Bases: str, Enum

Type of issue.

CONFIGURATION_PROPAGATION_FAILURE = 'ConfigurationPropagationFailure'

UNKNOWN = 'Unknown'

class azure.mgmt.storage.v2024_01_01.models.KeyCreationTime(*, key1: datetime | None = None, key2: datetime | None = None, **kwargs: Any)

Bases: Model

Storage account keys creation time.

Variables:

• key1 (datetime)

• key2 (datetime)

Keyword Arguments:

• key1 (datetime)

• key2 (datetime)

class azure.mgmt.storage.v2024_01_01.models.KeyPermission(*values)

Bases: str, Enum

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

FULL = 'Full'

READ = 'Read'

class azure.mgmt.storage.v2024_01_01.models.KeyPolicy(*, key_expiration_period_in_days: int, **kwargs: Any)

Bases: Model

KeyPolicy assigned to the storage account.

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

Variables:

key_expiration_period_in_days (int) – The key expiration period in days. Required.

Keyword Arguments:

key_expiration_period_in_days (int) – The key expiration period in days. Required.

class azure.mgmt.storage.v2024_01_01.models.KeySource(*values)

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.v2024_01_01.models.KeyType(*values)

Bases: str, Enum

Encryption key type to be used for the encryption service. ‘Account’ key type implies that an account-scoped encryption key will be used. ‘Service’ key type implies that a default service key is used.

ACCOUNT = 'Account'

SERVICE = 'Service'

class azure.mgmt.storage.v2024_01_01.models.KeyVaultProperties(*, key_name: str | None = None, key_version: str | None = None, key_vault_uri: str | None = None, **kwargs: Any)

Bases: Model

Properties of key vault.

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

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.

• current_versioned_key_identifier (str) – The object identifier of the current versioned Key Vault Key in use.

• last_key_rotation_timestamp (datetime) – Timestamp of last rotation of the Key Vault Key.

• current_versioned_key_expiration_timestamp (datetime) – This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption.

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.v2024_01_01.models.Kind(*values)

Bases: str, Enum

Indicates the type of storage account.

BLOB_STORAGE = 'BlobStorage'

BLOCK_BLOB_STORAGE = 'BlockBlobStorage'

FILE_STORAGE = 'FileStorage'

STORAGE = 'Storage'

STORAGE_V2 = 'StorageV2'

class azure.mgmt.storage.v2024_01_01.models.LargeFileSharesState(*values)

Bases: str, Enum

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.storage.v2024_01_01.models.LastAccessTimeTrackingPolicy(*, enable: bool, name: str | _models.Name | None = None, tracking_granularity_in_days: int | None = None, blob_type: List[str] | None = None, **kwargs: Any)

Bases: Model

The blob service properties for Last access time based tracking policy.

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

Variables:

• enable (bool) – When set to true last access time based tracking is enabled. Required.

• name (str or Name) – Name of the policy. The valid value is AccessTimeTracking. This field is currently read only. “AccessTimeTracking”

• tracking_granularity_in_days (int) – The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1.

• blob_type (list[str]) – An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only.

Keyword Arguments:

• enable (bool) – When set to true last access time based tracking is enabled. Required.

• name (str or Name) – Name of the policy. The valid value is AccessTimeTracking. This field is currently read only. “AccessTimeTracking”

• tracking_granularity_in_days (int) – The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1.

• blob_type (list[str]) – An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only.

class azure.mgmt.storage.v2024_01_01.models.LeaseContainerRequest(*, action: str | _models.LeaseContainerRequestEnum, lease_id: str | None = None, break_period: int | None = None, lease_duration: int | None = None, proposed_lease_id: str | None = None, **kwargs: Any)

Bases: Model

Lease Container request schema.

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

Variables:

• action (str or LeaseContainerRequestEnum) – Specifies the lease action. Can be one of the available actions. Required. Known values are: “Acquire”, “Renew”, “Change”, “Release”, “Break”, and “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.

Keyword Arguments:

• action (str or LeaseContainerRequestEnum) – Specifies the lease action. Can be one of the available actions. Required. Known values are: “Acquire”, “Renew”, “Change”, “Release”, “Break”, and “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.v2024_01_01.models.LeaseContainerRequestEnum(*values)

Bases: str, Enum

Specifies the lease action. Can be one of the available actions.

ACQUIRE = 'Acquire'

BREAK = 'Break'

BREAK_ENUM = 'Break'

CHANGE = 'Change'

RELEASE = 'Release'

RENEW = 'Renew'

class azure.mgmt.storage.v2024_01_01.models.LeaseContainerResponse(*, lease_id: str | None = None, lease_time_seconds: str | None = None, **kwargs: Any)

Bases: Model

Lease Container response schema.

Variables:

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

Keyword Arguments:

• 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.v2024_01_01.models.LeaseDuration(*values)

Bases: str, Enum

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.

FIXED = 'Fixed'

INFINITE = 'Infinite'

class azure.mgmt.storage.v2024_01_01.models.LeaseShareAction(*values)

Bases: str, Enum

Specifies the lease action. Can be one of the available actions.

ACQUIRE = 'Acquire'

BREAK = 'Break'

BREAK_ENUM = 'Break'

CHANGE = 'Change'

RELEASE = 'Release'

RENEW = 'Renew'

class azure.mgmt.storage.v2024_01_01.models.LeaseShareRequest(*, action: str | _models.LeaseShareAction, lease_id: str | None = None, break_period: int | None = None, lease_duration: int | None = None, proposed_lease_id: str | None = None, **kwargs: Any)

Bases: Model

Lease Share request schema.

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

Variables:

• action (str or LeaseShareAction) – Specifies the lease action. Can be one of the available actions. Required. Known values are: “Acquire”, “Renew”, “Change”, “Release”, “Break”, and “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.

Keyword Arguments:

• action (str or LeaseShareAction) – Specifies the lease action. Can be one of the available actions. Required. Known values are: “Acquire”, “Renew”, “Change”, “Release”, “Break”, and “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.v2024_01_01.models.LeaseShareResponse(*, lease_id: str | None = None, lease_time_seconds: str | None = None, **kwargs: Any)

Bases: Model

Lease Share response schema.

Variables:

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

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

Keyword Arguments:

• lease_id (str) – Returned unique lease ID that must be included with any request to delete the share, 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.v2024_01_01.models.LeaseState(*values)

Bases: str, Enum

Lease state of the container.

AVAILABLE = 'Available'

BREAKING = 'Breaking'

BROKEN = 'Broken'

EXPIRED = 'Expired'

LEASED = 'Leased'

class azure.mgmt.storage.v2024_01_01.models.LeaseStatus(*values)

Bases: str, Enum

The lease status of the container.

LOCKED = 'Locked'

UNLOCKED = 'Unlocked'

class azure.mgmt.storage.v2024_01_01.models.LegalHold(*, tags: List[str], allow_protected_append_writes_all: bool | None = None, **kwargs: Any)

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

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.

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

• allow_protected_append_writes_all (bool) – When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

Keyword Arguments:

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

• allow_protected_append_writes_all (bool) – When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

class azure.mgmt.storage.v2024_01_01.models.LegalHoldProperties(*, tags: List[_models.TagProperty] | None = None, protected_append_writes_history: _models.ProtectedAppendWritesHistory | None = None, **kwargs: Any)

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

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

• protected_append_writes_history (ProtectedAppendWritesHistory) – Protected append blob writes history.

Keyword Arguments:

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

• protected_append_writes_history (ProtectedAppendWritesHistory) – Protected append blob writes history.

class azure.mgmt.storage.v2024_01_01.models.ListAccountSasResponse(**kwargs: Any)

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.v2024_01_01.models.ListBlobInventoryPolicy(**kwargs: Any)

Bases: Model

List of blob inventory policies returned.

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

Variables:

value (list[BlobInventoryPolicy]) – List of blob inventory policies.

class azure.mgmt.storage.v2024_01_01.models.ListContainerItem(*, default_encryption_scope: str | None = None, deny_encryption_scope_override: bool | None = None, public_access: str | _models.PublicAccess | None = None, metadata: Dict[str, str] | None = None, immutable_storage_with_versioning: _models.ImmutableStorageWithVersioning | None = None, enable_nfs_v3_root_squash: bool | None = None, enable_nfs_v3_all_squash: bool | None = None, **kwargs: Any)

Bases: 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• etag (str) – Resource Etag.

• version (str) – The version of the deleted blob container.

• deleted (bool) – Indicates whether the blob container was deleted.

• deleted_time (datetime) – Blob container deletion time.

• remaining_retention_days (int) – Remaining retention days for soft deleted blob container.

• default_encryption_scope (str) – Default the container to use specified encryption scope for all writes.

• deny_encryption_scope_override (bool) – Block override of encryption scope from the container default.

• public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Known values are: “Container”, “Blob”, and “None”.

• 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. Known values are: “Locked” and “Unlocked”.

• lease_state (str or LeaseState) – Lease state of the container. Known values are: “Available”, “Leased”, “Expired”, “Breaking”, and “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. Known values are: “Infinite” and “Fixed”.

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

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

• immutable_storage_with_versioning (ImmutableStorageWithVersioning) – The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.

• enable_nfs_v3_root_squash (bool) – Enable NFSv3 root squash on blob container.

• enable_nfs_v3_all_squash (bool) – Enable NFSv3 all squash on blob container.

Keyword Arguments:

• default_encryption_scope (str) – Default the container to use specified encryption scope for all writes.

• deny_encryption_scope_override (bool) – Block override of encryption scope from the container default.

• public_access (str or PublicAccess) – Specifies whether data in the container may be accessed publicly and the level of access. Known values are: “Container”, “Blob”, and “None”.

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

• immutable_storage_with_versioning (ImmutableStorageWithVersioning) – The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process.

• enable_nfs_v3_root_squash (bool) – Enable NFSv3 root squash on blob container.

• enable_nfs_v3_all_squash (bool) – Enable NFSv3 all squash on blob container.

class azure.mgmt.storage.v2024_01_01.models.ListContainerItems(**kwargs: Any)

Bases: Model

Response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers.

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

Variables:

• value (list[ListContainerItem]) – List of blobs containers returned.

• next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.ListContainersInclude(*values)

Bases: str, Enum

ListContainersInclude.

DELETED = 'deleted'

class azure.mgmt.storage.v2024_01_01.models.ListEncryptionScopesInclude(*values)

Bases: str, Enum

ListEncryptionScopesInclude.

ALL = 'All'

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.storage.v2024_01_01.models.ListLocalUserIncludeParam(*values)

Bases: str, Enum

ListLocalUserIncludeParam.

NFSV3 = 'nfsv3'

class azure.mgmt.storage.v2024_01_01.models.ListQueue(*, metadata: Dict[str, str] | None = None, **kwargs: Any)

Bases: Resource

ListQueue.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• metadata (dict[str, str]) – A name-value pair that represents queue metadata.

Keyword Arguments:

metadata (dict[str, str]) – A name-value pair that represents queue metadata.

class azure.mgmt.storage.v2024_01_01.models.ListQueueResource(**kwargs: Any)

Bases: Model

Response schema. Contains list of queues returned.

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

Variables:

• value (list[ListQueue]) – List of queues returned.

• next_link (str) – Request URL that can be used to list next page of queues.

class azure.mgmt.storage.v2024_01_01.models.ListQueueServices(**kwargs: Any)

Bases: Model

ListQueueServices.

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

Variables:

value (list[QueueServiceProperties]) – List of queue services returned.

class azure.mgmt.storage.v2024_01_01.models.ListServiceSasResponse(**kwargs: Any)

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.v2024_01_01.models.ListTableResource(**kwargs: Any)

Bases: Model

Response schema. Contains list of tables returned.

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

Variables:

• value (list[Table]) – List of tables returned.

• next_link (str) – Request URL that can be used to query next page of tables.

class azure.mgmt.storage.v2024_01_01.models.ListTableServices(**kwargs: Any)

Bases: Model

ListTableServices.

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

Variables:

value (list[TableServiceProperties]) – List of table services returned.

class azure.mgmt.storage.v2024_01_01.models.LocalUser(*, permission_scopes: List[_models.PermissionScope] | None = None, home_directory: str | None = None, ssh_authorized_keys: List[_models.SshPublicKey] | None = None, has_shared_key: bool | None = None, has_ssh_key: bool | None = None, has_ssh_password: bool | None = None, group_id: int | None = None, allow_acl_authorization: bool | None = None, extended_groups: List[int] | None = None, is_nf_sv3_enabled: bool | None = None, **kwargs: Any)

Bases: Resource

The local user associated with the storage accounts.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

• permission_scopes (list[PermissionScope]) – The permission scopes of the local user.

• home_directory (str) – Optional, local user home directory.

• ssh_authorized_keys (list[SshPublicKey]) – Optional, local user ssh authorized keys for SFTP.

• sid (str) – A unique Security Identifier that is generated by the server.

• has_shared_key (bool) – Indicates whether shared key exists. Set it to false to remove existing shared key.

• has_ssh_key (bool) – Indicates whether ssh key exists. Set it to false to remove existing SSH key.

• has_ssh_password (bool) – Indicates whether ssh password exists. Set it to false to remove existing SSH password.

• user_id (int) – A unique Identifier that is generated by the server.

• group_id (int) – An identifier for associating a group of users.

• allow_acl_authorization (bool) – Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.

• extended_groups (list[int]) – Supplementary group membership. Only applicable for local users enabled for NFSv3 access.

• is_nf_sv3_enabled (bool) – Indicates if the local user is enabled for access with NFSv3 protocol.

Keyword Arguments:

• permission_scopes (list[PermissionScope]) – The permission scopes of the local user.

• home_directory (str) – Optional, local user home directory.

• ssh_authorized_keys (list[SshPublicKey]) – Optional, local user ssh authorized keys for SFTP.

• has_shared_key (bool) – Indicates whether shared key exists. Set it to false to remove existing shared key.

• has_ssh_key (bool) – Indicates whether ssh key exists. Set it to false to remove existing SSH key.

• has_ssh_password (bool) – Indicates whether ssh password exists. Set it to false to remove existing SSH password.

• group_id (int) – An identifier for associating a group of users.

• allow_acl_authorization (bool) – Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.

• extended_groups (list[int]) – Supplementary group membership. Only applicable for local users enabled for NFSv3 access.

• is_nf_sv3_enabled (bool) – Indicates if the local user is enabled for access with NFSv3 protocol.

class azure.mgmt.storage.v2024_01_01.models.LocalUserKeys(*, ssh_authorized_keys: List[_models.SshPublicKey] | None = None, **kwargs: Any)

Bases: Model

The Storage Account Local User keys.

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

Variables:

• ssh_authorized_keys (list[SshPublicKey]) – Optional, local user ssh authorized keys for SFTP.

• shared_key (str) – Auto generated by the server for SMB authentication.

Keyword Arguments:

ssh_authorized_keys (list[SshPublicKey]) – Optional, local user ssh authorized keys for SFTP.

class azure.mgmt.storage.v2024_01_01.models.LocalUserRegeneratePasswordResult(**kwargs: Any)

Bases: Model

The secrets of Storage Account Local User.

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

Variables:

ssh_password (str) – Auto generated password by the server for SSH authentication if hasSshPassword is set to true on the creation of local user.

class azure.mgmt.storage.v2024_01_01.models.LocalUsers(*, value: List[_models.LocalUser] | None = None, **kwargs: Any)

Bases: Model

List of local users requested, and if paging is required, a URL to the next page of local users.

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

Variables:

• value (list[LocalUser]) – The list of local users associated with the storage account.

• next_link (str) – Request URL that can be used to query next page of local users. Returned when total number of requested local users exceeds the maximum page size.

Keyword Arguments:

value (list[LocalUser]) – The list of local users associated with the storage account.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicy(*, policy: _models.ManagementPolicySchema | None = None, **kwargs: Any)

Bases: Resource

The Get Storage Account ManagementPolicies operation response.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

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

• policy (ManagementPolicySchema) – The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

Keyword Arguments:

policy (ManagementPolicySchema) – The Storage Account ManagementPolicy, in JSON format. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyAction(*, base_blob: _models.ManagementPolicyBaseBlob | None = None, snapshot: _models.ManagementPolicySnapShot | None = None, version: _models.ManagementPolicyVersion | None = None, **kwargs: Any)

Bases: Model

Actions are applied to the filtered blobs when the execution condition is met.

Variables:

• base_blob (ManagementPolicyBaseBlob) – The management policy action for base blob.

• snapshot (ManagementPolicySnapShot) – The management policy action for snapshot.

• version (ManagementPolicyVersion) – The management policy action for version.

Keyword Arguments:

• base_blob (ManagementPolicyBaseBlob) – The management policy action for base blob.

• snapshot (ManagementPolicySnapShot) – The management policy action for snapshot.

• version (ManagementPolicyVersion) – The management policy action for version.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyBaseBlob(*, tier_to_cool: _models.DateAfterModification | None = None, tier_to_archive: _models.DateAfterModification | None = None, tier_to_cold: _models.DateAfterModification | None = None, tier_to_hot: _models.DateAfterModification | None = None, delete: _models.DateAfterModification | None = None, enable_auto_tier_to_hot_from_cool: bool | None = None, **kwargs: Any)

Bases: Model

Management policy action for base blob.

Variables:

• tier_to_cool (DateAfterModification) – The function to tier blobs to cool storage.

• tier_to_archive (DateAfterModification) – The function to tier blobs to archive storage.

• tier_to_cold (DateAfterModification) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterModification) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterModification) – The function to delete the blob.

• enable_auto_tier_to_hot_from_cool (bool) – This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan.

Keyword Arguments:

• tier_to_cool (DateAfterModification) – The function to tier blobs to cool storage.

• tier_to_archive (DateAfterModification) – The function to tier blobs to archive storage.

• tier_to_cold (DateAfterModification) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterModification) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterModification) – The function to delete the blob.

• enable_auto_tier_to_hot_from_cool (bool) – This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyDefinition(*, actions: _models.ManagementPolicyAction, filters: _models.ManagementPolicyFilter | None = None, **kwargs: Any)

Bases: Model

An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.

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

Variables:

• actions (ManagementPolicyAction) – An object that defines the action set. Required.

• filters (ManagementPolicyFilter) – An object that defines the filter set.

Keyword Arguments:

• actions (ManagementPolicyAction) – An object that defines the action set. Required.

• filters (ManagementPolicyFilter) – An object that defines the filter set.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyFilter(*, blob_types: List[str], prefix_match: List[str] | None = None, blob_index_match: List[_models.TagFilter] | None = None, **kwargs: Any)

Bases: Model

Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters.

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

Variables:

• prefix_match (list[str]) – An array of strings for prefixes to be match.

• blob_types (list[str]) – An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. Required.

• blob_index_match (list[TagFilter]) – An array of blob index tag based filters, there can be at most 10 tag filters.

Keyword Arguments:

• prefix_match (list[str]) – An array of strings for prefixes to be match.

• blob_types (list[str]) – An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. Required.

• blob_index_match (list[TagFilter]) – An array of blob index tag based filters, there can be at most 10 tag filters.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyName(*values)

Bases: str, Enum

ManagementPolicyName.

DEFAULT = 'default'

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyRule(*, name: str, type: str | _models.RuleType, definition: _models.ManagementPolicyDefinition, enabled: bool | None = None, **kwargs: Any)

Bases: Model

An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.

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

Variables:

• enabled (bool) – Rule is enabled if set to true.

• name (str) – A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. Required.

• type (str or RuleType) – The valid value is Lifecycle. Required. “Lifecycle”

• definition (ManagementPolicyDefinition) – An object that defines the Lifecycle rule. Required.

Keyword Arguments:

• enabled (bool) – Rule is enabled if set to true.

• name (str) – A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. Required.

• type (str or RuleType) – The valid value is Lifecycle. Required. “Lifecycle”

• definition (ManagementPolicyDefinition) – An object that defines the Lifecycle rule. Required.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicySchema(*, rules: List[_models.ManagementPolicyRule], **kwargs: Any)

Bases: Model

The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

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

Variables:

rules (list[ManagementPolicyRule]) – The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. Required.

Keyword Arguments:

rules (list[ManagementPolicyRule]) – The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. Required.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicySnapShot(*, tier_to_cool: _models.DateAfterCreation | None = None, tier_to_archive: _models.DateAfterCreation | None = None, tier_to_cold: _models.DateAfterCreation | None = None, tier_to_hot: _models.DateAfterCreation | None = None, delete: _models.DateAfterCreation | None = None, **kwargs: Any)

Bases: Model

Management policy action for snapshot.

Variables:

• tier_to_cool (DateAfterCreation) – The function to tier blob snapshot to cool storage.

• tier_to_archive (DateAfterCreation) – The function to tier blob snapshot to archive storage.

• tier_to_cold (DateAfterCreation) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterCreation) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterCreation) – The function to delete the blob snapshot.

Keyword Arguments:

• tier_to_cool (DateAfterCreation) – The function to tier blob snapshot to cool storage.

• tier_to_archive (DateAfterCreation) – The function to tier blob snapshot to archive storage.

• tier_to_cold (DateAfterCreation) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterCreation) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterCreation) – The function to delete the blob snapshot.

class azure.mgmt.storage.v2024_01_01.models.ManagementPolicyVersion(*, tier_to_cool: _models.DateAfterCreation | None = None, tier_to_archive: _models.DateAfterCreation | None = None, tier_to_cold: _models.DateAfterCreation | None = None, tier_to_hot: _models.DateAfterCreation | None = None, delete: _models.DateAfterCreation | None = None, **kwargs: Any)

Bases: Model

Management policy action for blob version.

Variables:

• tier_to_cool (DateAfterCreation) – The function to tier blob version to cool storage.

• tier_to_archive (DateAfterCreation) – The function to tier blob version to archive storage.

• tier_to_cold (DateAfterCreation) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterCreation) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterCreation) – The function to delete the blob version.

Keyword Arguments:

• tier_to_cool (DateAfterCreation) – The function to tier blob version to cool storage.

• tier_to_archive (DateAfterCreation) – The function to tier blob version to archive storage.

• tier_to_cold (DateAfterCreation) – The function to tier blobs to cold storage.

• tier_to_hot (DateAfterCreation) – The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts.

• delete (DateAfterCreation) – The function to delete the blob version.

class azure.mgmt.storage.v2024_01_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)

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.v2024_01_01.models.MigrationName(*values)

Bases: str, Enum

MigrationName.

DEFAULT = 'default'

class azure.mgmt.storage.v2024_01_01.models.MigrationState(*values)

Bases: str, Enum

This property denotes the container level immutability to object level immutability migration state.

COMPLETED = 'Completed'

IN_PROGRESS = 'InProgress'

class azure.mgmt.storage.v2024_01_01.models.MigrationStatus(*values)

Bases: str, Enum

Current status of migration.

COMPLETE = 'Complete'

FAILED = 'Failed'

INVALID = 'Invalid'

IN_PROGRESS = 'InProgress'

SUBMITTED_FOR_CONVERSION = 'SubmittedForConversion'

class azure.mgmt.storage.v2024_01_01.models.MinimumTlsVersion(*values)

Bases: str, Enum

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.

TLS1_0 = 'TLS1_0'

TLS1_1 = 'TLS1_1'

TLS1_2 = 'TLS1_2'

TLS1_3 = 'TLS1_3'

class azure.mgmt.storage.v2024_01_01.models.Multichannel(*, enabled: bool | None = None, **kwargs: Any)

Bases: Model

Multichannel setting. Applies to Premium FileStorage only.

Variables:

enabled (bool) – Indicates whether multichannel is enabled.

Keyword Arguments:

enabled (bool) – Indicates whether multichannel is enabled.

class azure.mgmt.storage.v2024_01_01.models.Name(*values)

Bases: str, Enum

Name of the policy. The valid value is AccessTimeTracking. This field is currently read only.

ACCESS_TIME_TRACKING = 'AccessTimeTracking'

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

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

• resource_access_rules (list[ResourceAccessRule]) – Sets the resource access rules.

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

• resource_access_rules (list[ResourceAccessRule]) – Sets the resource access rules.

• 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.v2024_01_01.models.NetworkSecurityPerimeter(*, id: str | None = None, perimeter_guid: str | None = None, location: str | None = None, **kwargs: Any)

Bases: Model

NetworkSecurityPerimeter related information.

Variables:

• id (str) – The ARM identifier of the resource.

• perimeter_guid (str) – Guid of the resource.

• location (str) – Location of the resource.

Keyword Arguments:

• id (str) – The ARM identifier of the resource.

• perimeter_guid (str) – Guid of the resource.

• location (str) – Location of the resource.

class azure.mgmt.storage.v2024_01_01.models.NetworkSecurityPerimeterConfiguration(**kwargs: Any)

Bases: ProxyResourceAutoGenerated

The Network Security Perimeter configuration 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. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

• provisioning_state (str or NetworkSecurityPerimeterConfigurationProvisioningState) – Provisioning state of Network Security Perimeter configuration propagation. Known values are: “Accepted”, “Succeeded”, “Failed”, “Deleting”, and “Canceled”.

• provisioning_issues (list[ProvisioningIssue]) – List of Provisioning Issues if any.

• network_security_perimeter (NetworkSecurityPerimeter) – NetworkSecurityPerimeter related information.

• resource_association (NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation) – Information about resource association.

• profile (NetworkSecurityPerimeterConfigurationPropertiesProfile) – Network Security Perimeter profile.

class azure.mgmt.storage.v2024_01_01.models.NetworkSecurityPerimeterConfigurationList(*, next_link: str | None = None, **kwargs: Any)

Bases: Model

Result of the List Network Security Perimeter configuration operation.

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

Variables:

• value (list[NetworkSecurityPerimeterConfiguration]) – A collection of Network Security Perimeter configurations.

• next_link (str) – The URI that can be used to request the next set of paged results.

Keyword Arguments:

next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.storage.v2024_01_01.models.NetworkSecurityPerimeterConfigurationPropertiesProfile(*, name: str | None = None, access_rules_version: float | None = None, access_rules: List[_models.NspAccessRule] | None = None, diagnostic_settings_version: float | None = None, enabled_log_categories: List[str] | None = None, **kwargs: Any)

Bases: Model

Network Security Perimeter profile.

Variables:

• name (str) – Name of the resource.

• access_rules_version (float) – Current access rules version.

• access_rules (list[NspAccessRule]) – List of Access Rules.

• diagnostic_settings_version (float) – Diagnostic settings version.

• enabled_log_categories (list[str]) – Enabled logging categories.

Keyword Arguments:

• name (str) – Name of the resource.

• access_rules_version (float) – Current access rules version.

• access_rules (list[NspAccessRule]) – List of Access Rules.

• diagnostic_settings_version (float) – Diagnostic settings version.

• enabled_log_categories (list[str]) – Enabled logging categories.

class azure.mgmt.storage.v2024_01_01.models.NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation(*, name: str | None = None, access_mode: str | _models.ResourceAssociationAccessMode | None = None, **kwargs: Any)

Bases: Model

Information about resource association.

Variables:

• name (str) – Name of the resource association.

• access_mode (str or ResourceAssociationAccessMode) – Access Mode of the resource association. Known values are: “Enforced”, “Learning”, and “Audit”.

Keyword Arguments:

• name (str) – Name of the resource association.

• access_mode (str or ResourceAssociationAccessMode) – Access Mode of the resource association. Known values are: “Enforced”, “Learning”, and “Audit”.

class azure.mgmt.storage.v2024_01_01.models.NetworkSecurityPerimeterConfigurationProvisioningState(*values)

Bases: str, Enum

Provisioning state of Network Security Perimeter configuration propagation.

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

class azure.mgmt.storage.v2024_01_01.models.NspAccessRule(*, name: str | None = None, **kwargs: Any)

Bases: Model

Information of Access Rule in Network Security Perimeter profile.

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

Variables:

• name (str) – Name of the resource.

• properties (NspAccessRuleProperties) – Properties of Access Rule.

Keyword Arguments:

name (str) – Name of the resource.

class azure.mgmt.storage.v2024_01_01.models.NspAccessRuleDirection(*values)

Bases: str, Enum

Direction of Access Rule.

INBOUND = 'Inbound'

OUTBOUND = 'Outbound'

class azure.mgmt.storage.v2024_01_01.models.NspAccessRuleProperties(*, direction: str | _models.NspAccessRuleDirection | None = None, address_prefixes: List[str] | None = None, subscriptions: List[_models.NspAccessRulePropertiesSubscriptionsItem] | None = None, **kwargs: Any)

Bases: Model

Properties of Access Rule.

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

Variables:

• direction (str or NspAccessRuleDirection) – Direction of Access Rule. Known values are: “Inbound” and “Outbound”.

• address_prefixes (list[str]) – Address prefixes in the CIDR format for inbound rules.

• subscriptions (list[NspAccessRulePropertiesSubscriptionsItem]) – Subscriptions for inbound rules.

• network_security_perimeters (list[NetworkSecurityPerimeter]) – NetworkSecurityPerimeters for inbound rules.

• fully_qualified_domain_names (list[str]) – FQDN for outbound rules.

Keyword Arguments:

• direction (str or NspAccessRuleDirection) – Direction of Access Rule. Known values are: “Inbound” and “Outbound”.

• address_prefixes (list[str]) – Address prefixes in the CIDR format for inbound rules.

• subscriptions (list[NspAccessRulePropertiesSubscriptionsItem]) – Subscriptions for inbound rules.

class azure.mgmt.storage.v2024_01_01.models.NspAccessRulePropertiesSubscriptionsItem(*, id: str | None = None, **kwargs: Any)

Bases: Model

Subscription for inbound rule.

Variables:

id (str) – The ARM identifier of subscription.

Keyword Arguments:

id (str) – The ARM identifier of subscription.

class azure.mgmt.storage.v2024_01_01.models.ObjectReplicationPolicies(*, value: List[_models.ObjectReplicationPolicy] | None = None, **kwargs: Any)

Bases: Model

List storage account object replication policies.

Variables:

value (list[ObjectReplicationPolicy]) – The replication policy between two storage accounts.

Keyword Arguments:

value (list[ObjectReplicationPolicy]) – The replication policy between two storage accounts.

class azure.mgmt.storage.v2024_01_01.models.ObjectReplicationPolicy(*, source_account: str | None = None, destination_account: str | None = None, rules: List[_models.ObjectReplicationPolicyRule] | None = None, metrics: _models.ObjectReplicationPolicyPropertiesMetrics | None = None, **kwargs: Any)

Bases: Resource

The replication policy between two storage accounts. Multiple rules can be defined in one policy.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• policy_id (str) – A unique id for object replication policy.

• enabled_time (datetime) – Indicates when the policy is enabled on the source account.

• source_account (str) – Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.

• destination_account (str) – Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.

• rules (list[ObjectReplicationPolicyRule]) – The storage account object replication rules.

• metrics (ObjectReplicationPolicyPropertiesMetrics) – Optional. The object replication policy metrics feature options.

Keyword Arguments:

• source_account (str) – Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false.

• destination_account (str) – Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false.

• rules (list[ObjectReplicationPolicyRule]) – The storage account object replication rules.

• metrics (ObjectReplicationPolicyPropertiesMetrics) – Optional. The object replication policy metrics feature options.

class azure.mgmt.storage.v2024_01_01.models.ObjectReplicationPolicyFilter(*, prefix_match: List[str] | None = None, min_creation_time: str | None = None, **kwargs: Any)

Bases: Model

Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters.

Variables:

• prefix_match (list[str]) – Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.

• min_creation_time (str) – Blobs created after the time will be replicated to the destination. It must be in datetime format ‘yyyy-MM-ddTHH:mm:ssZ’. Example: 2020-02-19T16:05:00Z.

Keyword Arguments:

• prefix_match (list[str]) – Optional. Filters the results to replicate only blobs whose names begin with the specified prefix.

• min_creation_time (str) – Blobs created after the time will be replicated to the destination. It must be in datetime format ‘yyyy-MM-ddTHH:mm:ssZ’. Example: 2020-02-19T16:05:00Z.

class azure.mgmt.storage.v2024_01_01.models.ObjectReplicationPolicyPropertiesMetrics(*, enabled: bool | None = None, **kwargs: Any)

Bases: Model

Optional. The object replication policy metrics feature options.

Variables:

enabled (bool) – Indicates whether object replication metrics feature is enabled for the policy.

Keyword Arguments:

enabled (bool) – Indicates whether object replication metrics feature is enabled for the policy.

class azure.mgmt.storage.v2024_01_01.models.ObjectReplicationPolicyRule(*, source_container: str, destination_container: str, rule_id: str | None = None, filters: _models.ObjectReplicationPolicyFilter | None = None, **kwargs: Any)

Bases: Model

The replication policy rule between two containers.

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

Variables:

• rule_id (str) – Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

• source_container (str) – Required. Source container name. Required.

• destination_container (str) – Required. Destination container name. Required.

• filters (ObjectReplicationPolicyFilter) – Optional. An object that defines the filter set.

Keyword Arguments:

• rule_id (str) – Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account.

• source_container (str) – Required. Source container name. Required.

• destination_container (str) – Required. Destination container name. Required.

• filters (ObjectReplicationPolicyFilter) – Optional. An object that defines the filter set.

class azure.mgmt.storage.v2024_01_01.models.ObjectType(*values)

Bases: str, Enum

This is a required field. This field specifies the scope of the inventory created either at the blob or container level.

BLOB = 'Blob'

CONTAINER = 'Container'

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

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.v2024_01_01.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)

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.

• description (str) – Description of the operation.

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.

• description (str) – Description of the operation.

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

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.v2024_01_01.models.PermissionScope(*, permissions: str, service: str, resource_name: str, **kwargs: Any)

Bases: Model

PermissionScope.

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

Variables:

• permissions (str) – The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). Required.

• service (str) – The service used by the local user, e.g. blob, file. Required.

• resource_name (str) – The name of resource, normally the container name or the file share name, used by the local user. Required.

Keyword Arguments:

• permissions (str) – The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). Required.

• service (str) – The service used by the local user, e.g. blob, file. Required.

• resource_name (str) – The name of resource, normally the container name or the file share name, used by the local user. Required.

class azure.mgmt.storage.v2024_01_01.models.Permissions(*values)

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.v2024_01_01.models.PostFailoverRedundancy(*values)

Bases: str, Enum

The redundancy type of the account after an account failover is performed.

STANDARD_LRS = 'Standard_LRS'

STANDARD_ZRS = 'Standard_ZRS'

class azure.mgmt.storage.v2024_01_01.models.PostPlannedFailoverRedundancy(*values)

Bases: str, Enum

The redundancy type of the account after a planned account failover is performed.

STANDARD_GRS = 'Standard_GRS'

STANDARD_GZRS = 'Standard_GZRS'

STANDARD_RAGRS = 'Standard_RAGRS'

STANDARD_RAGZRS = 'Standard_RAGZRS'

class azure.mgmt.storage.v2024_01_01.models.PrivateEndpoint(**kwargs: Any)

Bases: Model

The Private Endpoint resource.

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

Variables:

id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.storage.v2024_01_01.models.PrivateEndpointConnection(*, private_endpoint: _models.PrivateEndpoint | None = None, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState | None = None, **kwargs: Any)

Bases: Resource

The Private Endpoint Connection 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• private_endpoint (PrivateEndpoint) – The resource of private end point.

• private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

• provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments:

• private_endpoint (PrivateEndpoint) – The resource of private end point.

• private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.storage.v2024_01_01.models.PrivateEndpointConnectionListResult(*, value: List[_models.PrivateEndpointConnection] | None = None, **kwargs: Any)

Bases: Model

List of private endpoint connection associated with the specified storage account.

Variables:

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

Keyword Arguments:

value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.storage.v2024_01_01.models.PrivateEndpointConnectionProvisioningState(*values)

Bases: str, Enum

The current provisioning state.

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

class azure.mgmt.storage.v2024_01_01.models.PrivateEndpointServiceConnectionStatus(*values)

Bases: str, Enum

The private endpoint connection status.

APPROVED = 'Approved'

PENDING = 'Pending'

REJECTED = 'Rejected'

class azure.mgmt.storage.v2024_01_01.models.PrivateLinkResource(*, required_zone_names: List[str] | None = None, **kwargs: Any)

Bases: Resource

A private link 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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• group_id (str) – The private link resource group id.

• required_members (list[str]) – The private link resource required member names.

• required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments:

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.storage.v2024_01_01.models.PrivateLinkResourceListResult(*, value: List[_models.PrivateLinkResource] | None = None, **kwargs: Any)

Bases: Model

A list of private link resources.

Variables:

value (list[PrivateLinkResource]) – Array of private link resources.

Keyword Arguments:

value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.storage.v2024_01_01.models.PrivateLinkServiceConnectionState(*, status: str | _models.PrivateEndpointServiceConnectionStatus | None = None, description: str | None = None, action_required: str | None = None, **kwargs: Any)

Bases: Model

A collection of information about the state of the connection between service consumer and provider.

Variables:

• status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.

• description (str) – The reason for approval/rejection of the connection.

• action_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments:

• status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.

• description (str) – The reason for approval/rejection of the connection.

• action_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.storage.v2024_01_01.models.ProtectedAppendWritesHistory(*, allow_protected_append_writes_all: bool | None = None, **kwargs: Any)

Bases: Model

Protected append writes history setting for the blob container with Legal holds.

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

Variables:

• allow_protected_append_writes_all (bool) – When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

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

Keyword Arguments:

allow_protected_append_writes_all (bool) – When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

class azure.mgmt.storage.v2024_01_01.models.ProtocolSettings(*, smb: _models.SmbSetting | None = None, **kwargs: Any)

Bases: Model

Protocol settings for file service.

Variables:

smb (SmbSetting) – Setting for SMB protocol.

Keyword Arguments:

smb (SmbSetting) – Setting for SMB protocol.

class azure.mgmt.storage.v2024_01_01.models.ProvisioningIssue(*, name: str | None = None, **kwargs: Any)

Bases: Model

Describes provisioning issue for given NetworkSecurityPerimeterConfiguration.

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

Variables:

• name (str) – Name of the issue.

• properties (ProvisioningIssueProperties) – Properties of provisioning issue.

Keyword Arguments:

name (str) – Name of the issue.

class azure.mgmt.storage.v2024_01_01.models.ProvisioningIssueProperties(*, issue_type: str | _models.IssueType | None = None, severity: str | _models.Severity | None = None, description: str | None = None, **kwargs: Any)

Bases: Model

Properties of provisioning issue.

Variables:

• issue_type (str or IssueType) – Type of issue. Known values are: “Unknown” and “ConfigurationPropagationFailure”.

• severity (str or Severity) – Severity of the issue. Known values are: “Warning” and “Error”.

• description (str) – Description of the issue.

Keyword Arguments:

• issue_type (str or IssueType) – Type of issue. Known values are: “Unknown” and “ConfigurationPropagationFailure”.

• severity (str or Severity) – Severity of the issue. Known values are: “Warning” and “Error”.

• description (str) – Description of the issue.

class azure.mgmt.storage.v2024_01_01.models.ProvisioningState(*values)

Bases: str, Enum

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

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

CREATING = 'Creating'

DELETING = 'Deleting'

FAILED = 'Failed'

RESOLVING_DNS = 'ResolvingDNS'

SUCCEEDED = 'Succeeded'

VALIDATE_SUBSCRIPTION_QUOTA_BEGIN = 'ValidateSubscriptionQuotaBegin'

VALIDATE_SUBSCRIPTION_QUOTA_END = 'ValidateSubscriptionQuotaEnd'

class azure.mgmt.storage.v2024_01_01.models.ProxyResource(**kwargs: Any)

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.storage.v2024_01_01.models.ProxyResourceAutoGenerated(**kwargs: Any)

Bases: ResourceAutoGenerated

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

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. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.storage.v2024_01_01.models.PublicAccess(*values)

Bases: str, Enum

Specifies whether data in the container may be accessed publicly and the level of access.

BLOB = 'Blob'

CONTAINER = 'Container'

NONE = 'None'

class azure.mgmt.storage.v2024_01_01.models.PublicNetworkAccess(*values)

Bases: str, Enum

Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’, ‘Disabled’ or ‘SecuredByPerimeter’.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

SECURED_BY_PERIMETER = 'SecuredByPerimeter'

class azure.mgmt.storage.v2024_01_01.models.QueueServiceProperties(*, cors: _models.CorsRules | None = None, **kwargs: Any)

Bases: Resource

The properties of a storage account’s Queue service.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• cors (CorsRules) – Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.

Keyword Arguments:

cors (CorsRules) – Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service.

class azure.mgmt.storage.v2024_01_01.models.Reason(*values)

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.v2024_01_01.models.ReasonCode(*values)

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.v2024_01_01.models.Resource(**kwargs: Any)

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.storage.v2024_01_01.models.ResourceAccessRule(*, tenant_id: str | None = None, resource_id: str | None = None, **kwargs: Any)

Bases: Model

Resource Access Rule.

Variables:

• tenant_id (str) – Tenant Id.

• resource_id (str) – Resource Id.

Keyword Arguments:

• tenant_id (str) – Tenant Id.

• resource_id (str) – Resource Id.

class azure.mgmt.storage.v2024_01_01.models.ResourceAssociationAccessMode(*values)

Bases: str, Enum

Access Mode of the resource association.

AUDIT = 'Audit'

ENFORCED = 'Enforced'

LEARNING = 'Learning'

class azure.mgmt.storage.v2024_01_01.models.ResourceAutoGenerated(**kwargs: Any)

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

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. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.storage.v2024_01_01.models.RestorePolicyProperties(*, enabled: bool, days: int | None = None, **kwargs: Any)

Bases: Model

The blob service properties for blob restore policy.

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:

• enabled (bool) – Blob restore is enabled if set to true. Required.

• days (int) – how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days.

• last_enabled_time (datetime) – Deprecated in favor of minRestoreTime property.

• min_restore_time (datetime) – Returns the minimum date and time that the restore can be started.

Keyword Arguments:

• enabled (bool) – Blob restore is enabled if set to true. Required.

• days (int) – how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days.

class azure.mgmt.storage.v2024_01_01.models.Restriction(*, reason_code: str | _models.ReasonCode | None = None, **kwargs: Any)

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.v2024_01_01.models.RootSquashType(*values)

Bases: str, Enum

The property is for NFS share only. The default is NoRootSquash.

ALL_SQUASH = 'AllSquash'

NO_ROOT_SQUASH = 'NoRootSquash'

ROOT_SQUASH = 'RootSquash'

class azure.mgmt.storage.v2024_01_01.models.RoutingChoice(*values)

Bases: str, Enum

Routing Choice defines the kind of network routing opted by the user.

INTERNET_ROUTING = 'InternetRouting'

MICROSOFT_ROUTING = 'MicrosoftRouting'

class azure.mgmt.storage.v2024_01_01.models.RoutingPreference(*, routing_choice: str | _models.RoutingChoice | None = None, publish_microsoft_endpoints: bool | None = None, publish_internet_endpoints: bool | None = None, **kwargs: Any)

Bases: Model

Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing.

Variables:

• routing_choice (str or RoutingChoice) – Routing Choice defines the kind of network routing opted by the user. Known values are: “MicrosoftRouting” and “InternetRouting”.

• publish_microsoft_endpoints (bool) – A boolean flag which indicates whether microsoft routing storage endpoints are to be published.

• publish_internet_endpoints (bool) – A boolean flag which indicates whether internet routing storage endpoints are to be published.

Keyword Arguments:

• routing_choice (str or RoutingChoice) – Routing Choice defines the kind of network routing opted by the user. Known values are: “MicrosoftRouting” and “InternetRouting”.

• publish_microsoft_endpoints (bool) – A boolean flag which indicates whether microsoft routing storage endpoints are to be published.

• publish_internet_endpoints (bool) – A boolean flag which indicates whether internet routing storage endpoints are to be published.

class azure.mgmt.storage.v2024_01_01.models.RuleType(*values)

Bases: str, Enum

The valid value is Lifecycle.

LIFECYCLE = 'Lifecycle'

class azure.mgmt.storage.v2024_01_01.models.RunResult(*values)

Bases: str, Enum

Represents the overall result of the execution for the run instance.

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

class azure.mgmt.storage.v2024_01_01.models.RunStatusEnum(*values)

Bases: str, Enum

Represents the status of the execution.

FINISHED = 'Finished'

IN_PROGRESS = 'InProgress'

class azure.mgmt.storage.v2024_01_01.models.SKUCapability(**kwargs: Any)

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

class azure.mgmt.storage.v2024_01_01.models.SasPolicy(*, sas_expiration_period: str, expiration_action: str | _models.ExpirationAction = 'Log', **kwargs: Any)

Bases: Model

SasPolicy assigned to the storage account.

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

Variables:

• sas_expiration_period (str) – The SAS expiration period, DD.HH:MM:SS. Required.

• expiration_action (str or ExpirationAction) – The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The ‘Log’ action can be used for audit purposes and the ‘Block’ action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. Known values are: “Log” and “Block”.

Keyword Arguments:

• sas_expiration_period (str) – The SAS expiration period, DD.HH:MM:SS. Required.

• expiration_action (str or ExpirationAction) – The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The ‘Log’ action can be used for audit purposes and the ‘Block’ action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. Known values are: “Log” and “Block”.

class azure.mgmt.storage.v2024_01_01.models.Schedule(*values)

Bases: str, Enum

This is a required field. This field is used to schedule an inventory formation.

DAILY = 'Daily'

WEEKLY = 'Weekly'

class azure.mgmt.storage.v2024_01_01.models.ServiceSasParameters(*, canonicalized_resource: str, resource: str | _models.SignedResource | None = None, permissions: str | _models.Permissions | None = None, ip_address_or_range: str | None = None, protocols: str | _models.HttpProtocol | None = None, shared_access_start_time: datetime | None = None, shared_access_expiry_time: datetime | None = None, identifier: str | None = None, partition_key_start: str | None = None, partition_key_end: str | None = None, row_key_start: str | None = None, row_key_end: str | None = None, key_to_sign: str | None = None, cache_control: str | None = None, content_disposition: str | None = None, content_encoding: str | None = None, content_language: str | None = None, content_type: str | None = None, **kwargs: Any)

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). 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). 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.v2024_01_01.models.ServiceSpecification(*, metric_specifications: List[_models.MetricSpecification] | None = None, **kwargs: Any)

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.v2024_01_01.models.Services(*values)

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.v2024_01_01.models.Severity(*values)

Bases: str, Enum

Severity of the issue.

ERROR = 'Error'

WARNING = 'Warning'

class azure.mgmt.storage.v2024_01_01.models.ShareAccessTier(*values)

Bases: str, Enum

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

COOL = 'Cool'

HOT = 'Hot'

PREMIUM = 'Premium'

TRANSACTION_OPTIMIZED = 'TransactionOptimized'

class azure.mgmt.storage.v2024_01_01.models.SignedIdentifier(*, id: str | None = None, access_policy: _models.AccessPolicy | None = None, **kwargs: Any)

Bases: Model

SignedIdentifier.

Variables:

• id (str) – An unique identifier of the stored access policy.

• access_policy (AccessPolicy) – Access policy.

Keyword Arguments:

• id (str) – An unique identifier of the stored access policy.

• access_policy (AccessPolicy) – Access policy.

class azure.mgmt.storage.v2024_01_01.models.SignedResource(*values)

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.v2024_01_01.models.SignedResourceTypes(*values)

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.v2024_01_01.models.Sku(*, name: str | _models.SkuName, **kwargs: Any)

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) – 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”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

• tier (str or SkuTier) – The SKU tier. This is based on the SKU name. Known values are: “Standard” and “Premium”.

Keyword Arguments:

name (str or SkuName) – 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”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

class azure.mgmt.storage.v2024_01_01.models.SkuConversionStatus(*values)

Bases: str, Enum

This property indicates the current sku conversion status.

FAILED = 'Failed'

IN_PROGRESS = 'InProgress'

SUCCEEDED = 'Succeeded'

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

Bases: Model

Storage SKU and its properties.

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) – 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”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

• tier (str or SkuTier) – 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”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

• 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) – 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”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

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

class azure.mgmt.storage.v2024_01_01.models.SkuName(*values)

Bases: str, Enum

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

PREMIUM_LRS = 'Premium_LRS'

PREMIUM_V2_LRS = 'PremiumV2_LRS'

PREMIUM_V2_ZRS = 'PremiumV2_ZRS'

PREMIUM_ZRS = 'Premium_ZRS'

STANDARD_GRS = 'Standard_GRS'

STANDARD_GZRS = 'Standard_GZRS'

STANDARD_LRS = 'Standard_LRS'

STANDARD_RAGRS = 'Standard_RAGRS'

STANDARD_RAGZRS = 'Standard_RAGZRS'

STANDARD_V2_GRS = 'StandardV2_GRS'

STANDARD_V2_GZRS = 'StandardV2_GZRS'

STANDARD_V2_LRS = 'StandardV2_LRS'

STANDARD_V2_ZRS = 'StandardV2_ZRS'

STANDARD_ZRS = 'Standard_ZRS'

class azure.mgmt.storage.v2024_01_01.models.SkuTier(*values)

Bases: str, Enum

The SKU tier. This is based on the SKU name.

PREMIUM = 'Premium'

STANDARD = 'Standard'

class azure.mgmt.storage.v2024_01_01.models.SmbSetting(*, multichannel: _models.Multichannel | None = None, versions: str | None = None, authentication_methods: str | None = None, kerberos_ticket_encryption: str | None = None, channel_encryption: str | None = None, **kwargs: Any)

Bases: Model

Setting for SMB protocol.

Variables:

• multichannel (Multichannel) – Multichannel setting. Applies to Premium FileStorage only.

• versions (str) – SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’.

• authentication_methods (str) – SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’.

• kerberos_ticket_encryption (str) – Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’.

• channel_encryption (str) – SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’.

Keyword Arguments:

• multichannel (Multichannel) – Multichannel setting. Applies to Premium FileStorage only.

• versions (str) – SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’.

• authentication_methods (str) – SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’.

• kerberos_ticket_encryption (str) – Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’.

• channel_encryption (str) – SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’.

class azure.mgmt.storage.v2024_01_01.models.SshPublicKey(*, description: str | None = None, key: str | None = None, **kwargs: Any)

Bases: Model

SshPublicKey.

Variables:

• description (str) – Optional. It is used to store the function/usage of the key.

• key (str) – Ssh public key base64 encoded. The format should be: ‘<keyType> <keyData>’, e.g. ssh-rsa AAAABBBB.

Keyword Arguments:

• description (str) – Optional. It is used to store the function/usage of the key.

• key (str) – Ssh public key base64 encoded. The format should be: ‘<keyType> <keyData>’, e.g. ssh-rsa AAAABBBB.

class azure.mgmt.storage.v2024_01_01.models.State(*values)

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.v2024_01_01.models.StorageAccount(*, location: str, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, extended_location: _models.ExtendedLocation | None = None, azure_files_identity_based_authentication: _models.AzureFilesIdentityBasedAuthentication | None = None, enable_https_traffic_only: bool | None = None, is_sftp_enabled: bool | None = None, is_local_user_enabled: bool | None = None, enable_extended_groups: bool | None = None, is_hns_enabled: bool | None = None, large_file_shares_state: str | _models.LargeFileSharesState | None = None, routing_preference: _models.RoutingPreference | None = None, allow_blob_public_access: bool | None = None, minimum_tls_version: str | _models.MinimumTlsVersion | None = None, allow_shared_key_access: bool | None = None, enable_nfs_v3: bool | None = None, allow_cross_tenant_replication: bool | None = None, default_to_o_auth_authentication: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, immutable_storage_with_versioning: _models.ImmutableStorageAccount | None = None, allowed_copy_scope: str | _models.AllowedCopyScope | None = None, storage_account_sku_conversion_status: _models.StorageAccountSkuConversionStatus | None = None, dns_endpoint_type: str | _models.DnsEndpointType | None = None, **kwargs: Any)

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

Variables:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

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

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

• sku (Sku) – Gets the SKU.

• kind (str or Kind) – Gets the Kind. Known values are: “Storage”, “StorageV2”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

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

• extended_location (ExtendedLocation) – The extendedLocation 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”, “Succeeded”, “ValidateSubscriptionQuotaBegin”, “ValidateSubscriptionQuotaEnd”, “Accepted”, “Deleting”, “Canceled”, and “Failed”.

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

• sas_policy (SasPolicy) – SasPolicy assigned to the storage account.

• key_policy (KeyPolicy) – KeyPolicy assigned to the storage account.

• key_creation_time (KeyCreationTime) – Storage account keys creation time.

• 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) – Encryption settings to be used for server-side encryption for the storage account.

• access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. Known values are: “Hot”, “Cool”, “Premium”, and “Cold”.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

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

• network_rule_set (NetworkRuleSet) – Network rule set.

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true.

• geo_replication_stats (GeoReplicationStats) – Geo Replication Stats.

• failover_in_progress (bool) – If the failover is in progress, the value will be true, otherwise, it will be null.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connection associated with the specified storage account.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• blob_restore_status (BlobRestoreStatus) – Blob restore status.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• enable_nfs_v3 (bool) – NFS 3.0 protocol support enabled if set to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default.

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• storage_account_sku_conversion_status (StorageAccountSkuConversionStatus) – This property is readOnly and is set by server during asynchronous storage account sku conversion operations.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

• is_sku_conversion_blocked (bool) – This property will be set to true or false on an event of ongoing migration. Default value is null.

• account_migration_in_progress (bool) – If customer initiated account migration is in progress, the value will be true else it will be null.

Keyword Arguments:

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

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

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

• extended_location (ExtendedLocation) – The extendedLocation of the resource.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

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

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• enable_nfs_v3 (bool) – NFS 3.0 protocol support enabled if set to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default.

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• storage_account_sku_conversion_status (StorageAccountSkuConversionStatus) – This property is readOnly and is set by server during asynchronous storage account sku conversion operations.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountCheckNameAvailabilityParameters(*, name: str, **kwargs: Any)

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.v2024_01_01.models.StorageAccountCreateParameters(*, sku: _models.Sku, kind: str | _models.Kind, location: str, extended_location: _models.ExtendedLocation | None = None, tags: Dict[str, str] | None = None, identity: _models.Identity | None = None, allowed_copy_scope: str | _models.AllowedCopyScope | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, sas_policy: _models.SasPolicy | None = None, key_policy: _models.KeyPolicy | 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, azure_files_identity_based_authentication: _models.AzureFilesIdentityBasedAuthentication | None = None, enable_https_traffic_only: bool | None = None, is_sftp_enabled: bool | None = None, is_local_user_enabled: bool | None = None, enable_extended_groups: bool | None = None, is_hns_enabled: bool | None = None, large_file_shares_state: str | _models.LargeFileSharesState | None = None, routing_preference: _models.RoutingPreference | None = None, allow_blob_public_access: bool | None = None, minimum_tls_version: str | _models.MinimumTlsVersion | None = None, allow_shared_key_access: bool | None = None, enable_nfs_v3: bool | None = None, allow_cross_tenant_replication: bool | None = None, default_to_o_auth_authentication: bool | None = None, immutable_storage_with_versioning: _models.ImmutableStorageAccount | None = None, dns_endpoint_type: str | _models.DnsEndpointType | None = None, **kwargs: Any)

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”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

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

• extended_location (ExtendedLocation) – Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.

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

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’, ‘Disabled’ or ‘SecuredByPerimeter’. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• sas_policy (SasPolicy) – SasPolicy assigned to the storage account.

• key_policy (KeyPolicy) – KeyPolicy assigned to the storage account.

• 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) – Encryption settings to be used for server-side encryption for the storage account.

• network_rule_set (NetworkRuleSet) – Network rule set.

• access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. Known values are: “Hot”, “Cool”, “Premium”, and “Cold”.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

• enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• enable_nfs_v3 (bool) – NFS 3.0 protocol support enabled if set to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

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”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

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

• extended_location (ExtendedLocation) – Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.

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

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’, ‘Disabled’ or ‘SecuredByPerimeter’. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• sas_policy (SasPolicy) – SasPolicy assigned to the storage account.

• key_policy (KeyPolicy) – KeyPolicy assigned to the storage account.

• 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) – Encryption settings to be used for server-side encryption for the storage account.

• network_rule_set (NetworkRuleSet) – Network rule set.

• access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. Known values are: “Hot”, “Cool”, “Premium”, and “Cold”.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

• enable_https_traffic_only (bool) – Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• is_hns_enabled (bool) – Account HierarchicalNamespace enabled if sets to true.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• enable_nfs_v3 (bool) – NFS 3.0 protocol support enabled if set to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountExpand(*values)

Bases: str, Enum

StorageAccountExpand.

BLOB_RESTORE_STATUS = 'blobRestoreStatus'

GEO_REPLICATION_STATS = 'geoReplicationStats'

class azure.mgmt.storage.v2024_01_01.models.StorageAccountInternetEndpoints(**kwargs: Any)

Bases: Model

The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.

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

Variables:

• blob (str) – Gets the blob endpoint.

• file (str) – Gets the file endpoint.

• web (str) – Gets the web endpoint.

• dfs (str) – Gets the dfs endpoint.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountKey(**kwargs: Any)

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

• creation_time (datetime) – Creation time of the key, in round trip date format.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountListKeysResult(**kwargs: Any)

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.v2024_01_01.models.StorageAccountListResult(**kwargs: Any)

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.

• next_link (str) – Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountMicrosoftEndpoints(**kwargs: Any)

Bases: Model

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.

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.v2024_01_01.models.StorageAccountMigration(*, target_sku_name: str | _models.SkuName, name: str | None = None, type: str | None = None, **kwargs: Any)

Bases: Model

The parameters or status associated with an ongoing or enqueued storage account migration in order to update its current SKU or region.

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:

• id (str) – Migration Resource Id.

• name (str) – current value is ‘default’ for customer initiated migration.

• type (str) – SrpAccountMigrationType in ARM contract which is ‘accountMigrations’.

• target_sku_name (str or SkuName) – Target sku name for the account. Required. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

• migration_status (str or MigrationStatus) – Current status of migration. Known values are: “Invalid”, “SubmittedForConversion”, “InProgress”, “Complete”, and “Failed”.

• migration_failed_reason (str) – Error code for migration failure.

• migration_failed_detailed_reason (str) – Reason for migration failure.

Keyword Arguments:

• name (str) – current value is ‘default’ for customer initiated migration.

• type (str) – SrpAccountMigrationType in ARM contract which is ‘accountMigrations’.

• target_sku_name (str or SkuName) – Target sku name for the account. Required. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountRegenerateKeyParameters(*, key_name: str, **kwargs: Any)

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, kerb1, kerb2. Required.

Keyword Arguments:

key_name (str) – The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2. Required.

class azure.mgmt.storage.v2024_01_01.models.StorageAccountSkuConversionStatus(*, target_sku_name: str | _models.SkuName | None = None, **kwargs: Any)

Bases: Model

This defines the sku conversion status object for asynchronous sku conversions.

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

Variables:

• sku_conversion_status (str or SkuConversionStatus) – This property indicates the current sku conversion status. Known values are: “InProgress”, “Succeeded”, and “Failed”.

• target_sku_name (str or SkuName) – This property represents the target sku name to which the account sku is being converted asynchronously. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

• start_time (str) – This property represents the sku conversion start time.

• end_time (str) – This property represents the sku conversion end time.

Keyword Arguments:

target_sku_name (str or SkuName) – This property represents the target sku name to which the account sku is being converted asynchronously. Known values are: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Premium_LRS”, “Premium_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “StandardV2_LRS”, “StandardV2_GRS”, “StandardV2_ZRS”, “StandardV2_GZRS”, “PremiumV2_LRS”, and “PremiumV2_ZRS”.

class azure.mgmt.storage.v2024_01_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, sas_policy: _models.SasPolicy | None = None, key_policy: _models.KeyPolicy | None = None, access_tier: str | _models.AccessTier | None = None, azure_files_identity_based_authentication: _models.AzureFilesIdentityBasedAuthentication | None = None, enable_https_traffic_only: bool | None = None, is_sftp_enabled: bool | None = None, is_local_user_enabled: bool | None = None, enable_extended_groups: bool | None = None, network_rule_set: _models.NetworkRuleSet | None = None, large_file_shares_state: str | _models.LargeFileSharesState | None = None, routing_preference: _models.RoutingPreference | None = None, allow_blob_public_access: bool | None = None, minimum_tls_version: str | _models.MinimumTlsVersion | None = None, allow_shared_key_access: bool | None = None, allow_cross_tenant_replication: bool | None = None, default_to_o_auth_authentication: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, immutable_storage_with_versioning: _models.ImmutableStorageAccount | None = None, allowed_copy_scope: str | _models.AllowedCopyScope | None = None, dns_endpoint_type: str | _models.DnsEndpointType | None = None, **kwargs: Any)

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, Premium_LRS or Premium_ZRS, 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”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

• 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) – Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled.

• sas_policy (SasPolicy) – SasPolicy assigned to the storage account.

• key_policy (KeyPolicy) – KeyPolicy assigned to the storage account.

• access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. Known values are: “Hot”, “Cool”, “Premium”, and “Cold”.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

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

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• network_rule_set (NetworkRuleSet) – Network rule set.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’, ‘Disabled’ or ‘SecuredByPerimeter’. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default.

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

Keyword Arguments:

• sku (Sku) – Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, 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”, “BlobStorage”, “FileStorage”, and “BlockBlobStorage”.

• 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) – Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled.

• sas_policy (SasPolicy) – SasPolicy assigned to the storage account.

• key_policy (KeyPolicy) – KeyPolicy assigned to the storage account.

• access_tier (str or AccessTier) – Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The ‘Premium’ access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. Known values are: “Hot”, “Cool”, “Premium”, and “Cold”.

• azure_files_identity_based_authentication (AzureFilesIdentityBasedAuthentication) – Provides the identity based authentication settings for Azure Files.

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

• is_sftp_enabled (bool) – Enables Secure File Transfer Protocol, if set to true.

• is_local_user_enabled (bool) – Enables local users feature, if set to true.

• enable_extended_groups (bool) – Enables extended group support with local users feature, if set to true.

• network_rule_set (NetworkRuleSet) – Network rule set.

• large_file_shares_state (str or LargeFileSharesState) – Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Known values are: “Disabled” and “Enabled”.

• routing_preference (RoutingPreference) – Maintains information about the network routing choice opted by the user for data transfer.

• allow_blob_public_access (bool) – Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property.

• minimum_tls_version (str or MinimumTlsVersion) – Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Known values are: “TLS1_0”, “TLS1_1”, “TLS1_2”, and “TLS1_3”.

• allow_shared_key_access (bool) – Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.

• allow_cross_tenant_replication (bool) – Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

• default_to_o_auth_authentication (bool) – A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

• public_network_access (str or PublicNetworkAccess) – Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’, ‘Disabled’ or ‘SecuredByPerimeter’. Known values are: “Enabled”, “Disabled”, and “SecuredByPerimeter”.

• immutable_storage_with_versioning (ImmutableStorageAccount) – The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default.

• allowed_copy_scope (str or AllowedCopyScope) – Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Known values are: “PrivateLink” and “AAD”.

• dns_endpoint_type (str or DnsEndpointType) – Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. Known values are: “Standard” and “AzureDnsZone”.

class azure.mgmt.storage.v2024_01_01.models.StorageQueue(*, metadata: Dict[str, str] | None = None, **kwargs: Any)

Bases: Resource

StorageQueue.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• metadata (dict[str, str]) – A name-value pair that represents queue metadata.

• approximate_message_count (int) – Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.

Keyword Arguments:

metadata (dict[str, str]) – A name-value pair that represents queue metadata.

class azure.mgmt.storage.v2024_01_01.models.StorageSkuListResult(**kwargs: Any)

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[SkuInformation]) – Get the list result of storage SKUs and their properties.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignment(*, properties: _models.StorageTaskAssignmentProperties, **kwargs: Any)

Bases: Resource

The storage task assignment.

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:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• properties (StorageTaskAssignmentProperties) – Properties of the storage task assignment. Required.

Keyword Arguments:

properties (StorageTaskAssignmentProperties) – Properties of the storage task assignment. Required.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentExecutionContext(*, trigger: _models.ExecutionTrigger, target: _models.ExecutionTarget | None = None, **kwargs: Any)

Bases: Model

Execution context of the storage task assignment.

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

Variables:

• target (ExecutionTarget) – Execution target of the storage task assignment.

• trigger (ExecutionTrigger) – Execution trigger of the storage task assignment. Required.

Keyword Arguments:

• target (ExecutionTarget) – Execution target of the storage task assignment.

• trigger (ExecutionTrigger) – Execution trigger of the storage task assignment. Required.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentProperties(*, task_id: str, enabled: bool, description: str, execution_context: _models.StorageTaskAssignmentExecutionContext, report: _models.StorageTaskAssignmentReport, run_status: _models.StorageTaskReportProperties | None = None, **kwargs: Any)

Bases: Model

Properties of the storage task assignment.

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:

• task_id (str) – Id of the corresponding storage task. Required.

• enabled (bool) – Whether the storage task assignment is enabled or not. Required.

• description (str) – Text that describes the purpose of the storage task assignment. Required.

• execution_context (StorageTaskAssignmentExecutionContext) – The storage task assignment execution context. Required.

• report (StorageTaskAssignmentReport) – The storage task assignment report. Required.

• provisioning_state (str or ProvisioningState) – Represents the provisioning state of the storage task assignment. Known values are: “Creating”, “ResolvingDNS”, “Succeeded”, “ValidateSubscriptionQuotaBegin”, “ValidateSubscriptionQuotaEnd”, “Accepted”, “Deleting”, “Canceled”, and “Failed”.

• run_status (StorageTaskReportProperties) – Run status of storage task assignment.

Keyword Arguments:

• task_id (str) – Id of the corresponding storage task. Required.

• enabled (bool) – Whether the storage task assignment is enabled or not. Required.

• description (str) – Text that describes the purpose of the storage task assignment. Required.

• execution_context (StorageTaskAssignmentExecutionContext) – The storage task assignment execution context. Required.

• report (StorageTaskAssignmentReport) – The storage task assignment report. Required.

• run_status (StorageTaskReportProperties) – Run status of storage task assignment.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentReport(*, prefix: str, **kwargs: Any)

Bases: Model

The storage task assignment report.

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

Variables:

prefix (str) – The container prefix for the location of storage task assignment report. Required.

Keyword Arguments:

prefix (str) – The container prefix for the location of storage task assignment report. Required.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentUpdateExecutionContext(*, target: _models.ExecutionTarget | None = None, trigger: _models.ExecutionTriggerUpdate | None = None, **kwargs: Any)

Bases: Model

Execution context of the storage task assignment update.

Variables:

• target (ExecutionTarget) – Execution target of the storage task assignment.

• trigger (ExecutionTriggerUpdate) – Execution trigger of the storage task assignment.

Keyword Arguments:

• target (ExecutionTarget) – Execution target of the storage task assignment.

• trigger (ExecutionTriggerUpdate) – Execution trigger of the storage task assignment.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentUpdateParameters(*, properties: _models.StorageTaskAssignmentUpdateProperties | None = None, **kwargs: Any)

Bases: Model

Parameters of the storage task assignment update request.

Variables:

properties (StorageTaskAssignmentUpdateProperties) – Properties of the storage task assignment.

Keyword Arguments:

properties (StorageTaskAssignmentUpdateProperties) – Properties of the storage task assignment.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentUpdateProperties(*, enabled: bool | None = None, description: str | None = None, execution_context: _models.StorageTaskAssignmentUpdateExecutionContext | None = None, report: _models.StorageTaskAssignmentUpdateReport | None = None, run_status: _models.StorageTaskReportProperties | None = None, **kwargs: Any)

Bases: Model

Properties of the storage task update assignment.

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

Variables:

• task_id (str) – Id of the corresponding storage task.

• enabled (bool) – Whether the storage task assignment is enabled or not.

• description (str) – Text that describes the purpose of the storage task assignment.

• execution_context (StorageTaskAssignmentUpdateExecutionContext) – The storage task assignment execution context.

• report (StorageTaskAssignmentUpdateReport) – The storage task assignment report.

• provisioning_state (str or ProvisioningState) – Represents the provisioning state of the storage task assignment. Known values are: “Creating”, “ResolvingDNS”, “Succeeded”, “ValidateSubscriptionQuotaBegin”, “ValidateSubscriptionQuotaEnd”, “Accepted”, “Deleting”, “Canceled”, and “Failed”.

• run_status (StorageTaskReportProperties) – Run status of storage task assignment.

Keyword Arguments:

• enabled (bool) – Whether the storage task assignment is enabled or not.

• description (str) – Text that describes the purpose of the storage task assignment.

• execution_context (StorageTaskAssignmentUpdateExecutionContext) – The storage task assignment execution context.

• report (StorageTaskAssignmentUpdateReport) – The storage task assignment report.

• run_status (StorageTaskReportProperties) – Run status of storage task assignment.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentUpdateReport(*, prefix: str | None = None, **kwargs: Any)

Bases: Model

The storage task assignment report.

Variables:

prefix (str) – The prefix of the storage task assignment report.

Keyword Arguments:

prefix (str) – The prefix of the storage task assignment report.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskAssignmentsList(**kwargs: Any)

Bases: Model

List of storage task assignments for the storage account.

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

Variables:

• value (list[StorageTaskAssignment]) – Gets the list of storage task assignments and their properties.

• next_link (str) – Request URL that can be used to query next page of storage task assignments. Returned when total number of requested storage task assignments exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskReportInstance(*, properties: _models.StorageTaskReportProperties | None = None, **kwargs: Any)

Bases: ProxyResource

Storage Tasks run report instance.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• properties (StorageTaskReportProperties) – Storage task execution report for a run instance.

Keyword Arguments:

properties (StorageTaskReportProperties) – Storage task execution report for a run instance.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskReportProperties(**kwargs: Any)

Bases: Model

Storage task execution report for a run instance.

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

Variables:

• task_assignment_id (str) – Represents the Storage Task Assignment Id associated with the storage task that provided an execution context.

• storage_account_id (str) – Represents the Storage Account Id where the storage task definition was applied and executed.

• start_time (str) – Start time of the run instance. Filter options such as startTime gt ‘2023-06-26T20:51:24.4494016Z’ and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• finish_time (str) – End time of the run instance. Filter options such as startTime gt ‘2023-06-26T20:51:24.4494016Z’ and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• objects_targeted_count (str) – Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• objects_operated_on_count (str) – Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• object_failed_count (str) – Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• objects_succeeded_count (str) – Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators.

• run_status_error (str) – Well known Azure Storage error code that represents the error encountered during execution of the run instance.

• run_status_enum (str or RunStatusEnum) – Represents the status of the execution. Known values are: “InProgress” and “Finished”.

• summary_report_path (str) – Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account.

• task_id (str) – Storage Task Arm Id.

• task_version (str) – Storage Task Version.

• run_result (str or RunResult) – Represents the overall result of the execution for the run instance. Known values are: “Succeeded” and “Failed”.

class azure.mgmt.storage.v2024_01_01.models.StorageTaskReportSummary(**kwargs: Any)

Bases: Model

Fetch Storage Tasks Run Summary.

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

Variables:

• value (list[StorageTaskReportInstance]) – Gets storage tasks run result summary.

• next_link (str) – Request URL that can be used to query next page of storage task run results summary. Returned when the number of run instances and summary reports exceed maximum page size.

class azure.mgmt.storage.v2024_01_01.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.storage.v2024_01_01.models.Table(*, signed_identifiers: List[_models.TableSignedIdentifier] | None = None, **kwargs: Any)

Bases: Resource

Properties of the table, including Id, resource name, resource type.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• table_name (str) – Table name under the specified account.

• signed_identifiers (list[TableSignedIdentifier]) – List of stored access policies specified on the table.

Keyword Arguments:

signed_identifiers (list[TableSignedIdentifier]) – List of stored access policies specified on the table.

class azure.mgmt.storage.v2024_01_01.models.TableAccessPolicy(*, permission: str, start_time: datetime | None = None, expiry_time: datetime | None = None, **kwargs: Any)

Bases: Model

Table Access Policy Properties Object.

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

Variables:

• start_time (datetime) – Start time of the access policy.

• expiry_time (datetime) – Expiry time of the access policy.

• permission (str) – Required. List of abbreviated permissions. Supported permission values include ‘r’,’a’,’u’,’d’. Required.

Keyword Arguments:

• start_time (datetime) – Start time of the access policy.

• expiry_time (datetime) – Expiry time of the access policy.

• permission (str) – Required. List of abbreviated permissions. Supported permission values include ‘r’,’a’,’u’,’d’. Required.

class azure.mgmt.storage.v2024_01_01.models.TableServiceProperties(*, cors: _models.CorsRules | None = None, **kwargs: Any)

Bases: Resource

The properties of a storage account’s Table service.

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}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

• cors (CorsRules) – Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service.

Keyword Arguments:

cors (CorsRules) – Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service.

class azure.mgmt.storage.v2024_01_01.models.TableSignedIdentifier(*, id: str, access_policy: _models.TableAccessPolicy | None = None, **kwargs: Any)

Bases: Model

Object to set Table Access Policy.

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

Variables:

• id (str) – unique-64-character-value of the stored access policy. Required.

• access_policy (TableAccessPolicy) – Access policy.

Keyword Arguments:

• id (str) – unique-64-character-value of the stored access policy. Required.

• access_policy (TableAccessPolicy) – Access policy.

class azure.mgmt.storage.v2024_01_01.models.TagFilter(*, name: str, op: str, value: str, **kwargs: Any)

Bases: Model

Blob index tag based filtering for blob objects.

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

Variables:

• name (str) – This is the filter tag name, it can have 1 - 128 characters. Required.

• op (str) – This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported. Required.

• value (str) – This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters. Required.

Keyword Arguments:

• name (str) – This is the filter tag name, it can have 1 - 128 characters. Required.

• op (str) – This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported. Required.

• value (str) – This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters. Required.

class azure.mgmt.storage.v2024_01_01.models.TagProperty(**kwargs: Any)

Bases: 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.v2024_01_01.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

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:

• id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

• name (str) – The name of the resource.

• type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

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

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

Keyword Arguments:

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

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

class azure.mgmt.storage.v2024_01_01.models.TriggerParameters(*, start_from: datetime | None = None, interval: int | None = None, interval_unit: Literal['Days'] | None = None, end_by: datetime | None = None, start_on: datetime | None = None, **kwargs: Any)

Bases: Model

The trigger parameters update for the storage task assignment execution.

Variables:

• start_from (datetime) – When to start task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval (int) – Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval_unit (str) – Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’. Default value is “Days”.

• end_by (datetime) – When to end task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• start_on (datetime) – When to start task execution. This is an optional field when ExecutionTrigger.properties.type is ‘RunOnce’; this property should not be present when ExecutionTrigger.properties.type is ‘OnSchedule’.

Keyword Arguments:

• start_from (datetime) – When to start task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval (int) – Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval_unit (str) – Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’. Default value is “Days”.

• end_by (datetime) – When to end task execution. This is a required field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• start_on (datetime) – When to start task execution. This is an optional field when ExecutionTrigger.properties.type is ‘RunOnce’; this property should not be present when ExecutionTrigger.properties.type is ‘OnSchedule’.

class azure.mgmt.storage.v2024_01_01.models.TriggerParametersUpdate(*, start_from: datetime | None = None, interval: int | None = None, interval_unit: Literal['Days'] | None = None, end_by: datetime | None = None, start_on: datetime | None = None, **kwargs: Any)

Bases: Model

The trigger parameters update for the storage task assignment execution.

Variables:

• start_from (datetime) – When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval (int) – Run interval of task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval_unit (str) – Run interval unit of task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’. Default value is “Days”.

• end_by (datetime) – When to end task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• start_on (datetime) – When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘RunOnce’; this property should not be present when ExecutionTrigger.properties.type is ‘OnSchedule’.

Keyword Arguments:

• start_from (datetime) – When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval (int) – Run interval of task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• interval_unit (str) – Run interval unit of task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’. Default value is “Days”.

• end_by (datetime) – When to end task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘OnSchedule’; this property should not be present when ExecutionTrigger.properties.type is ‘RunOnce’.

• start_on (datetime) – When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is ‘RunOnce’; this property should not be present when ExecutionTrigger.properties.type is ‘OnSchedule’.

class azure.mgmt.storage.v2024_01_01.models.TriggerType(*values)

Bases: str, Enum

The trigger type of the storage task assignment execution.

ON_SCHEDULE = 'OnSchedule'

RUN_ONCE = 'RunOnce'

class azure.mgmt.storage.v2024_01_01.models.UpdateHistoryProperty(*, allow_protected_append_writes: bool | None = None, allow_protected_append_writes_all: bool | None = None, **kwargs: Any)

Bases: 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. Known values are: “put”, “lock”, and “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.

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

Keyword Arguments:

• allow_protected_append_writes (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API.

• allow_protected_append_writes_all (bool) – This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive.

class azure.mgmt.storage.v2024_01_01.models.Usage(**kwargs: Any)

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.v2024_01_01.models.UsageListResult(*, value: List[_models.Usage] | None = None, **kwargs: Any)

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.v2024_01_01.models.UsageName(**kwargs: Any)

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.v2024_01_01.models.UsageUnit(*values)

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.v2024_01_01.models.UserAssignedIdentity(**kwargs: Any)

Bases: Model

UserAssignedIdentity for the resource.

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

Variables:

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

• client_id (str) – The client ID of the identity.

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

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