@azure/arm-storage package

model interface AccessPolicy

This defines account-level immutability policy properties.

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

The parameters to list SAS credentials of a storage account.

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

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

Settings properties for Active Directory (AD).

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

Settings for Azure Files identity based authentication.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BlobContainers operations.

Optional parameters.

Optional parameters.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a BlobInventoryPolicies operations.

The storage account blob inventory policy.

An object that defines the blob inventory rule.

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.

The storage account blob inventory policy properties.

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

The storage account blob inventory policy rules.

Blob restore parameters

Blob range

Blob restore status.

The properties of a storage account’s Blob service.

The properties of a storage account’s Blob service.

Optional parameters.

Optional parameters.

Interface representing a BlobServices operations.

Optional parameters.

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

The blob service properties for change feed events.

The CheckNameAvailability operation response.

An error response from the Storage service.

An error response from the Storage service.

A Connector is a tracked ARM resource modeled as a sub-resource of a Storage Account.

A Connector is a tracked ARM resource modeled as a sub-resource of a Storage Account.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Connectors operations.

Optional parameters.

Optional parameters.

The properties of a container.

Specifies a CORS rule for the Blob service.

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

The custom domain assigned to this storage account. This can be set via Update.

A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.

The connection details for Data Share source

The properties of data share source

The properties of data share source

A DataShare is a tracked ARM resource modeled as a sub-resource of a Storage Account.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DataShares operations.

Optional parameters.

Object to define snapshot and version action conditions.

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.

The service properties for soft delete.

Deleted storage account

Attributes of a deleted storage account.

Optional parameters.

Optional parameters.

Interface representing a DeletedAccounts operations.

The deleted share to be restored.

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

Dual-stack endpoint preference defines whether IPv6 endpoints are going to be published.

The encryption settings on the storage account.

Encryption identity for the storage account.

Encryption in transit setting.

The Encryption Scope resource.

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

Properties of the encryption scope.

Optional parameters.

Optional parameters.

Interface representing a EncryptionScopes operations.

Optional parameters.

Optional parameters.

A service that allows server-side encryption to be used.

A list of services that support encryption.

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object.

The resource management error additional info.

The error detail.

An error response from the storage resource provider.

Error response body contract.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

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

Execution trigger for storage task assignment

Execution trigger update for storage task assignment

The complex type of the extended location.

model interface FileServiceItems

The properties of File services in storage account.

The properties of File services in storage account.

The usage of file service in storage account.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FileServices operations.

Optional parameters.

Properties of the file share, including Id, resource name, resource type, Etag.

The file share properties be listed out.

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

The properties of the file share.

File Share Paid Bursting properties.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a FileShares operations.

Optional parameters.

Optional parameters.

Geo Priority Replication enablement status for the storage account.

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.

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

Identity for the resource.

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

The properties of an ImmutabilityPolicy of a blob container.

The properties of an ImmutabilityPolicy of a blob container.

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

Object level immutability properties of the container.

Storage account keys creation time.

KeyPolicy assigned to the storage account.

Properties of key vault.

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

Lease Container request schema.

Lease Container response schema.

Lease Share request schema.

Lease Share response schema.

The LegalHold property of a blob container.

The LegalHold property of a blob container.

The List SAS credentials operation response.

The blob container properties be listed out.

model interface ListQueue

model interface ListQueueProperties

model interface ListQueueServices

The List service SAS credentials operation response.

model interface ListTableServices

The local user associated with the storage accounts.

The Storage Account Local User keys.

The Storage Account Local User properties.

The secrets of Storage Account Local User.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LocalUsers operations.

Optional parameters.

The managed identity auth properties for dataShare connection.

The managed identity auth properties for dataShare connection.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ManagementPolicies operations.

The Get Storage Account ManagementPolicies operation response.

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

Management policy action for base blob.

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

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.

The Storage Account ManagementPolicy properties.

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

The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview.

Management policy action for snapshot.

