@azure/arm-purestorageblock package
Classes
| BlockClient |
Interfaces
| ActivateSaaSRequest |
SaaS guid for Activate SaaS Resource |
| Address |
Address details |
| Alert |
Health alerts |
| AvsConnection |
Transient information about an on-going connection to an AVS instance |
| AvsDiskDetails |
AVS disk/volume information |
| AvsStatus |
Status of storage pool / AVS connection |
| AvsStorageContainer |
AVS storage container resource type, representing a VMware storage container in a storage pool, which can be associated to and mounted as a datastore |
| AvsStorageContainerProperties |
AVS storage container properties |
| AvsStorageContainerVolume |
A volume contained in an AVS storage container |
| AvsStorageContainerVolumeUpdate |
The type used for update operations of the AvsStorageContainerVolume. |
| AvsStorageContainerVolumeUpdateProperties |
The updatable properties of the AvsStorageContainerVolume. |
| AvsStorageContainerVolumesDeleteOptionalParams |
Optional parameters. |
| AvsStorageContainerVolumesGetOptionalParams |
Optional parameters. |
| AvsStorageContainerVolumesListByAvsStorageContainerOptionalParams |
Optional parameters. |
| AvsStorageContainerVolumesOperations |
Interface representing a AvsStorageContainerVolumes operations. |
| AvsStorageContainerVolumesUpdateOptionalParams |
Optional parameters. |
| AvsStorageContainersDeleteOptionalParams |
Optional parameters. |
| AvsStorageContainersGetOptionalParams |
Optional parameters. |
| AvsStorageContainersListByStoragePoolOptionalParams |
Optional parameters. |
| AvsStorageContainersOperations |
Interface representing a AvsStorageContainers operations. |
| AvsVm |
AVS VM resource type, representing all the volumes associated to an AVS VM as defined by VMware |
| AvsVmDetails |
AVS VM details |
| AvsVmProperties |
AVS VM properties |
| AvsVmUpdate |
The type used for update operations of the AvsVm. |
| AvsVmUpdateProperties |
The updatable properties of the AvsVm. |
| AvsVmVolume |
Any volume associated to a particular AVS VM |
| AvsVmVolumeUpdate |
The type used for update operations of the AvsVmVolume. |
| AvsVmVolumeUpdateProperties |
The updatable properties of the AvsVmVolume. |
| AvsVmVolumesDeleteOptionalParams |
Optional parameters. |
| AvsVmVolumesGetOptionalParams |
Optional parameters. |
| AvsVmVolumesListByAvsVmOptionalParams |
Optional parameters. |
| AvsVmVolumesOperations |
Interface representing a AvsVmVolumes operations. |
| AvsVmVolumesUpdateOptionalParams |
Optional parameters. |
| AvsVmsDeleteOptionalParams |
Optional parameters. |
| AvsVmsGetOptionalParams |
Optional parameters. |
| AvsVmsListByStoragePoolOptionalParams |
Optional parameters. |
| AvsVmsOperations |
Interface representing a AvsVms operations. |
| AvsVmsUpdateOptionalParams |
Optional parameters. |
| AzureVmwareService |
Connected AVS status |
| AzureVolumeProperties |
Properties of an Azure volume |
| BandwidthUsage |
Bandwidth usage metrics |
| BillingUsageProperty |
Represents an individual billing usage property |
| BlockClientOptionalParams |
Optional parameters for the client. |
| CompanyDetails |
Company details |
| ConnectionParametersResponse |
Connection parameters response |
| DestroyedStateProperties |
Soft-deletion (destroyed) state of a resource |
| 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. |
| HealthDetails |
Health metrics for a storage pool |
| IopsUsage |
IOPS usage metrics |
| IscsiConnectionParameters |
ISCSI connection parameters |
| IscsiEndpoint |
ISCSI connection endpoint details |
| LatestLinkedSaaSResponse |
Response of get latest linked SaaS resource operation. |
| LimitDetails |
Limits constraining certain resource properties |
| LinkSaaSRequest |
SaaS details for linking to a reservation. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| MarketplaceDetails |
Marketplace details |
| OfferDetails |
Offer details for the marketplace that is selected by the user |
| 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. |
| PerformanceParameters |
Performance parameters for volume group |
| PerformancePolicyLimits |
internal |
| PlatformConsoleAccessSettings |
Access settings for a platform console interface |
| PlatformConsoleActivationCode |
One-time activation code for platform console access |
| PlatformConsoleAuthConfig |
Base model for platform console authentication configuration. Extend with a type-specific subtype for each auth mechanism. |
| PlatformConsoleAuthResult |
Base model for platform console authentication result. Actual type depends on the authType used in the request. |
| PlatformConsoleSettings |
Settings for platform console access to the storage pool |
| PlatformConsoleSubnet |
Subnet configuration for platform console access |
| ProtectionParameters |
Protection parameters for volume group |
| ProtectionPolicyLimits |
internal |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| RangeLimits |
Minimum and maximum values for a property |
| RecoverableVolumeGroup |
A destroyed volume group that is pending eradication |
| RecoverableVolumeGroupProperties |
Properties of a recoverable volume group |
| RecoverableVolumeGroupsDeleteOptionalParams |
Optional parameters. |
| RecoverableVolumeGroupsGetOptionalParams |
Optional parameters. |
| RecoverableVolumeGroupsListByStoragePoolOptionalParams |
Optional parameters. |
| RecoverableVolumeGroupsOperations |
Interface representing a RecoverableVolumeGroups operations. |
| Reservation |
Pure Storage cloud service resource type, also called reservation |
| ReservationBillingStatus |
Latest billing status for this reservation |
| ReservationBillingUsageReport |
Represents a billing usage report, including overall status and detailed properties |
| ReservationPropertiesBaseResourceProperties |
Properties of a Reservation resource. |
| ReservationUpdate |
The type used for update operations of the Reservation. |
| ReservationUpdateProperties |
The updatable properties of the Reservation. |
| ReservationsCreateOptionalParams |
Optional parameters. |
| ReservationsDeleteOptionalParams |
Optional parameters. |
| ReservationsGetBillingReportOptionalParams |
Optional parameters. |
| ReservationsGetBillingStatusOptionalParams |
Optional parameters. |
| ReservationsGetOptionalParams |
Optional parameters. |
| ReservationsGetResourceLimitsOptionalParams |
Optional parameters. |
| ReservationsLatestLinkedSaaSOptionalParams |
Optional parameters. |
| ReservationsLinkSaaSOptionalParams |
Optional parameters. |
| ReservationsListByResourceGroupOptionalParams |
Optional parameters. |
| ReservationsListBySubscriptionOptionalParams |
Optional parameters. |
| ReservationsOperations |
Interface representing a Reservations operations. |
| ReservationsUpdateOptionalParams |
Optional parameters. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestorePollerOptions | |
| SaaSOperationGroupActivateResourceOptionalParams |
Optional parameters. |
| SaaSOperationGroupOperations |
Interface representing a SaaSOperationGroup operations. |
| SaaSResourceDetailsResponse |
Marketplace SaaS resource details. |
| ServiceInitializationHandle |
Initialization handle used to configure the AVS SDDC to communicate with the storage pool |
| ServiceInitializationInfo |
Explicit service initialization data |
| SoftDeletion |
Soft-deletion state |
| Space |
Storage space usage |
| SshPlatformConsoleAuthConfig |
SSH-based platform console authentication configuration |
| SshPlatformConsoleAuthResult |
SSH-based platform console authentication result |
| StoragePool |
Storage pool resource |
| StoragePoolEnableAvsConnectionPost |
EnableAvsConnection payload information |
| StoragePoolFinalizeAvsConnectionPost |
FinalizeAvsConnection payload information, either encoded or explicit |
| StoragePoolHealthInfo |
Health information for a storage pool |
| StoragePoolLimits |
Limits used for storage pool creation |
| StoragePoolProperties |
Properties of a storage pool |
| StoragePoolUpdate |
The type used for update operations of the StoragePool. |
| StoragePoolUpdateProperties |
The updatable properties of the StoragePool. |
| StoragePoolsConfigurePlatformConsoleAuthOptionalParams |
Optional parameters. |
| StoragePoolsCreateOptionalParams |
Optional parameters. |
| StoragePoolsDeleteOptionalParams |
Optional parameters. |
| StoragePoolsDisableAvsConnectionOptionalParams |
Optional parameters. |
| StoragePoolsEnableAvsConnectionOptionalParams |
Optional parameters. |
| StoragePoolsFinalizeAvsConnectionOptionalParams |
Optional parameters. |
| StoragePoolsGetAvsConnectionOptionalParams |
Optional parameters. |
| StoragePoolsGetAvsStatusOptionalParams |
Optional parameters. |
| StoragePoolsGetHealthStatusOptionalParams |
Optional parameters. |
| StoragePoolsGetOptionalParams |
Optional parameters. |
| StoragePoolsListByResourceGroupOptionalParams |
Optional parameters. |
| StoragePoolsListBySubscriptionOptionalParams |
Optional parameters. |
| StoragePoolsListPlatformConsoleActivationCodeOptionalParams |
Optional parameters. |
| StoragePoolsOperations |
Interface representing a StoragePools operations. |
| StoragePoolsRepairAvsConnectionOptionalParams |
Optional parameters. |
| StoragePoolsUpdateOptionalParams |
Optional parameters. |
| 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 |
User assigned identity properties |
| UserDetails |
User details |
| VnetInjection |
Network in which the storage pool will be made available |
| Volume |
Azure Volume resource |
| VolumeGroup |
Volume Group resource |
| VolumeGroupOverwriteRequest |
Request to overwrite all volumes in a volume group from a snapshot |
| VolumeGroupProperties |
Properties of a volume group |
| VolumeGroupSnapshot |
A snapshot of a volume group |
| VolumeGroupSnapshotListRequest |
Request payload for listing volume group snapshots |
| VolumeGroupSnapshotPostListResult |
List result for volume group snapshots returned by the listSnapshots POST action |
| VolumeGroupSnapshotProperties |
Properties of a volume group snapshot |
| VolumeGroupSnapshotsCreateOptionalParams |
Optional parameters. |
| VolumeGroupSnapshotsDeleteOptionalParams |
Optional parameters. |
| VolumeGroupSnapshotsGetOptionalParams |
Optional parameters. |
| VolumeGroupSnapshotsListByVolumeGroupOptionalParams |
Optional parameters. |
| VolumeGroupSnapshotsListSnapshotsOptionalParams |
Optional parameters. |
| VolumeGroupSnapshotsOperations |
Interface representing a VolumeGroupSnapshots operations. |
| VolumeGroupStatus |
Volume group status information |
| VolumeGroupUpdate |
The type used for update operations of the VolumeGroup. |
| VolumeGroupUpdateProperties |
The updatable properties of the VolumeGroup. |
| VolumeGroupsCreateOptionalParams |
Optional parameters. |
| VolumeGroupsDeleteOptionalParams |
Optional parameters. |
| VolumeGroupsGetOptionalParams |
Optional parameters. |
| VolumeGroupsGetStatusOptionalParams |
Optional parameters. |
| VolumeGroupsListByStoragePoolOptionalParams |
Optional parameters. |
| VolumeGroupsListConnectionParametersOptionalParams |
Optional parameters. |
| VolumeGroupsOperations |
Interface representing a VolumeGroups operations. |
| VolumeGroupsOverwriteOptionalParams |
Optional parameters. |
| VolumeGroupsUpdateOptionalParams |
Optional parameters. |
| VolumeLimits |
Limits used for volumes |
| VolumeOverwriteRequest |
Request to overwrite a volume's content from another volume or a snapshot |
| VolumeProperties |
Volume properties |
| VolumeSnapshotInfo |
Information about an individual volume snapshot within a volume group snapshot |
| VolumeSnapshotSource |
Identifies the specific volume snapshot within a volume group snapshot to restore from |
| VolumeUpdate |
The type used for update operations of the Volume. |
| VolumeUpdateProperties |
The updatable properties of the Volume. |
| VolumesCreateOptionalParams |
Optional parameters. |
| VolumesDeleteOptionalParams |
Optional parameters. |
| VolumesGetOptionalParams |
Optional parameters. |
| VolumesListByVolumeGroupOptionalParams |
Optional parameters. |
| VolumesOperations |
Interface representing a Volumes operations. |
| VolumesOverwriteOptionalParams |
Optional parameters. |
| VolumesUpdateOptionalParams |
Optional parameters. |
Type Aliases
| ActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. Known values supported by the serviceInternal: Actions are for internal-only APIs. |
| AlertLevel |
Severity level of the alert Known values supported by the serviceinfo: Information level |
| 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. Known values supported by the serviceUser: The entity was created by a user. |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MarketplaceSubscriptionStatus |
Marketplace subscription status Known values supported by the servicePendingFulfillmentStart: Marketplace subscription purchased but not yet activated |
| Origin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" Known values supported by the serviceuser: Indicates the operation is initiated by a user. |
| PlatformConsoleAuthConfigUnion |
Alias for PlatformConsoleAuthConfigUnion |
| PlatformConsoleAuthResultUnion |
Alias for PlatformConsoleAuthResultUnion |
| PlatformConsoleAuthType |
Discriminator values for platform console authentication types. Extensible to support new auth mechanisms without API changes. Known values supported by the servicessh: SSH public key authentication |
| PlatformConsoleRole |
Role assigned to a user on the platform console Known values supported by the servicearray_admin: Full administrative access to the array |
| ProvisioningState |
The status of the current operation. Known values supported by the serviceSucceeded: Resource has been created. |
| ResourceProvisioningState |
The provisioning state of a resource type. Known values supported by the serviceSucceeded: Resource has been created. |
| UsageSeverity |
Severity levels for billing usage properties Known values supported by the servicealert: Indicates an alert condition |
| VmType |
AVS VM storage types Known values supported by the servicevvol: VM using vVols as underlying storage |
| VolumeContainerType |
Specify which control plane handles the lifecycle of the volume container Known values supported by the serviceavs: AVS/VMware |
| VolumeGroupSourceType |
Source type for volume group creation Known values supported by the servicenone: No source; create an empty volume group |
| VolumeSourceType |
Source type for volume creation Known values supported by the servicenone: No source; create an empty volume with the specified provisioned size |
| VolumeType |
Specify which control plane handles the lifecycle of the volume Known values supported by the serviceavs: AVS/VMware |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownActionType |
Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. |
| KnownAlertLevel |
Severity level of the alert |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownMarketplaceSubscriptionStatus |
Marketplace subscription status |
| KnownOrigin |
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" |
| KnownPlatformConsoleAuthType |
Discriminator values for platform console authentication types. Extensible to support new auth mechanisms without API changes. |
| KnownPlatformConsoleRole |
Role assigned to a user on the platform console |
| KnownProvisioningState |
The status of the current operation. |
| KnownResourceProvisioningState |
The provisioning state of a resource type. |
| KnownUsageSeverity |
Severity levels for billing usage properties |
| KnownVersions |
Supported versions for PureStorage.Block. |
| KnownVmType |
AVS VM storage types |
| KnownVolumeContainerType |
Specify which control plane handles the lifecycle of the volume container |
| KnownVolumeGroupSourceType |
Source type for volume group creation |
| KnownVolumeSourceType |
Source type for volume creation |
| KnownVolumeType |
Specify which control plane handles the lifecycle of the volume |
Functions
| is |
Typeguard for RestError |
| restore |
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. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(BlockClient, 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: BlockClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- BlockClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor