@azure/arm-storage package

Classes

StorageManagementClient

Interfaces

AccessPolicy
AccountImmutabilityPolicyProperties

This defines account-level immutability policy properties.

AccountSasParameters

The parameters to list SAS credentials of a storage account.

ActiveDirectoryProperties

Settings properties for Active Directory (AD).

AzureEntityResource

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

AzureFilesIdentityBasedAuthentication

Settings for Azure Files identity based authentication.

BlobContainer

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

BlobContainers

Interface representing a BlobContainers.

BlobContainersClearLegalHoldOptionalParams

Optional parameters.

BlobContainersCreateOptionalParams

Optional parameters.

BlobContainersCreateOrUpdateImmutabilityPolicyHeaders

Defines headers for BlobContainers_createOrUpdateImmutabilityPolicy operation.

BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams

Optional parameters.

BlobContainersDeleteImmutabilityPolicyHeaders

Defines headers for BlobContainers_deleteImmutabilityPolicy operation.

BlobContainersDeleteImmutabilityPolicyOptionalParams

Optional parameters.

BlobContainersDeleteOptionalParams

Optional parameters.

BlobContainersExtendImmutabilityPolicyHeaders

Defines headers for BlobContainers_extendImmutabilityPolicy operation.

BlobContainersExtendImmutabilityPolicyOptionalParams

Optional parameters.

BlobContainersGetImmutabilityPolicyHeaders

Defines headers for BlobContainers_getImmutabilityPolicy operation.

BlobContainersGetImmutabilityPolicyOptionalParams

Optional parameters.

BlobContainersGetOptionalParams

Optional parameters.

BlobContainersLeaseOptionalParams

Optional parameters.

BlobContainersListNextOptionalParams

Optional parameters.

BlobContainersListOptionalParams

Optional parameters.

BlobContainersLockImmutabilityPolicyHeaders

Defines headers for BlobContainers_lockImmutabilityPolicy operation.

BlobContainersLockImmutabilityPolicyOptionalParams

Optional parameters.

BlobContainersObjectLevelWormOptionalParams

Optional parameters.

BlobContainersSetLegalHoldOptionalParams

Optional parameters.

BlobContainersUpdateOptionalParams

Optional parameters.

BlobInventoryCreationTime

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

BlobInventoryPolicies

Interface representing a BlobInventoryPolicies.

BlobInventoryPoliciesCreateOrUpdateOptionalParams

Optional parameters.

BlobInventoryPoliciesDeleteOptionalParams

Optional parameters.

BlobInventoryPoliciesGetOptionalParams

Optional parameters.

BlobInventoryPoliciesListOptionalParams

Optional parameters.

BlobInventoryPolicy

The storage account blob inventory policy.

BlobInventoryPolicyDefinition

An object that defines the blob inventory rule.

BlobInventoryPolicyFilter

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.

BlobInventoryPolicyRule

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

BlobInventoryPolicySchema

The storage account blob inventory policy rules.

BlobRestoreParameters

Blob restore parameters

BlobRestoreRange

Blob range

BlobRestoreStatus

Blob restore status.

BlobServiceItems
BlobServiceProperties

The properties of a storage account’s Blob service.

BlobServices

Interface representing a BlobServices.

BlobServicesGetServicePropertiesOptionalParams

Optional parameters.

BlobServicesListOptionalParams

Optional parameters.

BlobServicesSetServicePropertiesOptionalParams

Optional parameters.

ChangeFeed

The blob service properties for change feed events.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

CloudError

An error response from the Storage service.

CloudErrorBody

An error response from the Storage service.

CorsRule

Specifies a CORS rule for the Blob service.

CorsRules

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

CustomDomain

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

DateAfterCreation

Object to define snapshot and version action conditions.

DateAfterModification

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.

DeleteRetentionPolicy

The service properties for soft delete.

DeletedAccount

Deleted storage account

DeletedAccountListResult

The response from the List Deleted Accounts operation.

DeletedAccounts

Interface representing a DeletedAccounts.

DeletedAccountsGetOptionalParams

Optional parameters.

DeletedAccountsListNextOptionalParams

Optional parameters.

DeletedAccountsListOptionalParams

Optional parameters.

DeletedShare

The deleted share to be restored.

Dimension

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

Encryption

The encryption settings on the storage account.

EncryptionIdentity