Management policy action for blob version.

Metric specification of operation.

Multichannel setting. Applies to Premium FileStorage only.

Network rule set

NetworkSecurityPerimeter related information

The Network Security Perimeter configuration resource.

Properties of the Network Security Perimeter Configuration

Network Security Perimeter profile

Information about resource association

Optional parameters.

Optional parameters.

Interface representing a NetworkSecurityPerimeterConfigurations operations.

Optional parameters.

Setting for NFS protocol

Information of Access Rule in Network Security Perimeter profile

Properties of Access Rule

Subscription for inbound rule

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ObjectReplicationPolicies operations.

The replication policy between two storage accounts. Multiple rules can be defined in one policy.

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.

The Storage Account ObjectReplicationPolicy properties.

Optional. The object replication policy metrics feature options.

Optional. The object replication policy priority replication feature options.

Optional. The object replication policy tags replication feature options.

The replication policy rule between two containers.

Storage REST API operation definition.

Display metadata associated with the operation.

Properties of operation, include metric specifications.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

model interface PermissionScope

The complex type of the zonal placement details.

The Private Endpoint resource.

The Private Endpoint Connection resource.

Properties of the PrivateEndpointConnectProperties.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateEndpointConnections operations.

Optional parameters.

A private link resource

A list of private link resources

Properties of a private link resource.

Optional parameters.

Interface representing a PrivateLinkResources operations.

A collection of information about the state of the connection between service consumer and provider.

Protected append writes history setting for the blob container with Legal holds.

Protocol settings for file service

Describes provisioning issue for given NetworkSecurityPerimeterConfiguration

Properties of provisioning issue

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Queue operations.

model interface QueueProperties

The properties of a storage account’s Queue service.

The properties of a storage account’s Queue service.

Optional parameters.

Optional parameters.

Interface representing a QueueServices operations.

Optional parameters.

Optional parameters.

Common fields that are returned in the response for all Azure Resource Manager resources

Resource Access Rule.

The blob service properties for blob restore policy

The restriction because of which SKU cannot be used.

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

The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc.

SasPolicy assigned to the storage account.

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

Defines shared key access settings for an individual storage service.

One property of operation, include metric specifications.

model interface SignedIdentifier

A simple poller that can be used to poll a long running operation.

The SKU of the storage account.

Storage SKU and its properties

model interface SkuInformationLocationInfoItem

Optional parameters.

Interface representing a Skus operations.

Setting property for Managed Identity access over SMB using OAuth

Setting for SMB protocol

model interface SshPublicKey

The static website properties for blob storage.

The storage account.

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

The parameters used when creating a storage account.

The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via an IPv6 endpoint.

An access key for the storage account.

The response from the ListKeys operation.

The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.

The parameters or status associated with an ongoing or enqueued storage account migration in order to update its current SKU or region.

The properties of a storage account's ongoing or enqueued migration.

Properties of the storage account.

The parameters used to create the storage account.

The parameters used when updating a storage account.

The parameters used to regenerate the storage account key.

Defines shared key access properties for a storage account.

This defines the sku conversion status object for asynchronous sku conversions.

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a StorageAccounts operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The authentication properties of the backing data source

The authentication properties of the backing data source

The connection properties of the backing data source

The storage connector properties

The storage connector properties

The storage connector backing data source information

The storage connector backing data source information

Defines Data Collaboration Policy for a storage account.

Policy that specify the permission allowed to a managed identity

Properties of a shared resource.

The storage datashare properties

The storage datashare properties

Optional parameters for the client.

Concrete proxy resource types can be created by aliasing this type using a specific property type.

The storage task assignment.

Execution context of the storage task assignment.

Optional parameters.

Interface representing a StorageTaskAssignmentInstancesReport operations.

Properties of the storage task assignment.

The storage task assignment report

Execution context of the storage task assignment update.

Parameters of the storage task assignment update request

Properties of the storage task update assignment.

