replication_protectable_items

Creates, updates, deletes, gets or lists a replication_protectable_items resource.

Overview

Name	replication_protectable_items
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protectable_items

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customDetails	object	The Replication provider custom settings.
friendlyName	string	The name.
location	string	Resource Location.
protectionReadinessErrors	array	The Current protection readiness errors.
protectionStatus	string	The protection status.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationProtectedItemId	string	The ARM resource of protected items.
supportedReplicationProviders	array	The list of replication providers supported for the protectable item.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_replication_protection_containers

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
customDetails	object	The Replication provider custom settings.
friendlyName	string	The name.
location	string	Resource Location.
protectionReadinessErrors	array	The Current protection readiness errors.
protectionStatus	string	The protection status.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationProtectedItemId	string	The ARM resource of protected items.
supportedReplicationProviders	array	The list of replication providers supported for the protectable item.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, fabric_name, protection_container_name, protectable_item_name, subscription_id		Gets the details of a protectable item. The operation to get the details of a protectable item.
list_by_replication_protection_containers	select	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id	$filter, $take, $skipToken	Gets the list of protectable items. Lists the protectable items in a protection container.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fabric_name	string	Fabric name. Required.
protectable_item_name	string	Protectable item name. Required.
protection_container_name	string	Protection container name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string
$filter	string	OData filter options. Default value is None.
$skipToken	string	skipToken OData query parameter. Default value is None.
$take	string	take OData query parameter. Default value is None.

SELECT examples

get

Gets the details of a protectable item. The operation to get the details of a protectable item.

SELECT
id,
name,
customDetails,
friendlyName,
location,
protectionReadinessErrors,
protectionStatus,
recoveryServicesProviderId,
replicationProtectedItemId,
supportedReplicationProviders,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protectable_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND protection_container_name = '{{ protection_container_name }}' -- required
AND protectable_item_name = '{{ protectable_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_protection_containers

Gets the list of protectable items. Lists the protectable items in a protection container.

SELECT
id,
name,
customDetails,
friendlyName,
location,
protectionReadinessErrors,
protectionStatus,
recoveryServicesProviderId,
replicationProtectedItemId,
supportedReplicationProviders,
systemData,
type
FROM azure.recovery_services_site_recovery.replication_protectable_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND protection_container_name = '{{ protection_container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $take = '{{ $take }}'
AND $skipToken = '{{ $skipToken }}'
;