Encryption identity for the storage account.

EncryptionScope

The Encryption Scope resource.

EncryptionScopeKeyVaultProperties

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

EncryptionScopeListResult

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

EncryptionScopes

Interface representing a EncryptionScopes.

EncryptionScopesGetOptionalParams

Optional parameters.

EncryptionScopesListNextOptionalParams

Optional parameters.

EncryptionScopesListOptionalParams

Optional parameters.

EncryptionScopesPatchOptionalParams

Optional parameters.

EncryptionScopesPutOptionalParams

Optional parameters.

EncryptionService

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

EncryptionServices

A list of services that support encryption.

Endpoints

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

An error response from the storage resource provider.

ErrorResponseAutoGenerated

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

ErrorResponseBody

Error response body contract.

ExtendedLocation

The complex type of the extended location.

FileServiceItems
FileServiceProperties

The properties of File services in storage account.

FileServices

Interface representing a FileServices.

FileServicesGetServicePropertiesOptionalParams

Optional parameters.

FileServicesListOptionalParams

Optional parameters.

FileServicesSetServicePropertiesOptionalParams

Optional parameters.

FileShare

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

FileShareItem

The file share properties be listed out.

FileShareItems

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

FileShares

Interface representing a FileShares.

FileSharesCreateOptionalParams

Optional parameters.

FileSharesDeleteOptionalParams

Optional parameters.

FileSharesGetOptionalParams

Optional parameters.

FileSharesLeaseHeaders

Defines headers for FileShares_lease operation.

FileSharesLeaseOptionalParams

Optional parameters.

FileSharesListNextOptionalParams

Optional parameters.

FileSharesListOptionalParams

Optional parameters.

FileSharesRestoreOptionalParams

Optional parameters.

FileSharesUpdateOptionalParams

Optional parameters.

GeoReplicationStats

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.

IPRule

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

Identity

Identity for the resource.

ImmutabilityPolicy

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

ImmutabilityPolicyProperties

The properties of an ImmutabilityPolicy of a blob container.

ImmutableStorageAccount

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

ImmutableStorageWithVersioning

Object level immutability properties of the container.

KeyCreationTime

Storage account keys creation time.

KeyPolicy

KeyPolicy assigned to the storage account.

KeyVaultProperties

Properties of key vault.

LastAccessTimeTrackingPolicy

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

LeaseContainerRequest

Lease Container request schema.

LeaseContainerResponse

Lease Container response schema.

LeaseShareRequest

Lease Share request schema.

LeaseShareResponse

Lease Share response schema.

LegalHold

The LegalHold property of a blob container.

LegalHoldProperties

The LegalHold property of a blob container.

ListAccountSasResponse

The List SAS credentials operation response.

ListBlobInventoryPolicy

List of blob inventory policies returned.

ListContainerItem

The blob container properties be listed out.

ListContainerItems

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

ListQueue

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

ListQueueResource

Response schema. Contains list of queues returned

ListQueueServices
ListServiceSasResponse

The List service SAS credentials operation response.

ListTableResource

Response schema. Contains list of tables returned

ListTableServices
LocalUser

The local user associated with the storage accounts.

LocalUserKeys

The Storage Account Local User keys.

LocalUserRegeneratePasswordResult

The secrets of Storage Account Local User.

LocalUsers

List storage account local users.

LocalUsersCreateOrUpdateOptionalParams

Optional parameters.

LocalUsersDeleteOptionalParams

Optional parameters.

LocalUsersGetOptionalParams

Optional parameters.

LocalUsersListKeysOptionalParams

Optional parameters.

LocalUsersListOptionalParams

Optional parameters.

LocalUsersOperations

Interface representing a LocalUsersOperations.

LocalUsersRegeneratePasswordOptionalParams

Optional parameters.

ManagementPolicies

Interface representing a ManagementPolicies.

ManagementPoliciesCreateOrUpdateOptionalParams

Optional parameters.

ManagementPoliciesDeleteOptionalParams

Optional parameters.

ManagementPoliciesGetOptionalParams

Optional parameters.

ManagementPolicy

The Get Storage Account ManagementPolicies operation response.

ManagementPolicyAction

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

ManagementPolicyBaseBlob

Management policy action for base blob.

ManagementPolicyDefinition

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

ManagementPolicyFilter

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.

