Share via


@azure/arm-elasticsan package

Classes

ElasticSanManagement

Interfaces

AutoScaleProperties

The auto scale settings on Elastic San Appliance.

DiskSnapshotList

object to hold array of Disk Snapshot ARM IDs

ElasticSan

Response for ElasticSan request.

ElasticSanManagementOptionalParams

Optional parameters for the client.

ElasticSanProperties

Elastic San response properties.

ElasticSanUpdate

Response for ElasticSan update request.

ElasticSanUpdateProperties

Elastic San update properties.

ElasticSansCreateOptionalParams

Optional parameters.

ElasticSansDeleteOptionalParams

Optional parameters.

ElasticSansGetOptionalParams

Optional parameters.

ElasticSansListByResourceGroupOptionalParams

Optional parameters.

ElasticSansListBySubscriptionOptionalParams

Optional parameters.

ElasticSansOperations

Interface representing a ElasticSans operations.

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.

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

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

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

PreValidationResponse

response object for pre validation api

PrivateEndpoint

Response for PrivateEndpoint

PrivateEndpointConnection

Response for PrivateEndpoint Connection object

PrivateEndpointConnectionProperties

Response for PrivateEndpoint connection properties

PrivateEndpointConnectionsCreateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

A list of private link resources

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesListByElasticSanOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

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

RestorePollerOptions
SKUCapability

The capability information in the specified SKU.

ScaleUpProperties

Scale up properties on Elastic San Appliance.

SimplePollerLike

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

Sku

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

SkuInformation

ElasticSAN SKU and its properties

SkuLocationInfo

The location info.

SkusListOptionalParams

Optional parameters.

SkusOperations

Interface representing a Skus operations.

Snapshot

Response for Volume Snapshot request.

SnapshotCreationData

Data used when creating a volume snapshot.

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.

VolumeGroupProperties

VolumeGroup response properties.

VolumeGroupUpdate

Volume Group request.

VolumeGroupUpdateProperties

VolumeGroup response properties.

VolumeGroupsCreateOptionalParams

Optional parameters.

VolumeGroupsDeleteOptionalParams

Optional parameters.

VolumeGroupsGetOptionalParams

Optional parameters.

VolumeGroupsListByElasticSanOptionalParams

Optional parameters.

VolumeGroupsOperations

Interface representing a VolumeGroups operations.

VolumeGroupsUpdateOptionalParams

Optional parameters.

VolumeNameList

object to hold array of volume names

VolumeProperties

Volume response properties.

VolumeSnapshotsCreateOptionalParams

Optional parameters.

VolumeSnapshotsDeleteOptionalParams

Optional parameters.

VolumeSnapshotsGetOptionalParams

Optional parameters.

VolumeSnapshotsListByVolumeGroupOptionalParams

Optional parameters.

VolumeSnapshotsOperations

Interface representing a VolumeSnapshots operations.

VolumeUpdate

Response for Volume request.

VolumeUpdateProperties

Volume response properties.

VolumesCreateOptionalParams

Optional parameters.

VolumesDeleteOptionalParams

Optional parameters.

VolumesGetOptionalParams

Optional parameters.

VolumesListByVolumeGroupOptionalParams

Optional parameters.

VolumesOperations

Interface representing a Volumes operations.

VolumesPreBackupOptionalParams

Optional parameters.

VolumesPreRestoreOptionalParams

Optional parameters.

VolumesUpdateOptionalParams

Optional parameters.

Type Aliases

Action

The action of virtual network rule.
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

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AutoScalePolicyEnforcement

Enable or Disable scale up setting on Elastic San Appliance.
KnownAutoScalePolicyEnforcement can be used interchangeably with AutoScalePolicyEnforcement, this enum contains the known values that the service supports.

Known values supported by the service

None
Enabled
Disabled

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

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

Known values supported by the service

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

EncryptionType

The type of key used to encrypt the data of the disk.
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

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

Known values supported by the service

None
SystemAssigned
UserAssigned

OperationalStatus

Operational status of the resource.
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)

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

PrivateEndpointServiceConnectionStatus

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

Known values supported by the service

Pending
Approved
Failed
Rejected

ProvisioningStates

Provisioning state of the iSCSI Target.
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
Deleted
Restoring

PublicNetworkAccess

Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
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

The sku name.
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

The sku tier.
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

StorageTargetType

Storage Target type.
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

This enumerates the possible sources of a volume creation.
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

XMsDeleteSnapshots

Type of XMsDeleteSnapshots

XMsForceDelete

Type of XMsForceDelete

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAction

The action of virtual network rule.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownAutoScalePolicyEnforcement

Enable or Disable scale up setting on Elastic San Appliance.

KnownCreatedByType

The kind of entity that created the resource.

KnownEncryptionType

The type of key used to encrypt the data of the disk.

KnownIdentityType

The identity type.

KnownOperationalStatus

Operational status of the resource.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownProvisioningStates

Provisioning state of the iSCSI Target.

KnownPublicNetworkAccess

Allow or disallow public network access to ElasticSan. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.

KnownSkuName

The sku name.

KnownSkuTier

The sku tier.

KnownStorageTargetType

Storage Target type.

KnownVersions

The available API versions.

KnownVolumeCreateOption

This enumerates the possible sources of a volume creation.

KnownXMsDeleteSnapshots

Known values of <xref:x-ms-delete-snapshots> that the service accepts.

KnownXMsForceDelete

Known values of <xref:x-ms-force-delete> that the service accepts.

Functions

restorePoller<TResponse, TResult>(ElasticSanManagement, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

Function Details

restorePoller<TResponse, TResult>(ElasticSanManagement, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

function restorePoller<TResponse, TResult>(client: ElasticSanManagement, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>