@azure/arm-elasticsan package

Classes

ElasticSanManagement

Interfaces

ElasticSan

Response for ElasticSan request.

ElasticSanList

List of Elastic Sans

ElasticSanManagementOptionalParams

Optional parameters.

ElasticSanProperties

Elastic San response properties.

ElasticSanUpdate

Response for ElasticSan update request.

ElasticSanUpdateProperties

Elastic San update properties.

ElasticSans

Interface representing a ElasticSans.

ElasticSansCreateOptionalParams

Optional parameters.

ElasticSansDeleteHeaders

Defines headers for ElasticSans_delete operation.

ElasticSansDeleteOptionalParams

Optional parameters.

ElasticSansGetOptionalParams

Optional parameters.

ElasticSansListByResourceGroupNextOptionalParams

Optional parameters.

ElasticSansListByResourceGroupOptionalParams

Optional parameters.

ElasticSansListBySubscriptionNextOptionalParams

Optional parameters.

ElasticSansListBySubscriptionOptionalParams

Optional parameters.

ElasticSansUpdateHeaders

Defines headers for ElasticSans_update operation.

ElasticSansUpdateOptionalParams

Optional parameters.

EncryptionIdentity

Encryption identity for the volume group.

EncryptionProperties

The encryption settings on the volume group.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

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

Identity

Identity for the resource.

IscsiTargetInfo

Iscsi target information

KeyVaultProperties

Properties of key vault.

ManagedByInfo

Parent resource information.

NetworkRuleSet

A set of rules governing the network accessibility.

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

Response for PrivateEndpoint

PrivateEndpointConnection

Response for PrivateEndpoint Connection object

PrivateEndpointConnectionListResult

List of private endpoint connections associated with SAN

PrivateEndpointConnectionProperties

Response for PrivateEndpoint connection properties

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesListByElasticSanOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

Response for Private Link Service Connection state

ProxyResource

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

Resource

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

SKUCapability

The capability information in the specified SKU.

Sku

The SKU name. Required for account creation; optional for update.

SkuInformation

ElasticSAN SKU and its properties

SkuInformationList

List of SKU Information objects

SkuLocationInfo

The location info.

Skus

Interface representing a Skus.

SkusListOptionalParams

Optional parameters.

Snapshot

Response for Volume Snapshot request.

SnapshotCreationData

Data used when creating a volume snapshot.

SnapshotList

List of Snapshots

SnapshotProperties

Properties for Snapshot.

SourceCreationData

Data source used when creating the volume.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

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

UserAssignedIdentity

UserAssignedIdentity for the resource.

VirtualNetworkRule

Virtual Network rule.

Volume

Response for Volume request.

VolumeGroup

Response for Volume Group request.

VolumeGroupList

List of Volume Groups

VolumeGroupProperties

VolumeGroup response properties.

VolumeGroupUpdate

Volume Group request.

VolumeGroupUpdateProperties

VolumeGroup response properties.

VolumeGroups

Interface representing a VolumeGroups.

VolumeGroupsCreateOptionalParams

Optional parameters.

VolumeGroupsDeleteHeaders

Defines headers for VolumeGroups_delete operation.

VolumeGroupsDeleteOptionalParams

Optional parameters.

VolumeGroupsGetOptionalParams

Optional parameters.

VolumeGroupsListByElasticSanNextOptionalParams

Optional parameters.

VolumeGroupsListByElasticSanOptionalParams

Optional parameters.

VolumeGroupsUpdateHeaders

Defines headers for VolumeGroups_update operation.

VolumeGroupsUpdateOptionalParams

Optional parameters.

VolumeList

List of Volumes

VolumeProperties

Volume response properties.

VolumeSnapshots

Interface representing a VolumeSnapshots.

VolumeSnapshotsCreateOptionalParams

Optional parameters.

VolumeSnapshotsDeleteHeaders

Defines headers for VolumeSnapshots_delete operation.

VolumeSnapshotsDeleteOptionalParams

Optional parameters.

VolumeSnapshotsGetOptionalParams

Optional parameters.

VolumeSnapshotsListByVolumeGroupNextOptionalParams

Optional parameters.

VolumeSnapshotsListByVolumeGroupOptionalParams

Optional parameters.

VolumeUpdate

Response for Volume request.