The storage task assignment report

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a StorageTaskAssignmentsInstancesReport operations.

Optional parameters.

Interface representing a StorageTaskAssignments operations.

Optional parameters.

Optional parameters.

Storage Tasks run report instance

Storage task execution report for a run instance.

Metadata pertaining to creation and last modification of the resource.

Properties of the table, including Id, resource name, resource type.

Table Access Policy Properties Object.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Table operations.

model interface TableProperties

The properties of a storage account’s Table service.

The properties of a storage account’s Table service.

Optional parameters.

Optional parameters.

Interface representing a TableServices operations.

Optional parameters.

Object to set Table Access Policy.

Optional parameters.

Blob index tag based filtering for blob objects

A tag of the LegalHold of a blob container.

Test connection response properties

Test existing connection request properties

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

The trigger parameters update for the storage task assignment execution

The trigger parameters update for the storage task assignment execution

An update history of the ImmutabilityPolicy of a blob container.

Describes Storage Resource Usage.

The usage names that can be used; currently limited to StorageAccount.

Optional parameters.

Interface representing a Usages operations.

UserAssignedIdentity for the resource.

Virtual Network rule.

The default access tier for block blobs in the storage account. Required for storage accounts where kind = BlobStorage. See more details in: https://learn.microsoft.com/azure/storage/blobs/access-tiers-overview.

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.
KnownAccountImmutabilityPolicyState can be used interchangeably with AccountImmutabilityPolicyState, this enum contains the known values that the service supports.

Known values supported by the service

Unlocked
Locked
Disabled

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

Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted.
KnownAccountType can be used interchangeably with AccountType, this enum contains the known values that the service supports.

Known values supported by the service

User
Computer

Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.
KnownAllowedCopyScope can be used interchangeably with AllowedCopyScope, this enum contains the known values that the service supports.

Known values supported by the service

PrivateLink
AAD
All

Type of AllowedMethods

The supported values for cloud setting as a string literal type

Type of BlobInventoryPolicyName

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.
KnownBlobRestoreProgressStatus can be used interchangeably with BlobRestoreProgressStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Complete
Failed

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.
KnownBypass can be used interchangeably with Bypass, this enum contains the known values that the service supports.

Known values supported by the service

None
Logging
Metrics
AzureServices

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

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

Default share permission for users using Kerberos authentication if RBAC role is not assigned.
KnownDefaultSharePermission can be used interchangeably with DefaultSharePermission, this enum contains the known values that the service supports.

Known values supported by the service

None
StorageFileDataSmbShareReader
StorageFileDataSmbShareContributor
StorageFileDataSmbShareElevatedContributor

Indicates the directory service used. Note that this enum may be extended in the future.
KnownDirectoryServiceOptions can be used interchangeably with DirectoryServiceOptions, this enum contains the known values that the service supports.

Known values supported by the service

None
AADDS
AD
AADKERB

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.
KnownDnsEndpointType can be used interchangeably with DnsEndpointType, this enum contains the known values that the service supports.

Known values supported by the service

Standard
AzureDnsZone

The authentication protocol that is used for the file share. Can only be specified when creating a share.
KnownEnabledProtocols can be used interchangeably with EnabledProtocols, this enum contains the known values that the service supports.

Known values supported by the service

SMB
NFS

The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault.
KnownEncryptionScopeSource can be used interchangeably with EncryptionScopeSource, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Storage
Microsoft.KeyVault

The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled.
KnownEncryptionScopeState can be used interchangeably with EncryptionScopeState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

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.
KnownExpirationAction can be used interchangeably with ExpirationAction, this enum contains the known values that the service supports.

Known values supported by the service

Log
Block

The type of extendedLocation.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone

This is a required field, it specifies the format for the inventory files.
KnownFormat can be used interchangeably with Format, this enum contains the known values that the service supports.

Known values supported by the service

