@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.
KnownAlertsState can be used interchangeably with AlertsState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

AuthType

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

Known values supported by the service

Invalid
ACS
AAD
AccessControlService
AzureActiveDirectory

BackupStorageVersion

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

Known values supported by the service

V1
V2
Unassigned

BcdrSecurityLevel

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

Known values supported by the service

Poor
Fair
Good
Excellent

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

CrossRegionRestore

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

Known values supported by the service

Enabled
Disabled

CrossSubscriptionRestoreState

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

Known values supported by the service

Enabled
Disabled
PermanentlyDisabled

EnhancedSecurityState

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

Known values supported by the service

Invalid
Enabled
Disabled
AlwaysON

GetOperationResultResponse

Contains response data for the getOperationResult operation.

GetOperationStatusResponse

Contains response data for the getOperationStatus operation.

ImmutabilityState

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

Known values supported by the service

Disabled
Unlocked
Locked

InfrastructureEncryptionState

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

Known values supported by the service

Enabled
Disabled

MultiUserAuthorization

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

Known values supported by the service

Invalid
Enabled
Disabled

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionStatus

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

Known values supported by the service

Pending
Approved
Rejected
Disconnected

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.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Deleting
Failed
Pending

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

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.
KnownResourceIdentityType can be used interchangeably with ResourceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
None
UserAssigned
SystemAssigned, UserAssigned

ResourceMoveState

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

Known values supported by the service

Unknown
InProgress
PrepareFailed
CommitFailed
PrepareTimedout
CommitTimedout
MoveSucceeded
Failure
CriticalFailure
PartialSuccess

SecureScoreLevel

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

Known values supported by the service

None
Minimum
Adequate
Maximum

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

Standard
RS0

SoftDeleteState

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

Known values supported by the service

Invalid
Enabled
Disabled
AlwaysON

StandardTierStorageRedundancy

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

Known values supported by the service

Invalid
LocallyRedundant
GeoRedundant
ZoneRedundant

TriggerType

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

Known values supported by the service

UserTriggered
ForcedUpgrade

UsagesListByVaultsResponse

Contains response data for the listByVaults operation.

UsagesUnit

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

Known values supported by the service

Count
Bytes
Seconds
Percent
CountPerSecond
BytesPerSecond

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.
KnownVaultPrivateEndpointState can be used interchangeably with VaultPrivateEndpointState, this enum contains the known values that the service supports.

Known values supported by the service

None
Enabled

VaultSubResourceType

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

Known values supported by the service

AzureBackup
AzureBackup_secondary
AzureSiteRecovery

VaultUpgradeState

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

Known values supported by the service

Unknown
InProgress
Upgraded
Failed

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

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.