ManagementPolicyRule

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

ManagementPolicySchema

The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.

ManagementPolicySnapShot

Management policy action for snapshot.

ManagementPolicyVersion

Management policy action for blob version.

MetricSpecification

Metric specification of operation.

Multichannel

Multichannel setting. Applies to Premium FileStorage only.

NetworkRuleSet

Network rule set

ObjectReplicationPolicies

List storage account object replication policies.

ObjectReplicationPoliciesCreateOrUpdateOptionalParams

Optional parameters.

ObjectReplicationPoliciesDeleteOptionalParams

Optional parameters.

ObjectReplicationPoliciesGetOptionalParams

Optional parameters.

ObjectReplicationPoliciesListOptionalParams

Optional parameters.

ObjectReplicationPoliciesOperations

Interface representing a ObjectReplicationPoliciesOperations.

ObjectReplicationPolicy

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

ObjectReplicationPolicyFilter

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.

ObjectReplicationPolicyRule

The replication policy rule between two containers.

Operation

Storage REST API operation definition.

OperationDisplay

Display metadata associated with the operation.

OperationListResult

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.

Operations

Interface representing a Operations.

OperationsListOptionalParams

Optional parameters.

PermissionScope
PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateEndpointConnectionsPutOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesListByStorageAccountOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

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

ProtectedAppendWritesHistory

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

ProtocolSettings

Protocol settings for file service

ProxyResource

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

Queue

Interface representing a Queue.

QueueCreateOptionalParams

Optional parameters.

QueueDeleteOptionalParams

Optional parameters.

QueueGetOptionalParams

Optional parameters.

QueueListNextOptionalParams

Optional parameters.

QueueListOptionalParams

Optional parameters.

QueueServiceProperties

The properties of a storage account’s Queue service.

QueueServices

Interface representing a QueueServices.

QueueServicesGetServicePropertiesOptionalParams

Optional parameters.

QueueServicesListOptionalParams

Optional parameters.

QueueServicesSetServicePropertiesOptionalParams

Optional parameters.

QueueUpdateOptionalParams

Optional parameters.

Resource

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

ResourceAccessRule

Resource Access Rule.

RestorePolicyProperties

The blob service properties for blob restore policy

Restriction

The restriction because of which SKU cannot be used.

RoutingPreference

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

SKUCapability

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

SasPolicy

SasPolicy assigned to the storage account.

ServiceSasParameters

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

ServiceSpecification

One property of operation, include metric specifications.

SignedIdentifier
Sku

The SKU of the storage account.

SkuInformation

Storage SKU and its properties

Skus

Interface representing a Skus.

SkusListOptionalParams

Optional parameters.

SmbSetting

Setting for SMB protocol

SshPublicKey
StorageAccount

The storage account.

StorageAccountCheckNameAvailabilityParameters

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

StorageAccountCreateParameters

The parameters used when creating a storage account.

StorageAccountInternetEndpoints

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

StorageAccountKey

An access key for the storage account.

StorageAccountListKeysResult

The response from the ListKeys operation.

StorageAccountListResult

The response from the List Storage Accounts operation.

StorageAccountMicrosoftEndpoints

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

StorageAccountMigration

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

StorageAccountRegenerateKeyParameters

The parameters used to regenerate the storage account key.

StorageAccountSkuConversionStatus

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

StorageAccountUpdateParameters

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

StorageAccounts

Interface representing a StorageAccounts.

StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams

Optional parameters.

StorageAccountsCheckNameAvailabilityOptionalParams

Optional parameters.

StorageAccountsCreateOptionalParams

Optional parameters.

StorageAccountsCustomerInitiatedMigrationHeaders

Defines headers for StorageAccounts_customerInitiatedMigration operation.

StorageAccountsCustomerInitiatedMigrationOptionalParams

Optional parameters.

StorageAccountsDeleteOptionalParams

Optional parameters.

StorageAccountsFailoverOptionalParams

Optional parameters.

StorageAccountsGetCustomerInitiatedMigrationOptionalParams

Optional parameters.

StorageAccountsGetPropertiesOptionalParams

Optional parameters.

StorageAccountsHierarchicalNamespaceMigrationOptionalParams

Optional parameters.

StorageAccountsListAccountSASOptionalParams

Optional parameters.

StorageAccountsListByResourceGroupNextOptionalParams