Csv
Parquet

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.
KnownGeoReplicationStatus can be used interchangeably with GeoReplicationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Live
Bootstrap
Unavailable

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

The identity type.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked.
KnownImmutabilityPolicyState can be used interchangeably with ImmutabilityPolicyState, this enum contains the known values that the service supports.

Known values supported by the service

Locked
Unlocked

The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend.
KnownImmutabilityPolicyUpdateType can be used interchangeably with ImmutabilityPolicyUpdateType, this enum contains the known values that the service supports.

Known values supported by the service

put
lock
extend

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'
KnownIntervalUnit can be used interchangeably with IntervalUnit, this enum contains the known values that the service supports.

Known values supported by the service

Days

The valid value is Inventory
KnownInventoryRuleType can be used interchangeably with InventoryRuleType, this enum contains the known values that the service supports.

Known values supported by the service

Inventory

Type of issue
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
ConfigurationPropagationFailure

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

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault
KnownKeySource can be used interchangeably with KeySource, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Storage
Microsoft.Keyvault

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.
KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports.

Known values supported by the service

Service
Account

Indicates the type of storage account.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

Storage
StorageV2
BlobStorage
FileStorage
BlockBlobStorage

Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.
KnownLargeFileSharesState can be used interchangeably with LargeFileSharesState, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
Enabled

Specifies the lease action. Can be one of the available actions.
KnownLeaseContainerRequestAction can be used interchangeably with LeaseContainerRequestAction, this enum contains the known values that the service supports.

Known values supported by the service

Acquire
Renew
Change
Release
Break

Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased.
KnownLeaseDuration can be used interchangeably with LeaseDuration, this enum contains the known values that the service supports.

Known values supported by the service

Infinite
Fixed

Specifies the lease action. Can be one of the available actions.
KnownLeaseShareAction can be used interchangeably with LeaseShareAction, this enum contains the known values that the service supports.

Known values supported by the service

Acquire
Renew
Change
Release
Break

Lease state of the container.
KnownLeaseState can be used interchangeably with LeaseState, this enum contains the known values that the service supports.

Known values supported by the service

Available
Leased
Expired
Breaking
Broken

The lease status of the container.
KnownLeaseStatus can be used interchangeably with LeaseStatus, this enum contains the known values that the service supports.

Known values supported by the service

Locked
Unlocked

Type of ListContainersInclude

Type of ListEncryptionScopesInclude

Type of ListLocalUserIncludeParam

Type of ManagementPolicyName

Type of MigrationName

This property denotes the container level immutability to object level immutability migration state.
KnownMigrationState can be used interchangeably with MigrationState, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Completed

Current status of migration
KnownMigrationStatus can be used interchangeably with MigrationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
SubmittedForConversion
InProgress
Complete
Failed

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Minimum TLS version 1.3 version is not supported.
KnownMinimumTlsVersion can be used interchangeably with MinimumTlsVersion, this enum contains the known values that the service supports.

Known values supported by the service

TLS1_0
TLS1_1
TLS1_2
TLS1_3

Name of the policy. The valid value is AccessTimeTracking. This field is currently read only
KnownName can be used interchangeably with Name, this enum contains the known values that the service supports.

Known values supported by the service

AccessTimeTracking

Provisioning state of the resource at the time the operation was called.
KnownNativeDataSharingProvisioningState can be used interchangeably with NativeDataSharingProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted: The request has been accepted for processing.
Creating: The resource is being created.
Succeeded: The resource has been successfully created.
Deleting: The resource is being deleted.
Canceled: The request has been canceled.
Failed: The resource creation or deletion has failed.

Provisioning state of Network Security Perimeter configuration propagation
KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Accepted
Succeeded
Failed
Deleting
Canceled

Direction of Access Rule
KnownNspAccessRuleDirection can be used interchangeably with NspAccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound
Outbound

This is a required field. This field specifies the scope of the inventory created either at the blob or container level.
KnownObjectType can be used interchangeably with ObjectType, this enum contains the known values that the service supports.

