backup_instances_extension_routing

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

Overview

Name	backup_instances_extension_routing
Type	Resource
Id	azure.data_protection.backup_instances_extension_routing

Fields

The following fields are returned by SELECT queries:

list

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.
currentProtectionState	string	Specifies the current protection state of the resource. Known values are: "Invalid", "NotProtected", "ConfiguringProtection", "ProtectionConfigured", "BackupSchedulesSuspended", "RetentionSchedulesSuspended", "ProtectionStopped", "ProtectionError", "ConfiguringProtectionFailed", "SoftDeleting", "SoftDeleted", and "UpdatingProtection". (Invalid, NotProtected, ConfiguringProtection, ProtectionConfigured, BackupSchedulesSuspended, RetentionSchedulesSuspended, ProtectionStopped, ProtectionError, ConfiguringProtectionFailed, SoftDeleting, SoftDeleted, UpdatingProtection)
dataSourceInfo	object	Gets or sets the data source information. Required.
dataSourceSetInfo	object	Gets or sets the data source set information.
datasourceAuthCredentials	object	Credentials to use to authenticate with data source provider.
friendlyName	string	Gets or sets the Backup Instance friendly name.
identityDetails	object	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
objectType	string	Required.
policyInfo	object	Gets or sets the policy information. Required.
protectionErrorDetails	object	Specifies the protection error of the resource.
protectionStatus	object	Specifies the protection status of the resource.
provisioningState	string	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Proxy Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationType	string	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: "ShallowValidation" and "DeepValidation". (ShallowValidation, DeepValidation)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_id		Gets a list of backup instances associated with a tracked resource.

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
resource_id	string	ARM path of the resource to be protected using Microsoft.DataProtection. Required.

SELECT examples

list

Gets a list of backup instances associated with a tracked resource.

SELECT
id,
name,
currentProtectionState,
dataSourceInfo,
dataSourceSetInfo,
datasourceAuthCredentials,
friendlyName,
identityDetails,
objectType,
policyInfo,
protectionErrorDetails,
protectionStatus,
provisioningState,
resourceGuardOperationRequests,
systemData,
tags,
type,
validationType
FROM azure.data_protection.backup_instances_extension_routing
WHERE resource_id = '{{ resource_id }}' -- required
;