@azure/arm-storagecache package
Classes
| StorageCacheManagementClient |
Interfaces
| AmlFilesystem |
An AML file system instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md |
| AmlFilesystemArchive |
Information about the AML file system archive |
| AmlFilesystemArchiveInfo |
Information required to execute the archive operation |
| AmlFilesystemArchiveStatus |
The status of the archive |
| AmlFilesystemCheckSubnetError |
The error details provided when the checkAmlFSSubnets call fails. |
| AmlFilesystemCheckSubnetErrorFilesystemSubnet |
The error details for the AML file system's subnet. |
| AmlFilesystemClientInfo |
AML file system client information |
| AmlFilesystemContainerStorageInterface |
AML file system container storage interface information |
| AmlFilesystemEncryptionSettings |
AML file system encryption settings. |
| AmlFilesystemHealth |
An indication of AML file system health. Gives more information about health than just that related to provisioning. |
| AmlFilesystemHsmSettings |
AML file system HSM settings. |
| AmlFilesystemIdentity |
Managed Identity properties. |
| AmlFilesystemPropertiesHsm |
Hydration and archive settings and status |
| AmlFilesystemPropertiesMaintenanceWindow |
Start time of a 30-minute weekly maintenance window. |
| AmlFilesystemRootSquashSettings |
AML file system squash settings. |
| AmlFilesystemSubnetInfo |
Information required to validate the subnet that will be used in AML file system create |
| AmlFilesystemUpdate |
An AML file system update instance. |
| AmlFilesystemUpdatePropertiesMaintenanceWindow |
Start time of a 30-minute weekly maintenance window. |
| AmlFilesystems |
Interface representing a AmlFilesystems. |
| AmlFilesystemsArchiveOptionalParams |
Optional parameters. |
| AmlFilesystemsCancelArchiveOptionalParams |
Optional parameters. |
| AmlFilesystemsCreateOrUpdateHeaders |
Defines headers for AmlFilesystems_createOrUpdate operation. |
| AmlFilesystemsCreateOrUpdateOptionalParams |
Optional parameters. |
| AmlFilesystemsDeleteHeaders |
Defines headers for AmlFilesystems_delete operation. |
| AmlFilesystemsDeleteOptionalParams |
Optional parameters. |
| AmlFilesystemsGetOptionalParams |
Optional parameters. |
| AmlFilesystemsListByResourceGroupNextOptionalParams |
Optional parameters. |
| AmlFilesystemsListByResourceGroupOptionalParams |
Optional parameters. |
| AmlFilesystemsListNextOptionalParams |
Optional parameters. |
| AmlFilesystemsListOptionalParams |
Optional parameters. |
| AmlFilesystemsListResult |
Result of the request to list AML file systems. It contains a list of AML file systems and a URL link to get the next set of results. |
| AmlFilesystemsUpdateHeaders |
Defines headers for AmlFilesystems_update operation. |
| AmlFilesystemsUpdateOptionalParams |
Optional parameters. |
| ApiOperation |
REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation |
| ApiOperationDisplay |
The object that represents the operation. |
| ApiOperationListResult |
Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results. |
| ApiOperationPropertiesServiceSpecification |
Specification of the all the metrics provided for a resource type. |
| AscOperation |
The status of operation. |
| AscOperationErrorResponse |
Describes the format of Error response. |
| AscOperations |
Interface representing a AscOperations. |
| AscOperationsGetOptionalParams |
Optional parameters. |
| AscUsages |
Interface representing a AscUsages. |
| AscUsagesListNextOptionalParams |
Optional parameters. |
| AscUsagesListOptionalParams |
Optional parameters. |
| AutoExportJob |
An auto export job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md |
| AutoExportJobUpdate |
An auto export job update instance. |
| AutoExportJobs |
Interface representing a AutoExportJobs. |
| AutoExportJobsCreateOrUpdateHeaders |
Defines headers for AutoExportJobs_createOrUpdate operation. |
| AutoExportJobsCreateOrUpdateOptionalParams |
Optional parameters. |
| AutoExportJobsDeleteHeaders |
Defines headers for AutoExportJobs_delete operation. |
| AutoExportJobsDeleteOptionalParams |
Optional parameters. |
| AutoExportJobsGetOptionalParams |
Optional parameters. |
| AutoExportJobsListByAmlFilesystemNextOptionalParams |
Optional parameters. |
| AutoExportJobsListByAmlFilesystemOptionalParams |
Optional parameters. |
| AutoExportJobsListResult |
Result of the request to list auto export jobs. It contains a list of auto export jobs and a URL link to get the next set of results. |
| AutoExportJobsUpdateHeaders |
Defines headers for AutoExportJobs_update operation. |
| AutoExportJobsUpdateOptionalParams |
Optional parameters. |
| AutoImportJob |
An auto import job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md |
| AutoImportJobPropertiesStatusBlobSyncEvents |
The storage account blob change feed status of the auto import job. |
| AutoImportJobUpdate |
An auto import job update instance. |
| AutoImportJobs |
Interface representing a AutoImportJobs. |
| AutoImportJobsCreateOrUpdateHeaders |
Defines headers for AutoImportJobs_createOrUpdate operation. |
| AutoImportJobsCreateOrUpdateOptionalParams |
Optional parameters. |
| AutoImportJobsDeleteHeaders |
Defines headers for AutoImportJobs_delete operation. |
| AutoImportJobsDeleteOptionalParams |
Optional parameters. |
| AutoImportJobsGetOptionalParams |
Optional parameters. |
| AutoImportJobsListByAmlFilesystemNextOptionalParams |
Optional parameters. |
| AutoImportJobsListByAmlFilesystemOptionalParams |
Optional parameters. |
| AutoImportJobsListResult |
Result of the request to list auto import jobs. It contains a list of auto import jobs and a URL link to get the next set of results. |
| AutoImportJobsUpdateHeaders |
Defines headers for AutoImportJobs_update operation. |
| AutoImportJobsUpdateOptionalParams |
Optional parameters. |
| BlobNfsTarget |
Properties pertaining to the BlobNfsTarget. |
| Cache |
A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md |
| CacheActiveDirectorySettings |
Active Directory settings used to join a cache to a domain. |
| CacheActiveDirectorySettingsCredentials |
Active Directory admin credentials used to join the HPC Cache to a domain. |
| CacheDirectorySettings |
Cache Directory Services settings. |
| CacheEncryptionSettings |
Cache encryption settings. |
| CacheHealth |
An indication of cache health. Gives more information about health than just that related to provisioning. |
| CacheIdentity |
Cache identity properties. |
| CacheNetworkSettings |
Cache network settings. |
| CacheSecuritySettings |
Cache security settings. |
| CacheSku |
SKU for the cache. |
| CacheUpgradeSettings |
Cache Upgrade Settings. |
| CacheUpgradeStatus |
Properties describing the software upgrade state of the cache. |
| CacheUsernameDownloadSettings |
Settings for Extended Groups username and group download. |
| CacheUsernameDownloadSettingsCredentials |
When present, these are the credentials for the secure LDAP connection. |
| Caches |
Interface representing a Caches. |
| CachesCreateOrUpdateOptionalParams |
Optional parameters. |
| CachesDebugInfoHeaders |
Defines headers for Caches_debugInfo operation. |
| CachesDebugInfoOptionalParams |
Optional parameters. |
| CachesDeleteHeaders |
Defines headers for Caches_delete operation. |
| CachesDeleteOptionalParams |
Optional parameters. |
| CachesFlushHeaders |
Defines headers for Caches_flush operation. |
| CachesFlushOptionalParams |
Optional parameters. |
| CachesGetOptionalParams |
Optional parameters. |
| CachesListByResourceGroupNextOptionalParams |
Optional parameters. |
| CachesListByResourceGroupOptionalParams |
Optional parameters. |
| CachesListNextOptionalParams |
Optional parameters. |
| CachesListOptionalParams |
Optional parameters. |
| CachesListResult |
Result of the request to list caches. It contains a list of caches and a URL link to get the next set of results. |
| CachesPausePrimingJobHeaders |
Defines headers for Caches_pausePrimingJob operation. |
| CachesPausePrimingJobOptionalParams |
Optional parameters. |
| CachesResumePrimingJobHeaders |
Defines headers for Caches_resumePrimingJob operation. |
| CachesResumePrimingJobOptionalParams |
Optional parameters. |
| CachesSpaceAllocationHeaders |
Defines headers for Caches_spaceAllocation operation. |
| CachesSpaceAllocationOptionalParams |
Optional parameters. |
| CachesStartHeaders |
Defines headers for Caches_start operation. |
| CachesStartOptionalParams |
Optional parameters. |
| CachesStartPrimingJobHeaders |
Defines headers for Caches_startPrimingJob operation. |
| CachesStartPrimingJobOptionalParams |
Optional parameters. |
| CachesStopHeaders |
Defines headers for Caches_stop operation. |
| CachesStopOptionalParams |
Optional parameters. |
| CachesStopPrimingJobHeaders |
Defines headers for Caches_stopPrimingJob operation. |
| CachesStopPrimingJobOptionalParams |
Optional parameters. |
| CachesUpdateHeaders |
Defines headers for Caches_update operation. |
| CachesUpdateOptionalParams |
Optional parameters. |
| CachesUpgradeFirmwareHeaders |
Defines headers for Caches_upgradeFirmware operation. |
| CachesUpgradeFirmwareOptionalParams |
Optional parameters. |
| CheckAmlFSSubnetsOptionalParams |
Optional parameters. |
| ClfsTarget |
Properties pertaining to the ClfsTarget |
| CloudError |
An error response. |
| CloudErrorBody |
An error response. |
| Condition |
Outstanding conditions that will need to be resolved. |
| 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.). |
| GetRequiredAmlFSSubnetsSizeOptionalParams |
Optional parameters. |
| ImportJob |
An import job instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md |
| ImportJobUpdate |
An import job update instance. |
| ImportJobs |
Interface representing a ImportJobs. |
| ImportJobsCreateOrUpdateHeaders |
Defines headers for ImportJobs_createOrUpdate operation. |
| ImportJobsCreateOrUpdateOptionalParams |
Optional parameters. |
| ImportJobsDeleteHeaders |
Defines headers for ImportJobs_delete operation. |
| ImportJobsDeleteOptionalParams |
Optional parameters. |
| ImportJobsGetOptionalParams |
Optional parameters. |
| ImportJobsListByAmlFilesystemNextOptionalParams |
Optional parameters. |
| ImportJobsListByAmlFilesystemOptionalParams |
Optional parameters. |
| ImportJobsListResult |
Result of the request to list import jobs. It contains a list of import jobs and a URL link to get the next set of results. |
| ImportJobsUpdateHeaders |
Defines headers for ImportJobs_update operation. |
| ImportJobsUpdateOptionalParams |
Optional parameters. |
| KeyVaultKeyReference |
Describes a reference to key vault key. |
| KeyVaultKeyReferenceSourceVault |
Describes a resource Id to source key vault. |
| LogSpecification |
Details about operation related to logs. |
| MetricDimension |
Specifications of the Dimension of metrics. |
| MetricSpecification |
Details about operation related to metrics. |
| NamespaceJunction |
A namespace junction. |
| Nfs3Target |
Properties pertaining to the Nfs3Target |
| NfsAccessPolicy |
A set of rules describing access policies applied to NFSv3 clients of the cache. |
| NfsAccessRule |
Rule to place restrictions on portions of the cache namespace being presented to clients. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PrimingJob |
A priming job instance. |
| PrimingJobIdParameter |
Object containing the priming job ID. |
| RequiredAmlFilesystemSubnetsSize |
Information about the number of available IP addresses that are required for the AML file system. |
| RequiredAmlFilesystemSubnetsSizeInfo |
Information required to get the number of available IP addresses a subnet should have that will be used in AML file system create |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceSku |
A resource SKU. |
| ResourceSkuCapabilities |
A resource SKU capability. |
| ResourceSkuLocationInfo |
Resource SKU location information. |
| ResourceSkusResult |
The response from the List Cache SKUs operation. |
| ResourceUsage |
The usage and limit (quota) for a resource. |
| ResourceUsageName |
Naming information for this resource type. |
| ResourceUsagesListResult |
Result of the request to list resource usages. It contains a list of resource usages & limits and a URL link to get the next set of results. |
| Restriction |
The restrictions preventing this SKU from being used. |
| SkuName |
SKU for the resource. |
| Skus |
Interface representing a Skus. |
| SkusListNextOptionalParams |
Optional parameters. |
| SkusListOptionalParams |
Optional parameters. |
| StorageCacheManagementClientOptionalParams |
Optional parameters. |
| StorageTarget |
Type of the Storage Target. |
| StorageTargetFlushHeaders |
Defines headers for StorageTarget_flush operation. |
| StorageTargetFlushOptionalParams |
Optional parameters. |
| StorageTargetInvalidateHeaders |
Defines headers for StorageTarget_invalidate operation. |
| StorageTargetInvalidateOptionalParams |
Optional parameters. |
| StorageTargetOperations |
Interface representing a StorageTargetOperations. |
| StorageTargetResource |
Resource used by a cache. |
| StorageTargetResumeHeaders |
Defines headers for StorageTarget_resume operation. |
| StorageTargetResumeOptionalParams |
Optional parameters. |
| StorageTargetSpaceAllocation |
Storage Target space allocation properties. |
| StorageTargetSuspendHeaders |
Defines headers for StorageTarget_suspend operation. |
| StorageTargetSuspendOptionalParams |
Optional parameters. |
| StorageTargets |
Interface representing a StorageTargets. |
| StorageTargetsCreateOrUpdateOptionalParams |
Optional parameters. |
| StorageTargetsDeleteHeaders |
Defines headers for StorageTargets_delete operation. |
| StorageTargetsDeleteOptionalParams |
Optional parameters. |
| StorageTargetsDnsRefreshHeaders |
Defines headers for StorageTargets_dnsRefresh operation. |
| StorageTargetsDnsRefreshOptionalParams |
Optional parameters. |
| StorageTargetsGetOptionalParams |
Optional parameters. |
| StorageTargetsListByCacheNextOptionalParams |
Optional parameters. |
| StorageTargetsListByCacheOptionalParams |
Optional parameters. |
| StorageTargetsRestoreDefaultsHeaders |
Defines headers for StorageTargets_restoreDefaults operation. |
| StorageTargetsRestoreDefaultsOptionalParams |
Optional parameters. |
| StorageTargetsResult |
A list of Storage Targets. |
| 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' |
| UnknownTarget |
Properties pertaining to the UnknownTarget |
| UsageModel |
A usage model. |
| UsageModelDisplay |
Localized information describing this usage model. |
| UsageModels |
Interface representing a UsageModels. |
| UsageModelsListNextOptionalParams |
Optional parameters. |
| UsageModelsListOptionalParams |
Optional parameters. |
| UsageModelsResult |
A list of cache usage models. |
| UserAssignedIdentitiesValue | |
Type Aliases
| AmlFilesystemHealthStateType |
Defines values for AmlFilesystemHealthStateType. Known values supported by the serviceUnavailable |
| AmlFilesystemIdentityType |
Defines values for AmlFilesystemIdentityType. |
| AmlFilesystemProvisioningStateType |
Defines values for AmlFilesystemProvisioningStateType. Known values supported by the serviceSucceeded |
| AmlFilesystemSquashMode |
Defines values for AmlFilesystemSquashMode. Known values supported by the serviceNone |
| AmlFilesystemsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| AmlFilesystemsGetResponse |
Contains response data for the get operation. |
| AmlFilesystemsListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| AmlFilesystemsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| AmlFilesystemsListNextResponse |
Contains response data for the listNext operation. |
| AmlFilesystemsListResponse |
Contains response data for the list operation. |
| AmlFilesystemsUpdateResponse |
Contains response data for the update operation. |
| ArchiveStatusType |
Defines values for ArchiveStatusType. Known values supported by the serviceNotConfigured |
| AscOperationsGetResponse |
Contains response data for the get operation. |
| AscUsagesListNextResponse |
Contains response data for the listNext operation. |
| AscUsagesListResponse |
Contains response data for the list operation. |
| AutoExportJobAdminStatus |
Defines values for AutoExportJobAdminStatus. Known values supported by the serviceEnable |
| AutoExportJobProvisioningStateType |
Defines values for AutoExportJobProvisioningStateType. Known values supported by the serviceSucceeded |
| AutoExportJobsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| AutoExportJobsDeleteResponse |
Contains response data for the delete operation. |
| AutoExportJobsGetResponse |
Contains response data for the get operation. |
| AutoExportJobsListByAmlFilesystemNextResponse |
Contains response data for the listByAmlFilesystemNext operation. |
| AutoExportJobsListByAmlFilesystemResponse |
Contains response data for the listByAmlFilesystem operation. |
| AutoExportJobsUpdateResponse |
Contains response data for the update operation. |
| AutoExportStatusType |
Defines values for AutoExportStatusType. Known values supported by the serviceInProgress |
| AutoImportJobPropertiesAdminStatus |
Defines values for AutoImportJobPropertiesAdminStatus. Known values supported by the serviceEnable |
| AutoImportJobPropertiesProvisioningState |
Defines values for AutoImportJobPropertiesProvisioningState. Known values supported by the serviceSucceeded |
| AutoImportJobState |
Defines values for AutoImportJobState. Known values supported by the serviceInProgress |
| AutoImportJobUpdatePropertiesAdminStatus |
Defines values for AutoImportJobUpdatePropertiesAdminStatus. Known values supported by the serviceEnable |
| AutoImportJobsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| AutoImportJobsDeleteResponse |
Contains response data for the delete operation. |
| AutoImportJobsGetResponse |
Contains response data for the get operation. |
| AutoImportJobsListByAmlFilesystemNextResponse |
Contains response data for the listByAmlFilesystemNext operation. |
| AutoImportJobsListByAmlFilesystemResponse |
Contains response data for the listByAmlFilesystem operation. |
| AutoImportJobsUpdateResponse |
Contains response data for the update operation. |
| CacheIdentityType |
Defines values for CacheIdentityType. |
| CachesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| CachesGetResponse |
Contains response data for the get operation. |
| CachesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| CachesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| CachesListNextResponse |
Contains response data for the listNext operation. |
| CachesListResponse |
Contains response data for the list operation. |
| CachesPausePrimingJobResponse |
Contains response data for the pausePrimingJob operation. |
| CachesResumePrimingJobResponse |
Contains response data for the resumePrimingJob operation. |
| CachesSpaceAllocationResponse |
Contains response data for the spaceAllocation operation. |
| CachesStartPrimingJobResponse |
Contains response data for the startPrimingJob operation. |
| CachesStopPrimingJobResponse |
Contains response data for the stopPrimingJob operation. |
| CachesUpdateResponse |
Contains response data for the update operation. |
| ConflictResolutionMode |
Defines values for ConflictResolutionMode. Known values supported by the serviceFail |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DomainJoinedType |
Defines values for DomainJoinedType. Known values supported by the serviceYes |
| FilesystemSubnetStatusType |
Defines values for FilesystemSubnetStatusType. Known values supported by the serviceOk |
| FirmwareStatusType |
Defines values for FirmwareStatusType. Known values supported by the serviceavailable |
| GetRequiredAmlFSSubnetsSizeResponse |
Contains response data for the getRequiredAmlFSSubnetsSize operation. |
| HealthStateType |
Defines values for HealthStateType. Known values supported by the serviceUnknown |
| ImportJobAdminStatus |
Defines values for ImportJobAdminStatus. Known values supported by the serviceActive |
| ImportJobProvisioningStateType |
Defines values for ImportJobProvisioningStateType. Known values supported by the serviceSucceeded |
| ImportJobsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| ImportJobsDeleteResponse |
Contains response data for the delete operation. |
| ImportJobsGetResponse |
Contains response data for the get operation. |
| ImportJobsListByAmlFilesystemNextResponse |
Contains response data for the listByAmlFilesystemNext operation. |
| ImportJobsListByAmlFilesystemResponse |
Contains response data for the listByAmlFilesystem operation. |
| ImportJobsUpdateResponse |
Contains response data for the update operation. |
| ImportStatusType |
Defines values for ImportStatusType. Known values supported by the serviceInProgress |
| MaintenanceDayOfWeekType |
Defines values for MaintenanceDayOfWeekType. |
| MetricAggregationType |
Defines values for MetricAggregationType. Known values supported by the serviceNotSpecified |
| NfsAccessRuleAccess |
Defines values for NfsAccessRuleAccess. Known values supported by the serviceno |
| NfsAccessRuleScope |
Defines values for NfsAccessRuleScope. Known values supported by the servicedefault |
| OperationalStateType |
Defines values for OperationalStateType. Known values supported by the serviceReady |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| PrimingJobState |
Defines values for PrimingJobState. Known values supported by the serviceQueued |
| ProvisioningStateType |
Defines values for ProvisioningStateType. Known values supported by the serviceSucceeded |
| ReasonCode |
Defines values for ReasonCode. Known values supported by the serviceQuotaId |
| SkusListNextResponse |
Contains response data for the listNext operation. |
| SkusListResponse |
Contains response data for the list operation. |
| StorageTargetType |
Defines values for StorageTargetType. Known values supported by the servicenfs3 |
| StorageTargetsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| StorageTargetsGetResponse |
Contains response data for the get operation. |
| StorageTargetsListByCacheNextResponse |
Contains response data for the listByCacheNext operation. |
| StorageTargetsListByCacheResponse |
Contains response data for the listByCache operation. |
| UsageModelsListNextResponse |
Contains response data for the listNext operation. |
| UsageModelsListResponse |
Contains response data for the list operation. |
| UsernameDownloadedType |
Defines values for UsernameDownloadedType. Known values supported by the serviceYes |
| UsernameSource |
Defines values for UsernameSource. Known values supported by the serviceAD |
Enums
Functions
| get |
Given the last |
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.