Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dataprotection
  5. getBackupInstance
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dataprotection.getBackupInstance

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a backup instance with name in a backup vault

Uses Azure REST API version 2025-01-01.

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

Using getBackupInstance

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 getBackupInstance(args: GetBackupInstanceArgs, opts?: InvokeOptions): Promise<GetBackupInstanceResult>
function getBackupInstanceOutput(args: GetBackupInstanceOutputArgs, opts?: InvokeOptions): Output<GetBackupInstanceResult>
Copy
def get_backup_instance(backup_instance_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        vault_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackupInstanceResult
def get_backup_instance_output(backup_instance_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[GetBackupInstanceResult]
Copy
func LookupBackupInstance(ctx *Context, args *LookupBackupInstanceArgs, opts ...InvokeOption) (*LookupBackupInstanceResult, error)
func LookupBackupInstanceOutput(ctx *Context, args *LookupBackupInstanceOutputArgs, opts ...InvokeOption) LookupBackupInstanceResultOutput
Copy

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

public static class GetBackupInstance 
{
    public static Task<GetBackupInstanceResult> InvokeAsync(GetBackupInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupInstanceResult> Invoke(GetBackupInstanceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBackupInstanceResult> getBackupInstance(GetBackupInstanceArgs args, InvokeOptions options)
public static Output<GetBackupInstanceResult> getBackupInstance(GetBackupInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dataprotection:getBackupInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackupInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup vault.
BackupInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup vault.
backupInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup vault.
backupInstanceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
string
The name of the backup vault.
backup_instance_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the backup instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
vault_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the backup vault.
backupInstanceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
vaultName
This property is required.
Changes to this property will trigger replacement.
String
The name of the backup vault.

getBackupInstance Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Proxy Resource Id represents the complete path to the resource.
Name string
Proxy Resource name associated with the resource.
Properties Pulumi.AzureNative.DataProtection.Outputs.BackupInstanceResponse
BackupInstanceResource properties
SystemData Pulumi.AzureNative.DataProtection.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
Tags Dictionary<string, string>
Proxy Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Proxy Resource Id represents the complete path to the resource.
Name string
Proxy Resource name associated with the resource.
Properties BackupInstanceResponse
BackupInstanceResource properties
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
Tags map[string]string
Proxy Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Proxy Resource Id represents the complete path to the resource.
name String
Proxy Resource name associated with the resource.
properties BackupInstanceResponse
BackupInstanceResource properties
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
tags Map<String,String>
Proxy Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Proxy Resource Id represents the complete path to the resource.
name string
Proxy Resource name associated with the resource.
properties BackupInstanceResponse
BackupInstanceResource properties
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
tags {[key: string]: string}
Proxy Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Proxy Resource Id represents the complete path to the resource.
name str
Proxy Resource name associated with the resource.
properties BackupInstanceResponse
BackupInstanceResource properties
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
tags Mapping[str, str]
Proxy Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Proxy Resource Id represents the complete path to the resource.
name String
Proxy Resource name associated with the resource.
properties Property Map
BackupInstanceResource properties
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
tags Map<String>
Proxy Resource tags.

Supporting Types

AzureOperationalStoreParametersResponse

DataStoreType This property is required. string
type of datastore; Operational/Vault/Archive
ResourceGroupId string
Gets or sets the Snapshot Resource Group Uri.
DataStoreType This property is required. string
type of datastore; Operational/Vault/Archive
ResourceGroupId string
Gets or sets the Snapshot Resource Group Uri.
dataStoreType This property is required. String
type of datastore; Operational/Vault/Archive
resourceGroupId String
Gets or sets the Snapshot Resource Group Uri.
dataStoreType This property is required. string
type of datastore; Operational/Vault/Archive
resourceGroupId string
Gets or sets the Snapshot Resource Group Uri.
data_store_type This property is required. str
type of datastore; Operational/Vault/Archive
resource_group_id str
Gets or sets the Snapshot Resource Group Uri.
dataStoreType This property is required. String
type of datastore; Operational/Vault/Archive
resourceGroupId String
Gets or sets the Snapshot Resource Group Uri.

BackupInstanceResponse

CurrentProtectionState This property is required. string
Specifies the current protection state of the resource
DataSourceInfo This property is required. Pulumi.AzureNative.DataProtection.Inputs.DatasourceResponse
Gets or sets the data source information.
ObjectType This property is required. string
PolicyInfo This property is required. Pulumi.AzureNative.DataProtection.Inputs.PolicyInfoResponse
Gets or sets the policy information.
ProtectionErrorDetails This property is required. Pulumi.AzureNative.DataProtection.Inputs.UserFacingErrorResponse
Specifies the protection error of the resource
ProtectionStatus This property is required. Pulumi.AzureNative.DataProtection.Inputs.ProtectionStatusDetailsResponse
Specifies the protection status of the resource
ProvisioningState This property is required. string
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
DataSourceSetInfo Pulumi.AzureNative.DataProtection.Inputs.DatasourceSetResponse
Gets or sets the data source set information.
DatasourceAuthCredentials Pulumi.AzureNative.DataProtection.Inputs.SecretStoreBasedAuthCredentialsResponse
Credentials to use to authenticate with data source provider.
FriendlyName string
Gets or sets the Backup Instance friendly name.
IdentityDetails Pulumi.AzureNative.DataProtection.Inputs.IdentityDetailsResponse
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
ResourceGuardOperationRequests List<string>
ResourceGuardOperationRequests on which LAC check will be performed
ValidationType string
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
CurrentProtectionState This property is required. string
Specifies the current protection state of the resource
DataSourceInfo This property is required. DatasourceResponse
Gets or sets the data source information.
ObjectType This property is required. string
PolicyInfo This property is required. PolicyInfoResponse
Gets or sets the policy information.
ProtectionErrorDetails This property is required. UserFacingErrorResponse
Specifies the protection error of the resource
ProtectionStatus This property is required. ProtectionStatusDetailsResponse
Specifies the protection status of the resource
ProvisioningState This property is required. string
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
DataSourceSetInfo DatasourceSetResponse
Gets or sets the data source set information.
DatasourceAuthCredentials SecretStoreBasedAuthCredentialsResponse
Credentials to use to authenticate with data source provider.
FriendlyName string
Gets or sets the Backup Instance friendly name.
IdentityDetails IdentityDetailsResponse
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
ResourceGuardOperationRequests []string
ResourceGuardOperationRequests on which LAC check will be performed
ValidationType string
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
currentProtectionState This property is required. String
Specifies the current protection state of the resource
dataSourceInfo This property is required. DatasourceResponse
Gets or sets the data source information.
objectType This property is required. String
policyInfo This property is required. PolicyInfoResponse
Gets or sets the policy information.
protectionErrorDetails This property is required. UserFacingErrorResponse
Specifies the protection error of the resource
protectionStatus This property is required. ProtectionStatusDetailsResponse
Specifies the protection status of the resource
provisioningState This property is required. String
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
dataSourceSetInfo DatasourceSetResponse
Gets or sets the data source set information.
datasourceAuthCredentials SecretStoreBasedAuthCredentialsResponse
Credentials to use to authenticate with data source provider.
friendlyName String
Gets or sets the Backup Instance friendly name.
identityDetails IdentityDetailsResponse
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests List<String>
ResourceGuardOperationRequests on which LAC check will be performed
validationType String
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
currentProtectionState This property is required. string
Specifies the current protection state of the resource
dataSourceInfo This property is required. DatasourceResponse
Gets or sets the data source information.
objectType This property is required. string
policyInfo This property is required. PolicyInfoResponse
Gets or sets the policy information.
protectionErrorDetails This property is required. UserFacingErrorResponse
Specifies the protection error of the resource
protectionStatus This property is required. ProtectionStatusDetailsResponse
Specifies the protection status of the resource
provisioningState This property is required. string
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
dataSourceSetInfo DatasourceSetResponse
Gets or sets the data source set information.
datasourceAuthCredentials SecretStoreBasedAuthCredentialsResponse
Credentials to use to authenticate with data source provider.
friendlyName string
Gets or sets the Backup Instance friendly name.
identityDetails IdentityDetailsResponse
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests string[]
ResourceGuardOperationRequests on which LAC check will be performed
validationType string
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
current_protection_state This property is required. str
Specifies the current protection state of the resource
data_source_info This property is required. DatasourceResponse
Gets or sets the data source information.
object_type This property is required. str
policy_info This property is required. PolicyInfoResponse
Gets or sets the policy information.
protection_error_details This property is required. UserFacingErrorResponse
Specifies the protection error of the resource
protection_status This property is required. ProtectionStatusDetailsResponse
Specifies the protection status of the resource
provisioning_state This property is required. str
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
data_source_set_info DatasourceSetResponse
Gets or sets the data source set information.
datasource_auth_credentials SecretStoreBasedAuthCredentialsResponse
Credentials to use to authenticate with data source provider.
friendly_name str
Gets or sets the Backup Instance friendly name.
identity_details IdentityDetailsResponse
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resource_guard_operation_requests Sequence[str]
ResourceGuardOperationRequests on which LAC check will be performed
validation_type str
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.
currentProtectionState This property is required. String
Specifies the current protection state of the resource
dataSourceInfo This property is required. Property Map
Gets or sets the data source information.
objectType This property is required. String
policyInfo This property is required. Property Map
Gets or sets the policy information.
protectionErrorDetails This property is required. Property Map
Specifies the protection error of the resource
protectionStatus This property is required. Property Map
Specifies the protection status of the resource
provisioningState This property is required. String
Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
dataSourceSetInfo Property Map
Gets or sets the data source set information.
datasourceAuthCredentials Property Map
Credentials to use to authenticate with data source provider.
friendlyName String
Gets or sets the Backup Instance friendly name.
identityDetails Property Map
Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
resourceGuardOperationRequests List<String>
ResourceGuardOperationRequests on which LAC check will be performed
validationType String
Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

BlobBackupDatasourceParametersResponse

ContainersList This property is required. List<string>
List of containers to be backed up during configuration of backup of blobs
ContainersList This property is required. []string
List of containers to be backed up during configuration of backup of blobs
containersList This property is required. List<String>
List of containers to be backed up during configuration of backup of blobs
containersList This property is required. string[]
List of containers to be backed up during configuration of backup of blobs
containers_list This property is required. Sequence[str]
List of containers to be backed up during configuration of backup of blobs
containersList This property is required. List<String>
List of containers to be backed up during configuration of backup of blobs

DatasourceResponse

ResourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
DatasourceType string
DatasourceType of the resource.
ObjectType string
Type of Datasource object, used to initialize the right inherited type
ResourceLocation string
Location of datasource.
ResourceName string
Unique identifier of the resource in the context of parent.
ResourceProperties Pulumi.AzureNative.DataProtection.Inputs.DefaultResourcePropertiesResponse
Properties specific to data source
ResourceType string
Resource Type of Datasource.
ResourceUri string
Uri of the resource.
ResourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
DatasourceType string
DatasourceType of the resource.
ObjectType string
Type of Datasource object, used to initialize the right inherited type
ResourceLocation string
Location of datasource.
ResourceName string
Unique identifier of the resource in the context of parent.
ResourceProperties DefaultResourcePropertiesResponse
Properties specific to data source
ResourceType string
Resource Type of Datasource.
ResourceUri string
Uri of the resource.
resourceID This property is required. String
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType String
DatasourceType of the resource.
objectType String
Type of Datasource object, used to initialize the right inherited type
resourceLocation String
Location of datasource.
resourceName String
Unique identifier of the resource in the context of parent.
resourceProperties DefaultResourcePropertiesResponse
Properties specific to data source
resourceType String
Resource Type of Datasource.
resourceUri String
Uri of the resource.
resourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType string
DatasourceType of the resource.
objectType string
Type of Datasource object, used to initialize the right inherited type
resourceLocation string
Location of datasource.
resourceName string
Unique identifier of the resource in the context of parent.
resourceProperties DefaultResourcePropertiesResponse
Properties specific to data source
resourceType string
Resource Type of Datasource.
resourceUri string
Uri of the resource.
resource_id This property is required. str
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasource_type str
DatasourceType of the resource.
object_type str
Type of Datasource object, used to initialize the right inherited type
resource_location str
Location of datasource.
resource_name str
Unique identifier of the resource in the context of parent.
resource_properties DefaultResourcePropertiesResponse
Properties specific to data source
resource_type str
Resource Type of Datasource.
resource_uri str
Uri of the resource.
resourceID This property is required. String
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType String
DatasourceType of the resource.
objectType String
Type of Datasource object, used to initialize the right inherited type
resourceLocation String
Location of datasource.
resourceName String
Unique identifier of the resource in the context of parent.
resourceProperties Property Map
Properties specific to data source
resourceType String
Resource Type of Datasource.
resourceUri String
Uri of the resource.

DatasourceSetResponse

ResourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
DatasourceType string
DatasourceType of the resource.
ObjectType string
Type of Datasource object, used to initialize the right inherited type
ResourceLocation string
Location of datasource.
ResourceName string
Unique identifier of the resource in the context of parent.
ResourceProperties Pulumi.AzureNative.DataProtection.Inputs.DefaultResourcePropertiesResponse
Properties specific to data source set
ResourceType string
Resource Type of Datasource.
ResourceUri string
Uri of the resource.
ResourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
DatasourceType string
DatasourceType of the resource.
ObjectType string
Type of Datasource object, used to initialize the right inherited type
ResourceLocation string
Location of datasource.
ResourceName string
Unique identifier of the resource in the context of parent.
ResourceProperties DefaultResourcePropertiesResponse
Properties specific to data source set
ResourceType string
Resource Type of Datasource.
ResourceUri string
Uri of the resource.
resourceID This property is required. String
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType String
DatasourceType of the resource.
objectType String
Type of Datasource object, used to initialize the right inherited type
resourceLocation String
Location of datasource.
resourceName String
Unique identifier of the resource in the context of parent.
resourceProperties DefaultResourcePropertiesResponse
Properties specific to data source set
resourceType String
Resource Type of Datasource.
resourceUri String
Uri of the resource.
resourceID This property is required. string
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType string
DatasourceType of the resource.
objectType string
Type of Datasource object, used to initialize the right inherited type
resourceLocation string
Location of datasource.
resourceName string
Unique identifier of the resource in the context of parent.
resourceProperties DefaultResourcePropertiesResponse
Properties specific to data source set
resourceType string
Resource Type of Datasource.
resourceUri string
Uri of the resource.
resource_id This property is required. str
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasource_type str
DatasourceType of the resource.
object_type str
Type of Datasource object, used to initialize the right inherited type
resource_location str
Location of datasource.
resource_name str
Unique identifier of the resource in the context of parent.
resource_properties DefaultResourcePropertiesResponse
Properties specific to data source set
resource_type str
Resource Type of Datasource.
resource_uri str
Uri of the resource.
resourceID This property is required. String
Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.
datasourceType String
DatasourceType of the resource.
objectType String
Type of Datasource object, used to initialize the right inherited type
resourceLocation String
Location of datasource.
resourceName String
Unique identifier of the resource in the context of parent.
resourceProperties Property Map
Properties specific to data source set
resourceType String
Resource Type of Datasource.
resourceUri String
Uri of the resource.

DefaultResourcePropertiesResponse

IdentityDetailsResponse

UseSystemAssignedIdentity bool
Specifies if the BI is protected by System Identity.
UserAssignedIdentityArmUrl string
ARM URL for User Assigned Identity.
UseSystemAssignedIdentity bool
Specifies if the BI is protected by System Identity.
UserAssignedIdentityArmUrl string
ARM URL for User Assigned Identity.
useSystemAssignedIdentity Boolean
Specifies if the BI is protected by System Identity.
userAssignedIdentityArmUrl String
ARM URL for User Assigned Identity.
useSystemAssignedIdentity boolean
Specifies if the BI is protected by System Identity.
userAssignedIdentityArmUrl string
ARM URL for User Assigned Identity.
use_system_assigned_identity bool
Specifies if the BI is protected by System Identity.
user_assigned_identity_arm_url str
ARM URL for User Assigned Identity.
useSystemAssignedIdentity Boolean
Specifies if the BI is protected by System Identity.
userAssignedIdentityArmUrl String
ARM URL for User Assigned Identity.

InnerErrorResponse

AdditionalInfo Dictionary<string, string>
Any Key value pairs that can be provided to the client for additional verbose information.
Code string
Unique code for this error
EmbeddedInnerError Pulumi.AzureNative.DataProtection.Inputs.InnerErrorResponse
Child Inner Error, to allow Nesting.
AdditionalInfo map[string]string
Any Key value pairs that can be provided to the client for additional verbose information.
Code string
Unique code for this error
EmbeddedInnerError InnerErrorResponse
Child Inner Error, to allow Nesting.
additionalInfo Map<String,String>
Any Key value pairs that can be provided to the client for additional verbose information.
code String
Unique code for this error
embeddedInnerError InnerErrorResponse
Child Inner Error, to allow Nesting.
additionalInfo {[key: string]: string}
Any Key value pairs that can be provided to the client for additional verbose information.
code string
Unique code for this error
embeddedInnerError InnerErrorResponse
Child Inner Error, to allow Nesting.
additional_info Mapping[str, str]
Any Key value pairs that can be provided to the client for additional verbose information.
code str
Unique code for this error
embedded_inner_error InnerErrorResponse
Child Inner Error, to allow Nesting.
additionalInfo Map<String>
Any Key value pairs that can be provided to the client for additional verbose information.
code String
Unique code for this error
embeddedInnerError Property Map
Child Inner Error, to allow Nesting.

KubernetesClusterBackupDatasourceParametersResponse

IncludeClusterScopeResources This property is required. bool
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
SnapshotVolumes This property is required. bool
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
BackupHookReferences List<Pulumi.AzureNative.DataProtection.Inputs.NamespacedNameResourceResponse>
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
ExcludedNamespaces List<string>
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
ExcludedResourceTypes List<string>
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
IncludedNamespaces List<string>
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
IncludedResourceTypes List<string>
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
IncludedVolumeTypes List<string>
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
LabelSelectors List<string>
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
IncludeClusterScopeResources This property is required. bool
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
SnapshotVolumes This property is required. bool
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
BackupHookReferences []NamespacedNameResourceResponse
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
ExcludedNamespaces []string
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
ExcludedResourceTypes []string
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
IncludedNamespaces []string
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
IncludedResourceTypes []string
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
IncludedVolumeTypes []string
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
LabelSelectors []string
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
includeClusterScopeResources This property is required. Boolean
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
snapshotVolumes This property is required. Boolean
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
backupHookReferences List<NamespacedNameResourceResponse>
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
excludedNamespaces List<String>
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
excludedResourceTypes List<String>
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
includedNamespaces List<String>
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
includedResourceTypes List<String>
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
includedVolumeTypes List<String>
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
labelSelectors List<String>
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
includeClusterScopeResources This property is required. boolean
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
snapshotVolumes This property is required. boolean
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
backupHookReferences NamespacedNameResourceResponse[]
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
excludedNamespaces string[]
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
excludedResourceTypes string[]
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
includedNamespaces string[]
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
includedResourceTypes string[]
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
includedVolumeTypes string[]
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
labelSelectors string[]
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
include_cluster_scope_resources This property is required. bool
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
snapshot_volumes This property is required. bool
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
backup_hook_references Sequence[NamespacedNameResourceResponse]
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
excluded_namespaces Sequence[str]
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
excluded_resource_types Sequence[str]
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
included_namespaces Sequence[str]
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
included_resource_types Sequence[str]
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
included_volume_types Sequence[str]
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
label_selectors Sequence[str]
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.
includeClusterScopeResources This property is required. Boolean
Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.
snapshotVolumes This property is required. Boolean
Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.
backupHookReferences List<Property Map>
Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.
excludedNamespaces List<String>
Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.
excludedResourceTypes List<String>
Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.
includedNamespaces List<String>
Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.
includedResourceTypes List<String>
Gets or sets the include resource types property. This property sets the resource types to be included during backup.
includedVolumeTypes List<String>
Gets or sets the include volume types property. This property sets the volume types to be included during backup.
labelSelectors List<String>
Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.

NamespacedNameResourceResponse

Name string
Name of the resource
Namespace string
Namespace in which the resource exists
Name string
Name of the resource
Namespace string
Namespace in which the resource exists
name String
Name of the resource
namespace String
Namespace in which the resource exists
name string
Name of the resource
namespace string
Namespace in which the resource exists
name str
Name of the resource
namespace str
Namespace in which the resource exists
name String
Name of the resource
namespace String
Namespace in which the resource exists

PolicyInfoResponse

PolicyId This property is required. string
PolicyVersion This property is required. string
PolicyParameters Pulumi.AzureNative.DataProtection.Inputs.PolicyParametersResponse
Policy parameters for the backup instance
PolicyId This property is required. string
PolicyVersion This property is required. string
PolicyParameters PolicyParametersResponse
Policy parameters for the backup instance
policyId This property is required. String
policyVersion This property is required. String
policyParameters PolicyParametersResponse
Policy parameters for the backup instance
policyId This property is required. string
policyVersion This property is required. string
policyParameters PolicyParametersResponse
Policy parameters for the backup instance
policy_id This property is required. str
policy_version This property is required. str
policy_parameters PolicyParametersResponse
Policy parameters for the backup instance
policyId This property is required. String
policyVersion This property is required. String
policyParameters Property Map
Policy parameters for the backup instance

PolicyParametersResponse

BackupDatasourceParametersList List<Union<Pulumi.AzureNative.DataProtection.Inputs.BlobBackupDatasourceParametersResponse, Pulumi.AzureNative.DataProtection.Inputs.KubernetesClusterBackupDatasourceParametersResponse>>
Gets or sets the Backup Data Source Parameters
DataStoreParametersList List<Pulumi.AzureNative.DataProtection.Inputs.AzureOperationalStoreParametersResponse>
Gets or sets the DataStore Parameters
BackupDatasourceParametersList []interface{}
Gets or sets the Backup Data Source Parameters
DataStoreParametersList []AzureOperationalStoreParametersResponse
Gets or sets the DataStore Parameters
backupDatasourceParametersList List<Either<BlobBackupDatasourceParametersResponse,KubernetesClusterBackupDatasourceParametersResponse>>
Gets or sets the Backup Data Source Parameters
dataStoreParametersList List<AzureOperationalStoreParametersResponse>
Gets or sets the DataStore Parameters
backupDatasourceParametersList (BlobBackupDatasourceParametersResponse | KubernetesClusterBackupDatasourceParametersResponse)[]
Gets or sets the Backup Data Source Parameters
dataStoreParametersList AzureOperationalStoreParametersResponse[]
Gets or sets the DataStore Parameters
backup_datasource_parameters_list Sequence[Union[BlobBackupDatasourceParametersResponse, KubernetesClusterBackupDatasourceParametersResponse]]
Gets or sets the Backup Data Source Parameters
data_store_parameters_list Sequence[AzureOperationalStoreParametersResponse]
Gets or sets the DataStore Parameters
backupDatasourceParametersList List<Property Map | Property Map>
Gets or sets the Backup Data Source Parameters
dataStoreParametersList List<Property Map>
Gets or sets the DataStore Parameters

ProtectionStatusDetailsResponse

ErrorDetails Pulumi.AzureNative.DataProtection.Inputs.UserFacingErrorResponse
Specifies the protection status error of the resource
Status string
Specifies the protection status of the resource
ErrorDetails UserFacingErrorResponse
Specifies the protection status error of the resource
Status string
Specifies the protection status of the resource
errorDetails UserFacingErrorResponse
Specifies the protection status error of the resource
status String
Specifies the protection status of the resource
errorDetails UserFacingErrorResponse
Specifies the protection status error of the resource
status string
Specifies the protection status of the resource
error_details UserFacingErrorResponse
Specifies the protection status error of the resource
status str
Specifies the protection status of the resource
errorDetails Property Map
Specifies the protection status error of the resource
status String
Specifies the protection status of the resource

SecretStoreBasedAuthCredentialsResponse

secretStoreResource Property Map
Secret store resource

SecretStoreResourceResponse

SecretStoreType This property is required. string
Gets or sets the type of secret store
Uri string
Uri to get to the resource
Value string
Gets or sets value stored in secret store resource
SecretStoreType This property is required. string
Gets or sets the type of secret store
Uri string
Uri to get to the resource
Value string
Gets or sets value stored in secret store resource
secretStoreType This property is required. String
Gets or sets the type of secret store
uri String
Uri to get to the resource
value String
Gets or sets value stored in secret store resource
secretStoreType This property is required. string
Gets or sets the type of secret store
uri string
Uri to get to the resource
value string
Gets or sets value stored in secret store resource
secret_store_type This property is required. str
Gets or sets the type of secret store
uri str
Uri to get to the resource
value str
Gets or sets value stored in secret store resource
secretStoreType This property is required. String
Gets or sets the type of secret store
uri String
Uri to get to the resource
value String
Gets or sets value stored in secret store resource

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserFacingErrorResponse

Code string
Unique code for this error
Details List<Pulumi.AzureNative.DataProtection.Inputs.UserFacingErrorResponse>
Additional related Errors
InnerError Pulumi.AzureNative.DataProtection.Inputs.InnerErrorResponse
Inner Error
IsRetryable bool
Whether the operation will be retryable or not
IsUserError bool
Whether the operation is due to a user error or service error
Message string
Properties Dictionary<string, string>
Any key value pairs that can be injected inside error object
RecommendedAction List<string>
RecommendedAction � localized.
Target string
Target of the error.
Code string
Unique code for this error
Details []UserFacingErrorResponse
Additional related Errors
InnerError InnerErrorResponse
Inner Error
IsRetryable bool
Whether the operation will be retryable or not
IsUserError bool
Whether the operation is due to a user error or service error
Message string
Properties map[string]string
Any key value pairs that can be injected inside error object
RecommendedAction []string
RecommendedAction � localized.
Target string
Target of the error.
code String
Unique code for this error
details List<UserFacingErrorResponse>
Additional related Errors
innerError InnerErrorResponse
Inner Error
isRetryable Boolean
Whether the operation will be retryable or not
isUserError Boolean
Whether the operation is due to a user error or service error
message String
properties Map<String,String>
Any key value pairs that can be injected inside error object
recommendedAction List<String>
RecommendedAction � localized.
target String
Target of the error.
code string
Unique code for this error
details UserFacingErrorResponse[]
Additional related Errors
innerError InnerErrorResponse
Inner Error
isRetryable boolean
Whether the operation will be retryable or not
isUserError boolean
Whether the operation is due to a user error or service error
message string
properties {[key: string]: string}
Any key value pairs that can be injected inside error object
recommendedAction string[]
RecommendedAction � localized.
target string
Target of the error.
code str
Unique code for this error
details Sequence[UserFacingErrorResponse]
Additional related Errors
inner_error InnerErrorResponse
Inner Error
is_retryable bool
Whether the operation will be retryable or not
is_user_error bool
Whether the operation is due to a user error or service error
message str
properties Mapping[str, str]
Any key value pairs that can be injected inside error object
recommended_action Sequence[str]
RecommendedAction � localized.
target str
Target of the error.
code String
Unique code for this error
details List<Property Map>
Additional related Errors
innerError Property Map
Inner Error
isRetryable Boolean
Whether the operation will be retryable or not
isUserError Boolean
Whether the operation is due to a user error or service error
message String
properties Map<String>
Any key value pairs that can be injected inside error object
recommendedAction List<String>
RecommendedAction � localized.
target String
Target of the error.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native