Known values supported by the service

Blob
Container

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).
KnownPermissions can be used interchangeably with Permissions, this enum contains the known values that the service supports.

Known values supported by the service

r
d
w
l
a
c
u
p

The redundancy type of the account after an account failover is performed.
KnownPostFailoverRedundancy can be used interchangeably with PostFailoverRedundancy, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS
Standard_ZRS

The redundancy type of the account after a planned account failover is performed.
KnownPostPlannedFailoverRedundancy can be used interchangeably with PostPlannedFailoverRedundancy, this enum contains the known values that the service supports.

Known values supported by the service

Standard_GRS
Standard_GZRS
Standard_RAGRS
Standard_RAGZRS

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

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

Specifies whether data in the container may be accessed publicly and the level of access.

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'.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled
SecuredByPerimeter

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

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.
KnownReasonCode can be used interchangeably with ReasonCode, this enum contains the known values that the service supports.

Known values supported by the service

QuotaId
NotAvailableForSubscription

Access Mode of the resource association
KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Enforced
Learning
Audit

The property is for NFS share only. The default is NoRootSquash.
KnownRootSquashType can be used interchangeably with RootSquashType, this enum contains the known values that the service supports.

Known values supported by the service

NoRootSquash
RootSquash
AllSquash

Routing Choice defines the kind of network routing opted by the user.
KnownRoutingChoice can be used interchangeably with RoutingChoice, this enum contains the known values that the service supports.

Known values supported by the service

MicrosoftRouting
InternetRouting

The valid value is Lifecycle
KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports.

Known values supported by the service

Lifecycle

Represents the overall result of the execution for the run instance
KnownRunResult can be used interchangeably with RunResult, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Failed

Represents the status of the execution.
KnownRunStatusEnum can be used interchangeably with RunStatusEnum, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Finished

This is a required field. This field is used to schedule an inventory formation.
KnownSchedule can be used interchangeably with Schedule, this enum contains the known values that the service supports.

Known values supported by the service

Daily
Weekly

The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
KnownServices can be used interchangeably with Services, this enum contains the known values that the service supports.

Known values supported by the service

b
q
t
f

Severity of the issue.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Warning
Error

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
KnownShareAccessTier can be used interchangeably with ShareAccessTier, this enum contains the known values that the service supports.

Known values supported by the service

TransactionOptimized
Hot
Cool
Premium

The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).
KnownSignedResource can be used interchangeably with SignedResource, this enum contains the known values that the service supports.

Known values supported by the service

b
c
f
s

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.
KnownSignedResourceTypes can be used interchangeably with SignedResourceTypes, this enum contains the known values that the service supports.

Known values supported by the service

s
c
o

This property indicates the current sku conversion status.
KnownSkuConversionStatus can be used interchangeably with SkuConversionStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress
Succeeded
Failed

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

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
PremiumV2_ZRS

The SKU tier. This is based on the SKU name.

Gets the state of virtual network rule.
KnownState can be used interchangeably with State, this enum contains the known values that the service supports.

Known values supported by the service

Provisioning
Deprovisioning
Succeeded
Failed
NetworkSourceDeleted

Type of StorageAccountExpand

Alias for StorageConnectorAuthPropertiesUnion

Alias for StorageConnectorAuthPropertiesUpdateUnion

The auth type supported for bucket connection in storage connector.
KnownStorageConnectorAuthType can be used interchangeably with StorageConnectorAuthType, this enum contains the known values that the service supports.

Known values supported by the service

ManagedIdentity: Managed Identity auth type

The connection type for bucket connection in storage connector.
KnownStorageConnectorConnectionType can be used interchangeably with StorageConnectorConnectionType, this enum contains the known values that the service supports.

Known values supported by the service

DataShare: DataShare connection type

Alias for StorageConnectorConnectionUnion

