@azure/arm-recoveryservices package

Classes

RecoveryServicesClient

Interfaces

AssociatedIdentity	Identity details to be used for an operation
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.
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
DeletedVault	DeletedVault information as returned by the resource provider.
DeletedVaultProperties	Properties of the DeletedVault.
DeletedVaultUndeleteInput	Input definition for DeletedVault undelete.
DeletedVaultUndeleteInputProperties	Input definition for DeletedVault undelete properties.
DeletedVaultsGetOperationStatusOptionalParams	Optional parameters.
DeletedVaultsGetOptionalParams	Optional parameters.
DeletedVaultsListBySubscriptionIdOptionalParams	Optional parameters.
DeletedVaultsOperations	Interface representing a DeletedVaults operations.
DeletedVaultsUndeleteOptionalParams	Optional parameters.
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.
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
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.
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.
PrivateLinkResourceProperties	Properties of the private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	Gets or sets 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
RawCertificateData	Raw certificate data.
RecoveryServicesCapabilitiesOptionalParams	Optional parameters.
RecoveryServicesCheckNameAvailabilityOptionalParams	Optional parameters.
RecoveryServicesClientOptionalParams	Optional parameters for the client.
RecoveryServicesOperations	Interface representing a RecoveryServices operations.
RegisteredIdentitiesDeleteOptionalParams	Optional parameters.
RegisteredIdentitiesOperations	Interface representing a RegisteredIdentities operations.
ReplicationUsage	Replication usages of a vault.
ReplicationUsagesListOptionalParams	Optional parameters.
ReplicationUsagesOperations	Interface representing a ReplicationUsages operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
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.
RestorePollerOptions
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
SourceScanConfiguration	Source scan configuration of vault
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'
UpgradeDetails	Details for upgrading vault.
UsagesListByVaultsOptionalParams	Optional parameters.
UsagesOperations	Interface representing a Usages operations.
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.
VaultCertificatesCreateOptionalParams	Optional parameters.
VaultCertificatesOperations	Interface representing a VaultCertificates operations.
VaultExtendedInfo	Vault extended information.
VaultExtendedInfoCreateOrUpdateOptionalParams	Optional parameters.
VaultExtendedInfoGetOptionalParams	Optional parameters.
VaultExtendedInfoOperations	Interface representing a VaultExtendedInfo operations.
VaultExtendedInfoResource	Vault extended information.
VaultExtendedInfoUpdateOptionalParams	Optional parameters.
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.
VaultsCreateOrUpdateOptionalParams	Optional parameters.
VaultsDeleteOptionalParams	Optional parameters.
VaultsGetOptionalParams	Optional parameters.
VaultsListByResourceGroupOptionalParams	Optional parameters.
VaultsListBySubscriptionIdOptionalParams	Optional parameters.
VaultsOperations	Interface representing a Vaults operations.
VaultsUpdateOptionalParams	Optional parameters.

Type Aliases

AlertsState	Type of AlertsState
AuthType	Specifies the authentication type. 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
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BackupStorageVersion	Backup storage version 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	Security levels of Recovery Services Vault for business continuity and disaster recovery 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
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.
CrossRegionRestore	Flag to show if Cross Region Restore is enabled on the Vault or not 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	Type of CrossSubscriptionRestoreState
EnhancedSecurityState	Type of EnhancedSecurityState
IdentityType	Identity type that should be used for an operation. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned
ImmutabilityState	Type of ImmutabilityState
InfrastructureEncryptionState	Enabling/Disabling the Double Encryption state 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	MUA Settings of vault 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
PrivateEndpointConnectionStatus	Gets or sets the status. 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
ProvisioningState	Gets or sets provisioning state of the private endpoint connection. 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	property to enable or disable resource provider inbound network traffic from public clients 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
ResourceCertificateDetailsUnion	Alias for ResourceCertificateDetailsUnion
ResourceIdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. 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	The State of the Resource after the move operation 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	Secure Score of Recovery Services Vault 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	Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig 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	Type of SoftDeleteState
StandardTierStorageRedundancy	The storage redundancy setting of a vault 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
State	Type of State
TriggerType	The way the vault upgrade was triggered. 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
UsagesUnit	Unit of the usage. 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
VaultPrivateEndpointState	Private endpoint state for backup. 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	Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery 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	Status of the vault upgrade operation. 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

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAlertsState	Known values of AlertsState that the service accepts.
KnownAuthType	Specifies the authentication type.
KnownBackupStorageVersion	Backup storage version
KnownBcdrSecurityLevel	Security levels of Recovery Services Vault for business continuity and disaster recovery
KnownCreatedByType	The kind of entity that created the resource.
KnownCrossRegionRestore	Flag to show if Cross Region Restore is enabled on the Vault or not
KnownCrossSubscriptionRestoreState	Known values of CrossSubscriptionRestoreState that the service accepts.
KnownEnhancedSecurityState	Known values of EnhancedSecurityState that the service accepts.
KnownIdentityType	Identity type that should be used for an operation.
KnownImmutabilityState	Known values of ImmutabilityState that the service accepts.
KnownInfrastructureEncryptionState	Enabling/Disabling the Double Encryption state
KnownMultiUserAuthorization	MUA Settings of vault
KnownPrivateEndpointConnectionStatus	Gets or sets the status.
KnownProvisioningState	Gets or sets provisioning state of the private endpoint connection.
KnownPublicNetworkAccess	property to enable or disable resource provider inbound network traffic from public clients
KnownResourceIdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
KnownResourceMoveState	The State of the Resource after the move operation
KnownSecureScoreLevel	Secure Score of Recovery Services Vault
KnownSkuName	Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig
KnownSoftDeleteState	Known values of SoftDeleteState that the service accepts.
KnownStandardTierStorageRedundancy	The storage redundancy setting of a vault
KnownState	Known values of State that the service accepts.
KnownTriggerType	The way the vault upgrade was triggered.
KnownUsagesUnit	Unit of the usage.
KnownVaultPrivateEndpointState	Private endpoint state for backup.
KnownVaultSubResourceType	Subresource type for vault AzureBackup, AzureBackup_secondary or AzureSiteRecovery
KnownVaultUpgradeState	Status of the vault upgrade operation.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(RecoveryServicesClient, 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>(RecoveryServicesClient, 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: RecoveryServicesClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

RecoveryServicesClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>