@azure/arm-storage package

Classes

BlobContainers

Class representing a BlobContainers.

BlobInventoryPolicies

Class representing a BlobInventoryPolicies.

BlobServices

Class representing a BlobServices.

DeletedAccounts

Class representing a DeletedAccounts.

EncryptionScopes

Class representing a EncryptionScopes.

FileServices

Class representing a FileServices.

FileShares

Class representing a FileShares.

ManagementPolicies

Class representing a ManagementPolicies.

ObjectReplicationPoliciesOperations

Class representing a ObjectReplicationPoliciesOperations.

Operations

Class representing a Operations.

PrivateEndpointConnections

Class representing a PrivateEndpointConnections.

PrivateLinkResources

Class representing a PrivateLinkResources.

Queue

Class representing a Queue.

QueueServices

Class representing a QueueServices.

Skus

Class representing a Skus.

StorageAccounts

Class representing a StorageAccounts.

TableOperations

Class representing a TableOperations.

TableServices

Class representing a TableServices.

Usages

Class representing a Usages.

StorageManagementClient
StorageManagementClientContext

Interfaces

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.

BlobContainersCreateOrUpdateImmutabilityPolicyHeaders

Defines headers for CreateOrUpdateImmutabilityPolicy operation.

BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams

Optional Parameters.

BlobContainersDeleteImmutabilityPolicyHeaders

Defines headers for DeleteImmutabilityPolicy operation.

BlobContainersExtendImmutabilityPolicyHeaders

Defines headers for ExtendImmutabilityPolicy operation.

BlobContainersExtendImmutabilityPolicyOptionalParams

Optional Parameters.

BlobContainersGetImmutabilityPolicyHeaders

Defines headers for GetImmutabilityPolicy operation.

BlobContainersGetImmutabilityPolicyOptionalParams

Optional Parameters.

BlobContainersLeaseOptionalParams

Optional Parameters.

BlobContainersListNextOptionalParams

Optional Parameters.

BlobContainersListOptionalParams

Optional Parameters.

BlobContainersLockImmutabilityPolicyHeaders

Defines headers for LockImmutabilityPolicy operation.

BlobInventoryPoliciesCreateOrUpdateOptionalParams

Optional Parameters.

BlobInventoryPolicy

The storage account blob inventory policy.

BlobInventoryPolicyDefinition

An object that defines the blob inventory rule. Each definition consists of a set of filters.

BlobInventoryPolicyFilter

An object that defines the blob inventory rule filter conditions.

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.

ChangeFeed

The blob service properties for change feed events.

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

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 the number of days after creation.

DateAfterModification

Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive.

DeleteRetentionPolicy

The service properties for soft delete.

DeletedAccount

Deleted storage account

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

ErrorResponse

An error response from the storage resource provider.

ErrorResponseBody

Error response body contract.

ExtendedLocation

The complex type of the extended location.

FileServiceItems

An interface representing FileServiceItems.

FileServiceProperties

The properties of File services in storage account.

FileShare

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

FileShareItem

The file share properties be listed out.

FileShareItems
FileSharesCreateOptionalParams

Optional Parameters.

FileSharesDeleteMethodOptionalParams

Optional Parameters.

FileSharesGetOptionalParams

Optional Parameters.

FileSharesListNextOptionalParams

Optional Parameters.

FileSharesListOptionalParams

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.

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.

LegalHold

The LegalHold property of a blob container.

LegalHoldProperties

The LegalHold property of a blob container.

ListAccountSasResponse

The List SAS credentials operation response.

ListBlobInventoryPolicy
ListContainerItem

The blob container properties be listed out.

ListContainerItems
ListQueue

An interface representing ListQueue.

ListQueueResource
ListQueueServices

An interface representing ListQueueServices.

ListServiceSasResponse

The List service SAS credentials operation response.

ListTableResource
ListTableServices

An interface representing ListTableServices.

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
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
PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult
PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkServiceConnectionState

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

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

QueueCreateOptionalParams

Optional Parameters.

QueueListNextOptionalParams

Optional Parameters.

QueueListOptionalParams

Optional Parameters.

QueueServiceProperties

The properties of a storage account’s Queue service.

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.

Sku

The SKU of the storage account.

SkuInformation

Storage SKU and its properties

SmbSetting

Setting for SMB protocol

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

StorageAccountRegenerateKeyParameters

The parameters used to regenerate the storage account key.

StorageAccountUpdateParameters

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

StorageAccountsGetPropertiesOptionalParams

Optional Parameters.

StorageAccountsListKeysOptionalParams

Optional Parameters.

StorageManagementClientOptions

An interface representing StorageManagementClientOptions.

StorageQueue

An interface representing StorageQueue.

StorageSkuListResult
SystemData

Metadata pertaining to creation and last modification of the resource.

Table

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

TableServiceProperties

The properties of a storage account’s Table service.

TableServicesSetServicePropertiesOptionalParams

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
UsageName

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

UserAssignedIdentity

UserAssignedIdentity for the resource.

VirtualNetworkRule

Virtual Network rule.

Type Aliases

AccessTier

Defines values for AccessTier. Possible values include: 'Hot', 'Cool'

AccountStatus

Defines values for AccountStatus. Possible values include: 'available', 'unavailable'

Action

Defines values for Action. Possible values include: 'Allow'

Action1

Defines values for Action1. Possible values include: 'Acquire', 'Renew', 'Change', 'Release', 'Break'

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.

BlobRestoreProgressStatus

Defines values for BlobRestoreProgressStatus. Possible values include: '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. Possible values include: 'None', 'Logging', 'Metrics', 'AzureServices'

