@azure/arm-recoveryservices package
Classes
| RecoveryServicesClient |
Interfaces
| AzureMonitorAlertSettings |
Settings for Azure Monitor based alerts |
| CapabilitiesProperties |
Capabilities information |
| CapabilitiesResponse |
Capabilities response for Microsoft.RecoveryServices |
| CapabilitiesResponseProperties |
Capabilities properties in response |
| CertificateRequest |
Details of the certificate to be uploaded to the vault. |
| CheckNameAvailabilityParameters |
Resource Name availability input parameters - Resource type and resource name |
| CheckNameAvailabilityResult |
Response for check name availability API. Resource provider will set availability as true | false. |
| ClassicAlertSettings |
Settings for classic alerts |
| ClientDiscoveryDisplay |
Localized display information of an operation. |
| ClientDiscoveryForLogSpecification |
Class to represent shoebox log specification in json client discovery. |
| ClientDiscoveryForProperties |
Class to represent shoebox properties in json client discovery. |
| ClientDiscoveryForServiceSpecification |
Class to represent shoebox service specification in json client discovery. |
| ClientDiscoveryResponse |
Operations List response which contains list of available APIs. |
| ClientDiscoveryValueForSingleApi |
Available operation details. |
| CloudError |
An error response from Azure Backup. |
| CmkKekIdentity |
The details of the identity used for CMK |
| CmkKeyVaultProperties |
The properties of the Key Vault which hosts CMK |
| CrossSubscriptionRestoreSettings |
Settings for Cross Subscription Restore Settings |
| DNSZone |
DNSZone information |
| DNSZoneResponse |
DNSZone information for Microsoft.RecoveryServices |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorModel |
The resource management error response. |
| 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.). |
| GetOperationResultOptionalParams |
Optional parameters. |
| GetOperationStatusOptionalParams |
Optional parameters. |
| IdentityData |
Identity for the resource. |
| ImmutabilitySettings |
Immutability Settings of vault |
| JobsSummary |
Summary of the replication job data for this vault. |
| MonitoringSettings |
Monitoring Settings of the vault |
| MonitoringSummary |
Summary of the replication monitoring data for this vault. |
| NameInfo |
The name of usage. |
| OperationResource |
Operation Resource |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PatchTrackedResource |
Tracked resource with location. |
| PatchVault |
Patch Resource information, as returned by the resource provider. |
| PrivateEndpoint |
The Private Endpoint network resource that is linked to the Private Endpoint connection. |
| PrivateEndpointConnection |
Private Endpoint Connection Response Properties. |
| PrivateEndpointConnectionVaultProperties |
Information to be stored in Vault properties as an element of privateEndpointConnections List. |
| PrivateLinkResource |
Information of the private link resource. |
| PrivateLinkResources |
Class which represent the stamps associated with the vault. |
| PrivateLinkResourcesGetOptionalParams |
Optional parameters. |
| PrivateLinkResourcesListNextOptionalParams |
Optional parameters. |
| PrivateLinkResourcesListOptionalParams |
Optional parameters. |
| PrivateLinkResourcesOperations |
Interface representing a PrivateLinkResourcesOperations. |
| PrivateLinkServiceConnectionState |
Gets or sets private link service connection state. |
| RawCertificateData |
Raw certificate data. |
| RecoveryServices |
Interface representing a RecoveryServices. |
| RecoveryServicesCapabilitiesOptionalParams |
Optional parameters. |
| RecoveryServicesCheckNameAvailabilityOptionalParams |
Optional parameters. |
| RecoveryServicesClientOptionalParams |
Optional parameters. |
| RegisteredIdentities |
Interface representing a RegisteredIdentities. |
| RegisteredIdentitiesDeleteOptionalParams |
Optional parameters. |
| ReplicationUsage |
Replication usages of a vault. |
| ReplicationUsageList |
Replication usages for vault. |
| ReplicationUsages |
Interface representing a ReplicationUsages. |
| ReplicationUsagesListOptionalParams |
Optional parameters. |
| Resource |
ARM Resource. |
| ResourceCapabilities |
Input to get capabilities information for Microsoft.RecoveryServices |
| ResourceCapabilitiesBase |
Base class for request and response capabilities information for Microsoft.RecoveryServices |
| ResourceCertificateAndAadDetails |
Certificate details representing the Vault credentials for AAD. |
| ResourceCertificateAndAcsDetails |
Certificate details representing the Vault credentials for ACS. |
| ResourceCertificateDetails |
Certificate details representing the Vault credentials. |
| RestoreSettings |
Restore Settings of the vault |
| SecuritySettings |
Security Settings of the vault |
| Sku |
Identifies the unique system identifier for each Azure resource. |
| SoftDeleteSettings |
Soft delete Settings of vault |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
Tracked resource with location. |
| UpgradeDetails |
Details for upgrading vault. |
| Usages |
Interface representing a Usages. |
| UsagesListByVaultsOptionalParams |
Optional parameters. |
| UserIdentity |
A resource identity that is managed by the user of the service. |
| Vault |
Resource information, as returned by the resource provider. |
| VaultCertificateResponse |
Certificate corresponding to a vault that can be used by clients to register themselves with the vault. |
| VaultCertificates |
Interface representing a VaultCertificates. |
| VaultCertificatesCreateOptionalParams |
Optional parameters. |
| VaultExtendedInfo |
Interface representing a VaultExtendedInfo. |
| VaultExtendedInfoCreateOrUpdateOptionalParams |
Optional parameters. |
| VaultExtendedInfoGetOptionalParams |
Optional parameters. |
| VaultExtendedInfoResource |
Vault extended information. |
| VaultExtendedInfoUpdateOptionalParams |
Optional parameters. |
| VaultList |
The response model for a list of Vaults. |
| VaultProperties |
Properties of the vault. |
| VaultPropertiesEncryption |
Customer Managed Key details of the resource. |
| VaultPropertiesMoveDetails |
The details of the latest move operation performed on the Azure Resource |
| VaultPropertiesRedundancySettings |
The redundancy Settings of a Vault |
| VaultUsage |
Usages of a vault. |
| VaultUsageList |
Usage for vault. |
| Vaults |
Interface representing a Vaults. |
| VaultsCreateOrUpdateOptionalParams |
Optional parameters. |
| VaultsDeleteHeaders |
Defines headers for Vaults_delete operation. |
| VaultsDeleteOptionalParams |
Optional parameters. |
| VaultsGetOptionalParams |
Optional parameters. |
| VaultsListByResourceGroupNextOptionalParams |
Optional parameters. |
| VaultsListByResourceGroupOptionalParams |
Optional parameters. |
| VaultsListBySubscriptionIdNextOptionalParams |
Optional parameters. |
| VaultsListBySubscriptionIdOptionalParams |
Optional parameters. |
| VaultsUpdateOptionalParams |
Optional parameters. |
Type Aliases
| AlertsState |
Defines values for AlertsState. Known values supported by the serviceEnabled |
| AuthType |
Defines values for AuthType. Known values supported by the serviceInvalid |
| BackupStorageVersion |
Defines values for BackupStorageVersion. Known values supported by the serviceV1 |
| BcdrSecurityLevel |
Defines values for BcdrSecurityLevel. Known values supported by the servicePoor |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| CrossRegionRestore |
Defines values for CrossRegionRestore. Known values supported by the serviceEnabled |
| CrossSubscriptionRestoreState |
Defines values for CrossSubscriptionRestoreState. Known values supported by the serviceEnabled |
| EnhancedSecurityState |
Defines values for EnhancedSecurityState. Known values supported by the serviceInvalid |
| GetOperationResultResponse |
Contains response data for the getOperationResult operation. |
| GetOperationStatusResponse |
Contains response data for the getOperationStatus operation. |
| ImmutabilityState |
Defines values for ImmutabilityState. Known values supported by the serviceDisabled |
| InfrastructureEncryptionState |
Defines values for InfrastructureEncryptionState. Known values supported by the serviceEnabled |
| MultiUserAuthorization |
Defines values for MultiUserAuthorization. Known values supported by the serviceInvalid |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| PrivateEndpointConnectionStatus |
Defines values for PrivateEndpointConnectionStatus. Known values supported by the servicePending |
| PrivateLinkResourcesGetResponse |
Contains response data for the get operation. |
| PrivateLinkResourcesListNextResponse |
Contains response data for the listNext operation. |
| PrivateLinkResourcesListResponse |
Contains response data for the list operation. |
| ProvisioningState |
Defines values for ProvisioningState. Known values supported by the serviceSucceeded |
| PublicNetworkAccess |
Defines values for PublicNetworkAccess. Known values supported by the serviceEnabled |
| RecoveryServicesCapabilitiesResponse |
Contains response data for the capabilities operation. |
| RecoveryServicesCheckNameAvailabilityResponse |
Contains response data for the checkNameAvailability operation. |
| ReplicationUsagesListResponse |
Contains response data for the list operation. |
| ResourceCertificateDetailsUnion | |
| ResourceIdentityType |
Defines values for ResourceIdentityType. Known values supported by the serviceSystemAssigned |
| ResourceMoveState |
Defines values for ResourceMoveState. Known values supported by the serviceUnknown |
| SecureScoreLevel |
Defines values for SecureScoreLevel. Known values supported by the serviceNone |
| SkuName |
Defines values for SkuName. Known values supported by the serviceStandard |
| SoftDeleteState |
Defines values for SoftDeleteState. Known values supported by the serviceInvalid |
| StandardTierStorageRedundancy |
Defines values for StandardTierStorageRedundancy. Known values supported by the serviceInvalid |
| TriggerType |
Defines values for TriggerType. Known values supported by the serviceUserTriggered |
| UsagesListByVaultsResponse |
Contains response data for the listByVaults operation. |
| UsagesUnit |
Defines values for UsagesUnit. Known values supported by the serviceCount |
| VaultCertificatesCreateResponse |
Contains response data for the create operation. |
| VaultExtendedInfoCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| VaultExtendedInfoGetResponse |
Contains response data for the get operation. |
| VaultExtendedInfoUpdateResponse |
Contains response data for the update operation. |
| VaultPrivateEndpointState |
Defines values for VaultPrivateEndpointState. Known values supported by the serviceNone |
| VaultSubResourceType |
Defines values for VaultSubResourceType. Known values supported by the serviceAzureBackup |
| VaultUpgradeState |
Defines values for VaultUpgradeState. Known values supported by the serviceUnknown |
| VaultsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| VaultsDeleteResponse |
Contains response data for the delete operation. |
| VaultsGetResponse |
Contains response data for the get operation. |
| VaultsListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| VaultsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| VaultsListBySubscriptionIdNextResponse |
Contains response data for the listBySubscriptionIdNext operation. |
| VaultsListBySubscriptionIdResponse |
Contains response data for the listBySubscriptionId operation. |
| VaultsUpdateResponse |
Contains response data for the update operation. |
Enums
| KnownAlertsState |
Known values of AlertsState that the service accepts. |
| KnownAuthType |
Known values of AuthType that the service accepts. |
| KnownBackupStorageVersion |
Known values of BackupStorageVersion that the service accepts. |
| KnownBcdrSecurityLevel |
Known values of BcdrSecurityLevel that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownCrossRegionRestore |
Known values of CrossRegionRestore that the service accepts. |
| KnownCrossSubscriptionRestoreState |
Known values of CrossSubscriptionRestoreState that the service accepts. |
| KnownEnhancedSecurityState |
Known values of EnhancedSecurityState that the service accepts. |
| KnownImmutabilityState |
Known values of ImmutabilityState that the service accepts. |
| KnownInfrastructureEncryptionState |
Known values of InfrastructureEncryptionState that the service accepts. |
| KnownMultiUserAuthorization |
Known values of MultiUserAuthorization that the service accepts. |
| KnownPrivateEndpointConnectionStatus |
Known values of PrivateEndpointConnectionStatus that the service accepts. |
| KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
| KnownPublicNetworkAccess |
Known values of PublicNetworkAccess that the service accepts. |
| KnownResourceIdentityType |
Known values of ResourceIdentityType that the service accepts. |
| KnownResourceMoveState |
Known values of ResourceMoveState that the service accepts. |
| KnownSecureScoreLevel |
Known values of SecureScoreLevel that the service accepts. |
| KnownSkuName |
Known values of SkuName that the service accepts. |
| KnownSoftDeleteState |
Known values of SoftDeleteState that the service accepts. |
| KnownStandardTierStorageRedundancy |
Known values of StandardTierStorageRedundancy that the service accepts. |
| KnownTriggerType |
Known values of TriggerType that the service accepts. |
| KnownUsagesUnit |
Known values of UsagesUnit that the service accepts. |
| KnownVaultPrivateEndpointState |
Known values of VaultPrivateEndpointState that the service accepts. |
| KnownVaultSubResourceType |
Known values of VaultSubResourceType that the service accepts. |
| KnownVaultUpgradeState |
Known values of VaultUpgradeState that the service accepts. |
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.