Optional parameters.

StorageAccountsListByResourceGroupOptionalParams

Optional parameters.

StorageAccountsListKeysOptionalParams

Optional parameters.

StorageAccountsListNextOptionalParams

Optional parameters.

StorageAccountsListOptionalParams

Optional parameters.

StorageAccountsListServiceSASOptionalParams

Optional parameters.

StorageAccountsRegenerateKeyOptionalParams

Optional parameters.

StorageAccountsRestoreBlobRangesOptionalParams

Optional parameters.

StorageAccountsRevokeUserDelegationKeysOptionalParams

Optional parameters.

StorageAccountsUpdateOptionalParams

Optional parameters.

StorageManagementClientOptionalParams

Optional parameters.

StorageQueue

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

StorageSkuListResult

The response from the List Storage SKUs operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

Table

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

TableAccessPolicy

Table Access Policy Properties Object.

TableCreateOptionalParams

Optional parameters.

TableDeleteOptionalParams

Optional parameters.

TableGetOptionalParams

Optional parameters.

TableListNextOptionalParams

Optional parameters.

TableListOptionalParams

Optional parameters.

TableOperations

Interface representing a TableOperations.

TableServiceProperties

The properties of a storage account’s Table service.

TableServices

Interface representing a TableServices.

TableServicesGetServicePropertiesOptionalParams

Optional parameters.

TableServicesListOptionalParams

Optional parameters.

TableServicesSetServicePropertiesOptionalParams

Optional parameters.

TableSignedIdentifier

Object to set Table Access Policy.

TableUpdateOptionalParams

Optional parameters.

TagFilter

Blob index tag based filtering for blob objects

TagProperty

A tag of the LegalHold of a blob container.

TrackedResource

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

UpdateHistoryProperty

An update history of the ImmutabilityPolicy of a blob container.

Usage

Describes Storage Resource Usage.

UsageListResult

The response from the List Usages operation.

UsageName

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

Usages

Interface representing a Usages.

UsagesListByLocationOptionalParams

Optional parameters.

UserAssignedIdentity

UserAssignedIdentity for the resource.

VirtualNetworkRule

Virtual Network rule.

Type Aliases

AccessTier

Defines values for AccessTier.

AccountImmutabilityPolicyState

Defines values for AccountImmutabilityPolicyState.
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

AccountStatus

Defines values for AccountStatus.

AccountType

Defines values for AccountType.
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

AllowedCopyScope

Defines values for AllowedCopyScope.
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

AllowedMethods

Defines values for AllowedMethods.
KnownAllowedMethods can be used interchangeably with AllowedMethods, this enum contains the known values that the service supports.

Known values supported by the service

DELETE
GET
HEAD
MERGE
POST
OPTIONS
PUT
PATCH
CONNECT
TRACE

BlobContainersClearLegalHoldResponse

Contains response data for the clearLegalHold operation.

BlobContainersCreateOrUpdateImmutabilityPolicyResponse

Contains response data for the createOrUpdateImmutabilityPolicy operation.

BlobContainersCreateResponse

Contains response data for the create operation.

BlobContainersDeleteImmutabilityPolicyResponse

Contains response data for the deleteImmutabilityPolicy operation.

BlobContainersExtendImmutabilityPolicyResponse

Contains response data for the extendImmutabilityPolicy operation.

BlobContainersGetImmutabilityPolicyResponse

Contains response data for the getImmutabilityPolicy operation.

BlobContainersGetResponse

Contains response data for the get operation.

BlobContainersLeaseResponse

Contains response data for the lease operation.

BlobContainersListNextResponse

Contains response data for the listNext operation.

BlobContainersListResponse

Contains response data for the list operation.

BlobContainersLockImmutabilityPolicyResponse

Contains response data for the lockImmutabilityPolicy operation.

BlobContainersSetLegalHoldResponse

Contains response data for the setLegalHold operation.

BlobContainersUpdateResponse

Contains response data for the update operation.

BlobInventoryPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

BlobInventoryPoliciesGetResponse

Contains response data for the get operation.

BlobInventoryPoliciesListResponse

Contains response data for the list operation.

BlobInventoryPolicyName

Defines values for BlobInventoryPolicyName.
KnownBlobInventoryPolicyName can be used interchangeably with BlobInventoryPolicyName, this enum contains the known values that the service supports.