CreatedByType

Defines values for CreatedByType. Possible values include: 'User', 'Application', 'ManagedIdentity', 'Key'

DefaultAction

Defines values for DefaultAction. Possible values include: 'Allow', 'Deny'

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. Possible values include: 'None', 'AADDS', 'AD'

EnabledProtocols

Defines values for EnabledProtocols. Possible values include: 'SMB', 'NFS'

EncryptionScopeSource

Defines values for EncryptionScopeSource. Possible values include: 'Microsoft.Storage', 'Microsoft.KeyVault'

EncryptionScopeState

Defines values for EncryptionScopeState. Possible values include: '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.

ExtendedLocationTypes

Defines values for ExtendedLocationTypes. Possible values include: '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.

FileSharesListNextResponse

Contains response data for the listNext operation.

FileSharesListResponse

Contains response data for the list operation.

FileSharesUpdateResponse

Contains response data for the update operation.

GeoReplicationStatus

Defines values for GeoReplicationStatus. Possible values include: 'Live', 'Bootstrap', 'Unavailable'

GetShareExpand

Defines values for GetShareExpand. Possible values include: 'stats'

HttpProtocol

Defines values for HttpProtocol. Possible values include: 'https,http', 'https'

IdentityType

Defines values for IdentityType. Possible values include: 'None', 'SystemAssigned', 'UserAssigned', 'SystemAssigned,UserAssigned'

ImmutabilityPolicyState

Defines values for ImmutabilityPolicyState. Possible values include: 'Locked', 'Unlocked'

ImmutabilityPolicyUpdateType

Defines values for ImmutabilityPolicyUpdateType. Possible values include: 'put', 'lock', 'extend'

KeyPermission

Defines values for KeyPermission. Possible values include: 'Read', 'Full'

KeySource

Defines values for KeySource. Possible values include: 'Microsoft.Storage', 'Microsoft.Keyvault'

KeyType

Defines values for KeyType. Possible values include: 'Service', 'Account'

Kind

Defines values for Kind. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'

LargeFileSharesState

Defines values for LargeFileSharesState. Possible values include: 'Disabled', 'Enabled'

LeaseDuration

Defines values for LeaseDuration. Possible values include: 'Infinite', 'Fixed'

LeaseState

Defines values for LeaseState. Possible values include: 'Available', 'Leased', 'Expired', 'Breaking', 'Broken'

LeaseStatus

Defines values for LeaseStatus. Possible values include: 'Locked', 'Unlocked'

ListContainersInclude

Defines values for ListContainersInclude. Possible values include: 'deleted'

ListKeyExpand

Defines values for ListKeyExpand. Possible values include: 'kerb'

ListSharesExpand

Defines values for ListSharesExpand. Possible values include: 'deleted', 'snapshots'

ManagementPoliciesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ManagementPoliciesGetResponse

Contains response data for the get operation.

MinimumTlsVersion

Defines values for MinimumTlsVersion. Possible values include: 'TLS1_0', 'TLS1_1', 'TLS1_2'

Name

Defines values for Name. Possible values include: '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.

OperationsListResponse

Contains response data for the list operation.

Permissions

Defines values for Permissions. Possible values include: 'r', 'd', 'w', 'l', 'a', 'c', 'u', 'p'

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState. Possible values include: '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. Possible values include: 'Pending', 'Approved', 'Rejected'

PrivateLinkResourcesListByStorageAccountResponse

Contains response data for the listByStorageAccount operation.

ProvisioningState

Defines values for ProvisioningState. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'

PublicAccess

Defines values for PublicAccess. Possible values include: 'Container', 'Blob', 'None'

PutSharesExpand

Defines values for PutSharesExpand. Possible values include: 'snapshots'

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. Possible values include: 'AccountNameInvalid', 'AlreadyExists'

ReasonCode

Defines values for ReasonCode. Possible values include: 'QuotaId', 'NotAvailableForSubscription'

RootSquashType

Defines values for RootSquashType. Possible values include: 'NoRootSquash', 'RootSquash', 'AllSquash'

RoutingChoice

Defines values for RoutingChoice. Possible values include: 'MicrosoftRouting', 'InternetRouting'

Services

Defines values for Services. Possible values include: 'b', 'q', 't', 'f'

ShareAccessTier

Defines values for ShareAccessTier. Possible values include: 'TransactionOptimized', 'Hot', 'Cool', 'Premium'

SignedResource

Defines values for SignedResource. Possible values include: 'b', 'c', 'f', 's'

SignedResourceTypes

Defines values for SignedResourceTypes. Possible values include: 's', 'c', 'o'

SkuName

Defines values for SkuName. Possible values include: 'Standard_LRS', 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS', 'Premium_ZRS', 'Standard_GZRS', 'Standard_RAGZRS'

SkuTier

Defines values for SkuTier. Possible values include: 'Standard', 'Premium'

SkusListResponse

Contains response data for the list operation.

State

Defines values for State. Possible values include: 'provisioning', 'deprovisioning', 'succeeded', 'failed', 'networkSourceDeleted'

StorageAccountExpand

Defines values for StorageAccountExpand. Possible values include: 'geoReplicationStats', 'blobRestoreStatus'

StorageAccountsBeginCreateResponse

Contains response data for the beginCreate operation.

StorageAccountsBeginRestoreBlobRangesResponse

Contains response data for the beginRestoreBlobRanges operation.

StorageAccountsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

StorageAccountsCreateResponse

Contains response data for the create 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. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond', 'BytesPerSecond'

UsagesListByLocationResponse

Contains response data for the listByLocation operation.