VolumeUpdateProperties

Volume response properties.

Volumes

Interface representing a Volumes.

VolumesCreateOptionalParams

Optional parameters.

VolumesDeleteHeaders

Defines headers for Volumes_delete operation.

VolumesDeleteOptionalParams

Optional parameters.

VolumesGetOptionalParams

Optional parameters.

VolumesListByVolumeGroupNextOptionalParams

Optional parameters.

VolumesListByVolumeGroupOptionalParams

Optional parameters.

VolumesUpdateHeaders

Defines headers for Volumes_update operation.

VolumesUpdateOptionalParams

Optional parameters.

Type Aliases

Action

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

Known values supported by the service

Allow

ActionType

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

Known values supported by the service

Internal

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

ElasticSansCreateResponse

Contains response data for the create operation.

ElasticSansGetResponse

Contains response data for the get operation.

ElasticSansListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ElasticSansListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ElasticSansListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ElasticSansListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ElasticSansUpdateResponse

Contains response data for the update operation.

EncryptionType

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

Known values supported by the service

EncryptionAtRestWithPlatformKey: Volume is encrypted at rest with Platform managed key. It is the default encryption type.
EncryptionAtRestWithCustomerManagedKey: Volume is encrypted at rest with Customer managed key that can be changed and revoked by a customer.

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

OperationalStatus

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

Known values supported by the service

Invalid
Unknown
Healthy
Unhealthy
Updating
Running
Stopped
Stopped (deallocated)

OperationsListResponse

Contains response data for the list operation.

Origin

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

Known values supported by the service

user
system
user,system

PrivateEndpointConnectionsCreateResponse

Contains response data for the create operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list 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
Failed
Rejected

PrivateLinkResourcesListByElasticSanResponse

Contains response data for the listByElasticSan operation.

ProvisioningStates

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

Known values supported by the service

Invalid
Succeeded
Failed
Canceled
Pending
Creating
Updating
Deleting

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

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

Premium_LRS: Premium locally redundant storage
Premium_ZRS: Premium zone redundant storage

SkuTier

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

Known values supported by the service

Premium: Premium Tier

SkusListResponse

Contains response data for the list operation.

StorageTargetType

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

Known values supported by the service

Iscsi
None

VolumeCreateOption

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

Known values supported by the service

None
VolumeSnapshot
DiskSnapshot
Disk
DiskRestorePoint

VolumeGroupsCreateResponse

Contains response data for the create operation.

VolumeGroupsGetResponse

Contains response data for the get operation.

VolumeGroupsListByElasticSanNextResponse

Contains response data for the listByElasticSanNext operation.

VolumeGroupsListByElasticSanResponse

Contains response data for the listByElasticSan operation.

VolumeGroupsUpdateResponse

Contains response data for the update operation.

VolumeSnapshotsCreateResponse

Contains response data for the create operation.

VolumeSnapshotsGetResponse

Contains response data for the get operation.

VolumeSnapshotsListByVolumeGroupNextResponse

Contains response data for the listByVolumeGroupNext operation.

VolumeSnapshotsListByVolumeGroupResponse

Contains response data for the listByVolumeGroup operation.

VolumesCreateResponse

Contains response data for the create operation.

VolumesGetResponse

Contains response data for the get operation.

VolumesListByVolumeGroupNextResponse

Contains response data for the listByVolumeGroupNext operation.

VolumesListByVolumeGroupResponse

Contains response data for the listByVolumeGroup operation.

VolumesUpdateResponse

Contains response data for the update operation.

XMsDeleteSnapshots

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

Known values supported by the service

true
false

XMsForceDelete

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

Known values supported by the service

true
false

Enums

KnownAction

Known values of Action that the service accepts.

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownEncryptionType

Known values of EncryptionType that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownOperationalStatus

Known values of OperationalStatus that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningStates

Known values of ProvisioningStates that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownSkuName

Known values of SkuName that the service accepts.

KnownSkuTier

Known values of SkuTier that the service accepts.

KnownStorageTargetType

Known values of StorageTargetType that the service accepts.

KnownVolumeCreateOption

Known values of VolumeCreateOption that the service accepts.

KnownXMsDeleteSnapshots

Known values of XMsDeleteSnapshots that the service accepts.

KnownXMsForceDelete

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