@azure/arm-storage-profile-2020-09-01-hybrid package

Classes

StorageManagementClient

Interfaces

AccountSasParameters

The parameters to list SAS credentials of a storage account.

ActiveDirectoryProperties

Settings properties for Active Directory (AD).

AzureFilesIdentityBasedAuthentication

Settings for Azure Files identity based authentication.

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

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

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.

Dimension

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

Encryption

The encryption settings on 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.

ErrorResponse

An error response from the storage resource provider.

ErrorResponseBody

Error response body contract.

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.

KeyVaultProperties

Properties of key vault.

ListAccountSasResponse

The List SAS credentials operation response.

ListBlobInventoryPolicy

List of blob inventory policies returned.

ListServiceSasResponse

The List service SAS credentials operation response.

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.

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.

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.

Resource

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

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.

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

Skus

Interface representing a Skus.

SkusListOptionalParams

Optional parameters.

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.

StorageAccountRegenerateKeyParameters

The parameters used to regenerate the storage account key.

StorageAccountUpdateParameters

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

StorageAccounts

Interface representing a StorageAccounts.

StorageAccountsCheckNameAvailabilityOptionalParams

Optional parameters.

StorageAccountsCreateOptionalParams

Optional parameters.

StorageAccountsDeleteOptionalParams

Optional parameters.

StorageAccountsFailoverOptionalParams

Optional parameters.

StorageAccountsGetPropertiesOptionalParams

Optional parameters.

StorageAccountsListAccountSASOptionalParams

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.

StorageSkuListResult

The response from the List Storage SKUs operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagFilter

Blob index tag based filtering for blob objects

TrackedResource

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

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.

VirtualNetworkRule

Virtual Network rule.

Type Aliases

AccessTier

Defines values for AccessTier.

AccountStatus

Defines values for AccountStatus.

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

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.

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

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.

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.

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

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

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

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

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.

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

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

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

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

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.

StorageAccountExpand

Defines values for StorageAccountExpand.

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.

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.

UsageUnit

Defines values for UsageUnit.

UsagesListByLocationResponse

Contains response data for the listByLocation operation.

Enums

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.

KnownDirectoryServiceOptions

Known values of DirectoryServiceOptions that the service accepts.

KnownEncryptionScopeSource

Known values of EncryptionScopeSource that the service accepts.

KnownEncryptionScopeState

Known values of EncryptionScopeState that the service accepts.

KnownGeoReplicationStatus

Known values of GeoReplicationStatus 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.

KnownManagementPolicyName

Known values of ManagementPolicyName that the service accepts.

KnownMinimumTlsVersion

Known values of MinimumTlsVersion that the service accepts.

KnownPermissions

Known values of Permissions that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownReasonCode

Known values of ReasonCode that the service accepts.

KnownRoutingChoice

Known values of RoutingChoice that the service accepts.

KnownRuleType

Known values of RuleType that the service accepts.

KnownServices

Known values of Services that the service accepts.

KnownSignedResource

Known values of SignedResource that the service accepts.

KnownSignedResourceTypes

Known values of SignedResourceTypes that the service accepts.

KnownSkuName

Known values of SkuName 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.