Known values supported by the service

default

BlobRestoreProgressStatus

Defines values for BlobRestoreProgressStatus.
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

BlobServicesGetServicePropertiesResponse

Contains response data for the getServiceProperties operation.

BlobServicesListResponse

Contains response data for the list operation.

BlobServicesSetServicePropertiesResponse

Contains response data for the setServiceProperties operation.

Bypass

Defines values for Bypass.
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

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DefaultAction

Defines values for DefaultAction.

DefaultSharePermission

Defines values for DefaultSharePermission.
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

DeletedAccountsGetResponse

Contains response data for the get operation.

DeletedAccountsListNextResponse

Contains response data for the listNext operation.

DeletedAccountsListResponse

Contains response data for the list operation.

DirectoryServiceOptions

Defines values for DirectoryServiceOptions.
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

DnsEndpointType

Defines values for DnsEndpointType.
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

EnabledProtocols

Defines values for EnabledProtocols.
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

EncryptionScopeSource

Defines values for EncryptionScopeSource.
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

EncryptionScopeState

Defines values for EncryptionScopeState.
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

EncryptionScopesGetResponse

Contains response data for the get operation.

EncryptionScopesListNextResponse

Contains response data for the listNext operation.

EncryptionScopesListResponse

Contains response data for the list operation.

EncryptionScopesPatchResponse

Contains response data for the patch operation.

EncryptionScopesPutResponse

Contains response data for the put operation.

ExpirationAction

Defines values for ExpirationAction.
KnownExpirationAction can be used interchangeably with ExpirationAction, this enum contains the known values that the service supports.

Known values supported by the service

Log

ExtendedLocationTypes

Defines values for ExtendedLocationTypes.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone

FileServicesGetServicePropertiesResponse

Contains response data for the getServiceProperties operation.

FileServicesListResponse

Contains response data for the list operation.

FileServicesSetServicePropertiesResponse

Contains response data for the setServiceProperties operation.

FileSharesCreateResponse

Contains response data for the create operation.

FileSharesGetResponse

Contains response data for the get operation.

FileSharesLeaseResponse

Contains response data for the lease operation.

FileSharesListNextResponse

Contains response data for the listNext operation.

FileSharesListResponse

Contains response data for the list operation.

FileSharesUpdateResponse

Contains response data for the update operation.

Format

Defines values for Format.
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

GeoReplicationStatus

Defines values for GeoReplicationStatus.
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

HttpProtocol

Defines values for HttpProtocol.

IdentityType

Defines values for IdentityType.
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

ImmutabilityPolicyState

Defines values for ImmutabilityPolicyState.
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

ImmutabilityPolicyUpdateType

Defines values for ImmutabilityPolicyUpdateType.
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

InventoryRuleType

Defines values for InventoryRuleType.
KnownInventoryRuleType can be used interchangeably with InventoryRuleType, this enum contains the known values that the service supports.

Known values supported by the service

Inventory

KeyPermission

Defines values for KeyPermission.

KeySource

Defines values for KeySource.
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

KeyType

Defines values for KeyType.
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

Kind

Defines values for Kind.
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

LargeFileSharesState

Defines values for LargeFileSharesState.
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

LeaseContainerRequestAction

Defines values for LeaseContainerRequestAction.
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

LeaseDuration

Defines values for LeaseDuration.
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

LeaseShareAction

Defines values for LeaseShareAction.
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

LeaseState

Defines values for LeaseState.
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

LeaseStatus

Defines values for LeaseStatus.
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

ListContainersInclude

Defines values for ListContainersInclude.
KnownListContainersInclude can be used interchangeably with ListContainersInclude, this enum contains the known values that the service supports.

Known values supported by the service

deleted

ListEncryptionScopesInclude

Defines values for ListEncryptionScopesInclude.
KnownListEncryptionScopesInclude can be used interchangeably with ListEncryptionScopesInclude, this enum contains the known values that the service supports.

Known values supported by the service

All
Enabled
Disabled

LocalUsersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

LocalUsersGetResponse

Contains response data for the get operation.

LocalUsersListKeysResponse

Contains response data for the listKeys operation.

LocalUsersListResponse

Contains response data for the list operation.

LocalUsersRegeneratePasswordResponse

Contains response data for the regeneratePassword operation.

ManagementPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ManagementPoliciesGetResponse