The type of the backing data source for storage connector
KnownStorageConnectorDataSourceType can be used interchangeably with StorageConnectorDataSourceType, this enum contains the known values that the service supports.

Known values supported by the service

Azure_DataShare: Azure DataShare data source type.

The type of the backing data source for storage connector
KnownStorageConnectorSourceType can be used interchangeably with StorageConnectorSourceType, this enum contains the known values that the service supports.

Known values supported by the service

DataShare: Source type - DataShare

Alias for StorageConnectorSourceUnion

Alias for StorageConnectorSourceUpdateUnion

The state of the storage connector
KnownStorageConnectorState can be used interchangeably with StorageConnectorState, this enum contains the known values that the service supports.

Known values supported by the service

Active: Whether the connector is active
Inactive: Whether the connector is inactive

The permissions supported in access policies for storage data share
KnownStorageDataShareAccessPolicyPermission can be used interchangeably with StorageDataShareAccessPolicyPermission, this enum contains the known values that the service supports.

Known values supported by the service

None: No permission
Read: Read permission

Gets the status of the storage account at the time the operation was called.
KnownStorageTaskAssignmentProvisioningState can be used interchangeably with StorageTaskAssignmentProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

ValidateSubscriptionQuotaBegin
ValidateSubscriptionQuotaEnd
Accepted
Creating
Succeeded
Deleting
Canceled
Failed

The trigger type of the storage task assignment execution
KnownTriggerType can be used interchangeably with TriggerType, this enum contains the known values that the service supports.

Known values supported by the service

RunOnce
OnSchedule
MockRun: Run the task as a mock for testing

Gets the unit of measurement.

The availability zone pinning policy for the storage account.
KnownZonePlacementPolicy can be used interchangeably with ZonePlacementPolicy, this enum contains the known values that the service supports.

Known values supported by the service

Any
None

An enum to describe Azure Cloud environments.

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.

Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted.

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

Known values of AllowedMethods that the service accepts.

Known values of BlobInventoryPolicyName that the service accepts.

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.

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.

The kind of entity that created the resource.

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

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

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.

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

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

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

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.

The type of extendedLocation.

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

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.

The identity type.

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

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

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'

The valid value is Inventory

Type of issue

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

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.

Indicates the type of storage account.

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

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

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

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

Lease state of the container.

The lease status of the container.

Known values of ListContainersInclude that the service accepts.

Known values of ListEncryptionScopesInclude that the service accepts.

Known values of ListLocalUserIncludeParam that the service accepts.

Known values of ManagementPolicyName that the service accepts.

Known values of MigrationName that the service accepts.

This property denotes the container level immutability to object level immutability migration state.

Current status of migration

Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Minimum TLS version 1.3 version is not supported.

Name of the policy. The valid value is AccessTimeTracking. This field is currently read only

Provisioning state of the resource at the time the operation was called.

Provisioning state of Network Security Perimeter configuration propagation

Direction of Access Rule

This is a required field. This field specifies the scope of the inventory created either at the blob or container level.

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

The redundancy type of the account after an account failover is performed.

The redundancy type of the account after a planned account failover is performed.

The current provisioning state.

The private endpoint connection status.

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

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.

Access Mode of the resource association

The property is for NFS share only. The default is NoRootSquash.

Routing Choice defines the kind of network routing opted by the user.

The valid value is Lifecycle

Represents the overall result of the execution for the run instance

Represents the status of the execution.

This is a required field. This field is used to schedule an inventory formation.

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

Severity of the issue.

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

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

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.

This property indicates the current sku conversion status.

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

Gets the state of virtual network rule.

The auth type supported for bucket connection in storage connector.

The connection type for bucket connection in storage connector.

The type of the backing data source for storage connector

The type of the backing data source for storage connector

The state of the storage connector

The permissions supported in access policies for storage data share

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

The trigger type of the storage task assignment execution

The available API versions.

The availability zone pinning policy for the storage account.

Typeguard for RestError

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

A custom error type for failed pipeline requests.