Share via


ProtectedItemOperations interface

Interface representing a ProtectedItem operations.

Properties

create

Creates the protected item.

delete
get

Gets the details of the protected item.

list

Gets the list of protected items in the given vault.

plannedFailover

Performs the planned failover on the protected item.

update

Performs update on the protected item.

Property Details

create

Creates the protected item.

create: (resourceGroupName: string, vaultName: string, protectedItemName: string, resource: ProtectedItemModel, options?: ProtectedItemCreateOptionalParams) => PollerLike<OperationState<ProtectedItemModel>, ProtectedItemModel>

Property Value

(resourceGroupName: string, vaultName: string, protectedItemName: string, resource: ProtectedItemModel, options?: ProtectedItemCreateOptionalParams) => PollerLike<OperationState<ProtectedItemModel>, ProtectedItemModel>

delete

delete: (resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the details of the protected item.

get: (resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemGetOptionalParams) => Promise<ProtectedItemModel>

Property Value

(resourceGroupName: string, vaultName: string, protectedItemName: string, options?: ProtectedItemGetOptionalParams) => Promise<ProtectedItemModel>

list

Gets the list of protected items in the given vault.

list: (resourceGroupName: string, vaultName: string, options?: ProtectedItemListOptionalParams) => PagedAsyncIterableIterator<ProtectedItemModel, ProtectedItemModel[], PageSettings>

Property Value

(resourceGroupName: string, vaultName: string, options?: ProtectedItemListOptionalParams) => PagedAsyncIterableIterator<ProtectedItemModel, ProtectedItemModel[], PageSettings>

plannedFailover

Performs the planned failover on the protected item.

plannedFailover: (resourceGroupName: string, vaultName: string, protectedItemName: string, body: PlannedFailoverModel, options?: ProtectedItemPlannedFailoverOptionalParams) => PollerLike<OperationState<PlannedFailoverModel>, PlannedFailoverModel>

Property Value

(resourceGroupName: string, vaultName: string, protectedItemName: string, body: PlannedFailoverModel, options?: ProtectedItemPlannedFailoverOptionalParams) => PollerLike<OperationState<PlannedFailoverModel>, PlannedFailoverModel>

update

Performs update on the protected item.

update: (resourceGroupName: string, vaultName: string, protectedItemName: string, properties: ProtectedItemModelUpdate, options?: ProtectedItemUpdateOptionalParams) => PollerLike<OperationState<ProtectedItemModel>, ProtectedItemModel>

Property Value

(resourceGroupName: string, vaultName: string, protectedItemName: string, properties: ProtectedItemModelUpdate, options?: ProtectedItemUpdateOptionalParams) => PollerLike<OperationState<ProtectedItemModel>, ProtectedItemModel>