Contains response data for the get operation.

ManagementPolicyName

Defines values for ManagementPolicyName.
KnownManagementPolicyName can be used interchangeably with ManagementPolicyName, this enum contains the known values that the service supports.

Known values supported by the service

default

MigrationName

Defines values for MigrationName.
KnownMigrationName can be used interchangeably with MigrationName, this enum contains the known values that the service supports.

Known values supported by the service

default

MigrationState

Defines values for MigrationState.
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

MigrationStatus

Defines values for MigrationStatus.
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

MinimumTlsVersion

Defines values for MinimumTlsVersion.
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

Name

Defines values for Name.
KnownName can be used interchangeably with Name, this enum contains the known values that the service supports.

Known values supported by the service

AccessTimeTracking

ObjectReplicationPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ObjectReplicationPoliciesGetResponse

Contains response data for the get operation.

ObjectReplicationPoliciesListResponse

Contains response data for the list operation.

ObjectType

Defines values for ObjectType.
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

OperationsListResponse

Contains response data for the list operation.

Permissions

Defines values for Permissions.
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

PostFailoverRedundancy

Defines values for PostFailoverRedundancy.
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

PostPlannedFailoverRedundancy

Defines values for PostPlannedFailoverRedundancy.
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

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
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

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionsPutResponse

Contains response data for the put operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
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

PrivateLinkResourcesListByStorageAccountResponse

Contains response data for the listByStorageAccount operation.

ProvisioningState

Defines values for ProvisioningState.

PublicAccess

Defines values for PublicAccess.

PublicNetworkAccess

Defines values for PublicNetworkAccess.
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

QueueCreateResponse

Contains response data for the create operation.

QueueGetResponse

Contains response data for the get operation.

QueueListNextResponse

Contains response data for the listNext operation.

QueueListResponse

Contains response data for the list operation.

QueueServicesGetServicePropertiesResponse

Contains response data for the getServiceProperties operation.

QueueServicesListResponse

Contains response data for the list operation.

QueueServicesSetServicePropertiesResponse

Contains response data for the setServiceProperties operation.

QueueUpdateResponse

Contains response data for the update operation.

Reason

Defines values for Reason.

ReasonCode

Defines values for ReasonCode.
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

RootSquashType

Defines values for RootSquashType.
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

RoutingChoice

Defines values for RoutingChoice.
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

RuleType

Defines values for RuleType.
KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports.

Known values supported by the service

Lifecycle

Schedule

Defines values for Schedule.
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

Services

Defines values for Services.
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

ShareAccessTier

Defines values for ShareAccessTier.
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

SignedResource

Defines values for SignedResource.
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

SignedResourceTypes

Defines values for SignedResourceTypes.
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

SkuConversionStatus

Defines values for SkuConversionStatus.
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

SkuName

Defines values for SkuName.
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

SkuTier

Defines values for SkuTier.

SkusListResponse

Contains response data for the list operation.

State

Defines values for State.
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

StorageAccountExpand

Defines values for StorageAccountExpand.

StorageAccountsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

StorageAccountsCreateResponse

Contains response data for the create operation.

StorageAccountsGetCustomerInitiatedMigrationResponse

Contains response data for the getCustomerInitiatedMigration operation.

StorageAccountsGetPropertiesResponse

Contains response data for the getProperties operation.

StorageAccountsListAccountSASResponse

Contains response data for the listAccountSAS operation.

StorageAccountsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

StorageAccountsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

StorageAccountsListKeysResponse

Contains response data for the listKeys operation.

StorageAccountsListNextResponse

Contains response data for the listNext operation.

StorageAccountsListResponse

Contains response data for the list operation.

StorageAccountsListServiceSASResponse

Contains response data for the listServiceSAS operation.

StorageAccountsRegenerateKeyResponse

Contains response data for the regenerateKey operation.

StorageAccountsRestoreBlobRangesResponse

Contains response data for the restoreBlobRanges operation.

StorageAccountsUpdateResponse

Contains response data for the update operation.

TableCreateResponse

Contains response data for the create operation.

TableGetResponse

Contains response data for the get operation.

TableListNextResponse

Contains response data for the listNext operation.

TableListResponse

Contains response data for the list operation.

TableServicesGetServicePropertiesResponse

Contains response data for the getServiceProperties operation.

