Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. recoveryservices
  5. getProtectionIntent
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.recoveryservices.getProtectionIntent

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Uses Azure REST API version 2024-10-01.

Other available API versions: 2023-02-01, 2023-04-01, 2023-06-01, 2023-08-01, 2024-01-01, 2024-02-01, 2024-04-01, 2024-04-30-preview, 2024-07-30-preview, 2024-11-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native recoveryservices [ApiVersion]. See the version guide for details.

Using getProtectionIntent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProtectionIntent(args: GetProtectionIntentArgs, opts?: InvokeOptions): Promise<GetProtectionIntentResult>
function getProtectionIntentOutput(args: GetProtectionIntentOutputArgs, opts?: InvokeOptions): Output<GetProtectionIntentResult>
Copy
def get_protection_intent(fabric_name: Optional[str] = None,
                          intent_object_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          vault_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetProtectionIntentResult
def get_protection_intent_output(fabric_name: Optional[pulumi.Input[str]] = None,
                          intent_object_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          vault_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetProtectionIntentResult]
Copy
func LookupProtectionIntent(ctx *Context, args *LookupProtectionIntentArgs, opts ...InvokeOption) (*LookupProtectionIntentResult, error)
func LookupProtectionIntentOutput(ctx *Context, args *LookupProtectionIntentOutputArgs, opts ...InvokeOption) LookupProtectionIntentResultOutput
Copy

> Note: This function is named LookupProtectionIntent in the Go SDK.

public static class GetProtectionIntent 
{
    public static Task<GetProtectionIntentResult> InvokeAsync(GetProtectionIntentArgs args, InvokeOptions? opts = null)
    public static Output<GetProtectionIntentResult> Invoke(GetProtectionIntentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProtectionIntentResult> getProtectionIntent(GetProtectionIntentArgs args, InvokeOptions options)
public static Output<GetProtectionIntentResult> getProtectionIntent(GetProtectionIntentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:recoveryservices:getProtectionIntent
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FabricName
This property is required.
Changes to this property will trigger replacement.
string
Fabric name associated with the backed up item.
IntentObjectName
This property is required.
Changes to this property will trigger replacement.
string
Backed up item name whose details are to be fetched.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
FabricName
This property is required.
Changes to this property will trigger replacement.
string
Fabric name associated with the backed up item.
IntentObjectName
This property is required.
Changes to this property will trigger replacement.
string
Backed up item name whose details are to be fetched.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
fabricName
This property is required.
Changes to this property will trigger replacement.
String
Fabric name associated with the backed up item.
intentObjectName
This property is required.
Changes to this property will trigger replacement.
String
Backed up item name whose details are to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.
fabricName
This property is required.
Changes to this property will trigger replacement.
string
Fabric name associated with the backed up item.
intentObjectName
This property is required.
Changes to this property will trigger replacement.
string
Backed up item name whose details are to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the recovery services vault.
fabric_name
This property is required.
Changes to this property will trigger replacement.
str
Fabric name associated with the backed up item.
intent_object_name
This property is required.
Changes to this property will trigger replacement.
str
Backed up item name whose details are to be fetched.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group where the recovery services vault is present.
vault_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the recovery services vault.
fabricName
This property is required.
Changes to this property will trigger replacement.
String
Fabric name associated with the backed up item.
intentObjectName
This property is required.
Changes to this property will trigger replacement.
String
Backed up item name whose details are to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group where the recovery services vault is present.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the recovery services vault.

getProtectionIntent Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id represents the complete path to the resource.
Name string
Resource name associated with the resource.
Properties Pulumi.AzureNative.RecoveryServices.Outputs.AzureRecoveryServiceVaultProtectionIntentResponse | Pulumi.AzureNative.RecoveryServices.Outputs.AzureResourceProtectionIntentResponse | Pulumi.AzureNative.RecoveryServices.Outputs.AzureWorkloadAutoProtectionIntentResponse | Pulumi.AzureNative.RecoveryServices.Outputs.AzureWorkloadContainerAutoProtectionIntentResponse | Pulumi.AzureNative.RecoveryServices.Outputs.AzureWorkloadSQLAutoProtectionIntentResponse
ProtectionIntentResource properties
Type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
ETag string
Optional ETag.
Location string
Resource location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id represents the complete path to the resource.
Name string
Resource name associated with the resource.
Properties AzureRecoveryServiceVaultProtectionIntentResponse | AzureResourceProtectionIntentResponse | AzureWorkloadAutoProtectionIntentResponse | AzureWorkloadContainerAutoProtectionIntentResponse | AzureWorkloadSQLAutoProtectionIntentResponse
ProtectionIntentResource properties
Type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
ETag string
Optional ETag.
Location string
Resource location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id represents the complete path to the resource.
name String
Resource name associated with the resource.
properties AzureRecoveryServiceVaultProtectionIntentResponse | AzureResourceProtectionIntentResponse | AzureWorkloadAutoProtectionIntentResponse | AzureWorkloadContainerAutoProtectionIntentResponse | AzureWorkloadSQLAutoProtectionIntentResponse
ProtectionIntentResource properties
type String
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag String
Optional ETag.
location String
Resource location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id represents the complete path to the resource.
name string
Resource name associated with the resource.
properties AzureRecoveryServiceVaultProtectionIntentResponse | AzureResourceProtectionIntentResponse | AzureWorkloadAutoProtectionIntentResponse | AzureWorkloadContainerAutoProtectionIntentResponse | AzureWorkloadSQLAutoProtectionIntentResponse
ProtectionIntentResource properties
type string
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag string
Optional ETag.
location string
Resource location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Resource Id represents the complete path to the resource.
name str
Resource name associated with the resource.
properties AzureRecoveryServiceVaultProtectionIntentResponse | AzureResourceProtectionIntentResponse | AzureWorkloadAutoProtectionIntentResponse | AzureWorkloadContainerAutoProtectionIntentResponse | AzureWorkloadSQLAutoProtectionIntentResponse
ProtectionIntentResource properties
type str
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
e_tag str
Optional ETag.
location str
Resource location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id represents the complete path to the resource.
name String
Resource name associated with the resource.
properties Property Map | Property Map | Property Map | Property Map | Property Map
ProtectionIntentResource properties
type String
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
eTag String
Optional ETag.
location String
Resource location.
tags Map<String>
Resource tags.

Supporting Types

AzureRecoveryServiceVaultProtectionIntentResponse

BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
backupManagementType string
Type of backup management for the backed up item.
itemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId string
ID of the backup policy with which this item is backed up.
protectionState string
Backup state of this backup item.
sourceResourceId string
ARM ID of the resource to be backed up.
backup_management_type str
Type of backup management for the backed up item.
item_id str
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id str
ID of the backup policy with which this item is backed up.
protection_state str
Backup state of this backup item.
source_resource_id str
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.

AzureResourceProtectionIntentResponse

BackupManagementType string
Type of backup management for the backed up item.
FriendlyName string
Friendly name of the VM represented by this backup item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
BackupManagementType string
Type of backup management for the backed up item.
FriendlyName string
Friendly name of the VM represented by this backup item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
friendlyName String
Friendly name of the VM represented by this backup item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
backupManagementType string
Type of backup management for the backed up item.
friendlyName string
Friendly name of the VM represented by this backup item.
itemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId string
ID of the backup policy with which this item is backed up.
protectionState string
Backup state of this backup item.
sourceResourceId string
ARM ID of the resource to be backed up.
backup_management_type str
Type of backup management for the backed up item.
friendly_name str
Friendly name of the VM represented by this backup item.
item_id str
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id str
ID of the backup policy with which this item is backed up.
protection_state str
Backup state of this backup item.
source_resource_id str
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
friendlyName String
Friendly name of the VM represented by this backup item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.

AzureWorkloadAutoProtectionIntentResponse

BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
backupManagementType string
Type of backup management for the backed up item.
itemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId string
ID of the backup policy with which this item is backed up.
protectionState string
Backup state of this backup item.
sourceResourceId string
ARM ID of the resource to be backed up.
backup_management_type str
Type of backup management for the backed up item.
item_id str
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id str
ID of the backup policy with which this item is backed up.
protection_state str
Backup state of this backup item.
source_resource_id str
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.

AzureWorkloadContainerAutoProtectionIntentResponse

BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
backupManagementType string
Type of backup management for the backed up item.
itemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId string
ID of the backup policy with which this item is backed up.
protectionState string
Backup state of this backup item.
sourceResourceId string
ARM ID of the resource to be backed up.
backup_management_type str
Type of backup management for the backed up item.
item_id str
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id str
ID of the backup policy with which this item is backed up.
protection_state str
Backup state of this backup item.
source_resource_id str
ARM ID of the resource to be backed up.
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.

AzureWorkloadSQLAutoProtectionIntentResponse

BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
WorkloadItemType string
Workload item type of the item for which intent is to be set
BackupManagementType string
Type of backup management for the backed up item.
ItemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
PolicyId string
ID of the backup policy with which this item is backed up.
ProtectionState string
Backup state of this backup item.
SourceResourceId string
ARM ID of the resource to be backed up.
WorkloadItemType string
Workload item type of the item for which intent is to be set
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
workloadItemType String
Workload item type of the item for which intent is to be set
backupManagementType string
Type of backup management for the backed up item.
itemId string
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId string
ID of the backup policy with which this item is backed up.
protectionState string
Backup state of this backup item.
sourceResourceId string
ARM ID of the resource to be backed up.
workloadItemType string
Workload item type of the item for which intent is to be set
backup_management_type str
Type of backup management for the backed up item.
item_id str
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policy_id str
ID of the backup policy with which this item is backed up.
protection_state str
Backup state of this backup item.
source_resource_id str
ARM ID of the resource to be backed up.
workload_item_type str
Workload item type of the item for which intent is to be set
backupManagementType String
Type of backup management for the backed up item.
itemId String
ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId
policyId String
ID of the backup policy with which this item is backed up.
protectionState String
Backup state of this backup item.
sourceResourceId String
ARM ID of the resource to be backed up.
workloadItemType String
Workload item type of the item for which intent is to be set

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native