ReplicationRecoveryServicesProviders | @azure/arm-recoveryservices-siterecovery

Class representing a ReplicationRecoveryServicesProviders.

Hierarchy

ReplicationRecoveryServicesProviders

Index

Constructors

constructor

Methods

Constructors

constructor

new ReplicationRecoveryServicesProviders(client: SiteRecoveryManagementClientContext): ReplicationRecoveryServicesProviders

- Defined in operations/replicationRecoveryServicesProviders.ts:20
Create a ReplicationRecoveryServicesProviders.

Parameters
- client: SiteRecoveryManagementClientContext
  
  Reference to the service client.
Returns ReplicationRecoveryServicesProviders

Methods

beginDeleteMethod

beginDeleteMethod(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryServicesProviders.ts:209
The operation to removes/delete(unregister) a recovery services provider from the vault

summary

Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object "deleteRspInput" is used (if the object is empty we assume that it is old client and continue the old behavior).

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginPurge

beginPurge(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryServicesProviders.ts:168
The operation to purge(force delete) a recovery services provider from the vault.

summary

Purges recovery service provider from fabric

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginRefreshProvider

beginRefreshProvider(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryServicesProviders.ts:187
The operation to refresh the information from the recovery services provider.

summary

Refresh details from the recovery services provider.

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

deleteMethod

deleteMethod(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/replicationRecoveryServicesProviders.ts:129
The operation to removes/delete(unregister) a recovery services provider from the vault

summary

Deletes provider from fabric. Note: Deleting provider for any fabric other than SingleHost is unsupported. To maintain backward compatibility for released clients the object "deleteRspInput" is used (if the object is empty we assume that it is old client and continue the old behavior).

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersGetResponse>
get(fabricName: string, providerName: string, callback: msRest.ServiceCallback<RecoveryServicesProvider>): void
get(fabricName: string, providerName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryServicesProvider>): void

- Defined in operations/replicationRecoveryServicesProviders.ts:67
Gets the details of registered recovery services provider.

summary

Gets the details of a recovery services provider.

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersGetResponse>

Promise<Models.ReplicationRecoveryServicesProvidersGetResponse>
- Defined in operations/replicationRecoveryServicesProviders.ts:73
Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name
- callback: msRest.ServiceCallback<RecoveryServicesProvider>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryServicesProviders.ts:80
Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryServicesProvider>
  
  The callback
Returns void

list

list(options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersListResponse>
list(callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void
list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void

- Defined in operations/replicationRecoveryServicesProviders.ts:141
Lists the registered recovery services providers in the vault

summary

Gets the list of registered recovery services providers in the vault. This is a view only api.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersListResponse>

Promise<Models.ReplicationRecoveryServicesProvidersListResponse>
- Defined in operations/replicationRecoveryServicesProviders.ts:145
Parameters
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryServicesProviders.ts:150
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void

listByReplicationFabrics

listByReplicationFabrics(fabricName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse>
listByReplicationFabrics(fabricName: string, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void
listByReplicationFabrics(fabricName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void

- Defined in operations/replicationRecoveryServicesProviders.ts:37
Lists the registered recovery services providers for the specified fabric.

summary

Gets the list of registered recovery services providers for the fabric.

Parameters
- fabricName: string
  
  Fabric name
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse>

Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse>
- Defined in operations/replicationRecoveryServicesProviders.ts:42
Parameters
- fabricName: string
  
  Fabric name
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryServicesProviders.ts:48
Parameters
- fabricName: string
  
  Fabric name
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void

listByReplicationFabricsNext

listByReplicationFabricsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsNextResponse>
listByReplicationFabricsNext(nextPageLink: string, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void
listByReplicationFabricsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void

- Defined in operations/replicationRecoveryServicesProviders.ts:228
Lists the registered recovery services providers for the specified fabric.

summary

Gets the list of registered recovery services providers for the fabric.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsNextResponse>

Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsNextResponse>
- Defined in operations/replicationRecoveryServicesProviders.ts:233
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryServicesProviders.ts:239
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>): void

- Defined in operations/replicationRecoveryServicesProviders.ts:258
Lists the registered recovery services providers in the vault

summary

Gets the list of registered recovery services providers in the vault. This is a view only api.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersListNextResponse>

Promise<Models.ReplicationRecoveryServicesProvidersListNextResponse>
- Defined in operations/replicationRecoveryServicesProviders.ts:263
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryServicesProviders.ts:269
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>
  
  The callback
Returns void

purge

purge(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/replicationRecoveryServicesProviders.ts:100
The operation to purge(force delete) a recovery services provider from the vault.

summary

Purges recovery service provider from fabric

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

refreshProvider

refreshProvider(fabricName: string, providerName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryServicesProvidersRefreshProviderResponse>

- Defined in operations/replicationRecoveryServicesProviders.ts:113
The operation to refresh the information from the recovery services provider.

summary

Refresh details from the recovery services provider.

Parameters
- fabricName: string
  
  Fabric name.
- providerName: string
  
  Recovery services provider name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryServicesProvidersRefreshProviderResponse>

Promise<Models.ReplicationRecoveryServicesProvidersRefreshProviderResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SiteRecoveryManagementClientContext

Returns ReplicationRecoveryServicesProviders

Methods

beginDeleteMethod

Parameters

fabricName: string

providerName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginPurge

Parameters

fabricName: string

providerName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginRefreshProvider

Parameters

fabricName: string

providerName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

deleteMethod

Parameters

fabricName: string

providerName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

fabricName: string

providerName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ReplicationRecoveryServicesProvidersGetResponse>

Parameters

fabricName: string

providerName: string

callback: msRest.ServiceCallback<RecoveryServicesProvider>

Returns void

Parameters

fabricName: string

providerName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<RecoveryServicesProvider>

Returns void

list

Parameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ReplicationRecoveryServicesProvidersListResponse>

Parameters

callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>

Returns void

Parameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>

Returns void

listByReplicationFabrics

Parameters

fabricName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ReplicationRecoveryServicesProvidersListByReplicationFabricsResponse>

Parameters

fabricName: string

callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>

Returns void

Parameters

fabricName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<RecoveryServicesProviderCollection>

Returns void

listByReplicationFabricsNext

Parameters

nextPageLink: string

Optional options: msRest.RequestOptionsBase