TableServicesListResponse

Contains response data for the list operation.

TableServicesSetServicePropertiesResponse

Contains response data for the setServiceProperties operation.

TableUpdateResponse

Contains response data for the update operation.

UsageUnit

Defines values for UsageUnit.

UsagesListByLocationResponse

Contains response data for the listByLocation operation.

Enums

KnownAccountImmutabilityPolicyState

Known values of AccountImmutabilityPolicyState that the service accepts.

KnownAccountType

Known values of AccountType that the service accepts.

KnownAllowedCopyScope

Known values of AllowedCopyScope that the service accepts.

KnownAllowedMethods

Known values of AllowedMethods that the service accepts.

KnownBlobInventoryPolicyName

Known values of BlobInventoryPolicyName that the service accepts.

KnownBlobRestoreProgressStatus

Known values of BlobRestoreProgressStatus that the service accepts.

KnownBypass

Known values of Bypass that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDefaultSharePermission

Known values of DefaultSharePermission that the service accepts.

KnownDirectoryServiceOptions

Known values of DirectoryServiceOptions that the service accepts.

KnownDnsEndpointType

Known values of DnsEndpointType that the service accepts.

KnownEnabledProtocols

Known values of EnabledProtocols that the service accepts.

KnownEncryptionScopeSource

Known values of EncryptionScopeSource that the service accepts.

KnownEncryptionScopeState

Known values of EncryptionScopeState that the service accepts.

KnownExpirationAction

Known values of ExpirationAction that the service accepts.

KnownExtendedLocationTypes

Known values of ExtendedLocationTypes that the service accepts.

KnownFormat

Known values of Format that the service accepts.

KnownGeoReplicationStatus

Known values of GeoReplicationStatus that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownImmutabilityPolicyState

Known values of ImmutabilityPolicyState that the service accepts.

KnownImmutabilityPolicyUpdateType

Known values of ImmutabilityPolicyUpdateType that the service accepts.

KnownInventoryRuleType

Known values of InventoryRuleType that the service accepts.

KnownKeySource

Known values of KeySource that the service accepts.

KnownKeyType

Known values of KeyType that the service accepts.

KnownKind

Known values of Kind that the service accepts.

KnownLargeFileSharesState

Known values of LargeFileSharesState that the service accepts.

KnownLeaseContainerRequestAction

Known values of LeaseContainerRequestAction that the service accepts.

KnownLeaseDuration

Known values of LeaseDuration that the service accepts.

KnownLeaseShareAction

Known values of LeaseShareAction that the service accepts.

KnownLeaseState

Known values of LeaseState that the service accepts.

KnownLeaseStatus

Known values of LeaseStatus that the service accepts.

KnownListContainersInclude

Known values of ListContainersInclude that the service accepts.

KnownListEncryptionScopesInclude

Known values of ListEncryptionScopesInclude that the service accepts.

KnownManagementPolicyName

Known values of ManagementPolicyName that the service accepts.

KnownMigrationName

Known values of MigrationName that the service accepts.

KnownMigrationState

Known values of MigrationState that the service accepts.

KnownMigrationStatus

Known values of MigrationStatus that the service accepts.

KnownMinimumTlsVersion

Known values of MinimumTlsVersion that the service accepts.

KnownName

Known values of Name that the service accepts.

KnownObjectType

Known values of ObjectType that the service accepts.

KnownPermissions

Known values of Permissions that the service accepts.

KnownPostFailoverRedundancy

Known values of PostFailoverRedundancy that the service accepts.

KnownPostPlannedFailoverRedundancy

Known values of PostPlannedFailoverRedundancy that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownReasonCode

Known values of ReasonCode that the service accepts.

KnownRootSquashType

Known values of RootSquashType that the service accepts.

KnownRoutingChoice

Known values of RoutingChoice that the service accepts.

KnownRuleType

Known values of RuleType that the service accepts.

KnownSchedule

Known values of Schedule that the service accepts.

KnownServices

Known values of Services that the service accepts.

KnownShareAccessTier

Known values of ShareAccessTier that the service accepts.

KnownSignedResource

Known values of SignedResource that the service accepts.

KnownSignedResourceTypes

Known values of SignedResourceTypes that the service accepts.

KnownSkuConversionStatus

Known values of SkuConversionStatus that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownState

Known values of State that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.