Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getBackupInstance

BackupInstance Resource API Version: 2021-01-01.

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>
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]
func LookupBackupInstance(ctx *Context, args *LookupBackupInstanceArgs, opts ...InvokeOption) (*LookupBackupInstanceResult, error)
func LookupBackupInstanceOutput(ctx *Context, args *LookupBackupInstanceOutputArgs, opts ...InvokeOption) LookupBackupInstanceResultOutput

> 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)
}
public static CompletableFuture<GetBackupInstanceResult> getBackupInstance(GetBackupInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:dataprotection:getBackupInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

BackupInstanceName string

The name of the backup instance

ResourceGroupName string

The name of the resource group where the backup vault is present.

VaultName string

The name of the backup vault.

BackupInstanceName string

The name of the backup instance

ResourceGroupName string

The name of the resource group where the backup vault is present.

VaultName string

The name of the backup vault.

backupInstanceName String

The name of the backup instance

resourceGroupName String

The name of the resource group where the backup vault is present.

vaultName String

The name of the backup vault.

backupInstanceName string

The name of the backup instance

resourceGroupName string

The name of the resource group where the backup vault is present.

vaultName string

The name of the backup vault.

backup_instance_name str

The name of the backup instance

resource_group_name str

The name of the resource group where the backup vault is present.

vault_name str

The name of the backup vault.

backupInstanceName String

The name of the backup instance

resourceGroupName String

The name of the resource group where the backup vault is present.

vaultName String

The name of the backup vault.

getBackupInstance Result

The following output properties are available:

Id string

Resource Id represents the complete path to the resource.

Name string

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

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Id string

Resource Id represents the complete path to the resource.

Name string

Resource name associated with the resource.

Properties BackupInstanceResponse

BackupInstanceResource properties

SystemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

Type string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

id String

Resource Id represents the complete path to the resource.

name String

Resource name associated with the resource.

properties BackupInstanceResponse

BackupInstanceResource properties

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type String

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

id string

Resource Id represents the complete path to the resource.

name string

Resource name associated with the resource.

properties BackupInstanceResponse

BackupInstanceResource properties

systemData SystemDataResponse

Metadata pertaining to creation and last modification of the resource.

type string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

id str

Resource Id represents the complete path to the resource.

name str

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

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

id String

Resource Id represents the complete path to the resource.

name String

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

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Supporting Types

AzureOperationalStoreParametersResponse

DataStoreType string

type of datastore; Operational/Vault/Archive

ResourceGroupId string

Gets or sets the Snapshot Resource Group Uri.

DataStoreType string

type of datastore; Operational/Vault/Archive

ResourceGroupId string

Gets or sets the Snapshot Resource Group Uri.

dataStoreType String

type of datastore; Operational/Vault/Archive

resourceGroupId String

Gets or sets the Snapshot Resource Group Uri.

dataStoreType string

type of datastore; Operational/Vault/Archive

resourceGroupId string

Gets or sets the Snapshot Resource Group Uri.

data_store_type str

type of datastore; Operational/Vault/Archive

resource_group_id str

Gets or sets the Snapshot Resource Group Uri.

dataStoreType String

type of datastore; Operational/Vault/Archive

resourceGroupId String

Gets or sets the Snapshot Resource Group Uri.

BackupInstanceResponse

CurrentProtectionState string

Specifies the current protection state of the resource

DataSourceInfo Pulumi.AzureNative.DataProtection.Inputs.DatasourceResponse

Gets or sets the data source information.

ObjectType string
PolicyInfo Pulumi.AzureNative.DataProtection.Inputs.PolicyInfoResponse

Gets or sets the policy information.

ProtectionErrorDetails Pulumi.AzureNative.DataProtection.Inputs.UserFacingErrorResponse

Specifies the protection error of the resource

ProtectionStatus Pulumi.AzureNative.DataProtection.Inputs.ProtectionStatusDetailsResponse

Specifies the protection status of the resource

ProvisioningState 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.

FriendlyName string

Gets or sets the Backup Instance friendly name.

CurrentProtectionState string

Specifies the current protection state of the resource

DataSourceInfo DatasourceResponse

Gets or sets the data source information.

ObjectType string
PolicyInfo PolicyInfoResponse

Gets or sets the policy information.

ProtectionErrorDetails UserFacingErrorResponse

Specifies the protection error of the resource

ProtectionStatus ProtectionStatusDetailsResponse

Specifies the protection status of the resource

ProvisioningState string

Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed

DataSourceSetInfo DatasourceSetResponse

Gets or sets the data source set information.

FriendlyName string

Gets or sets the Backup Instance friendly name.

currentProtectionState String

Specifies the current protection state of the resource

dataSourceInfo DatasourceResponse

Gets or sets the data source information.

objectType String
policyInfo PolicyInfoResponse

Gets or sets the policy information.

protectionErrorDetails UserFacingErrorResponse

Specifies the protection error of the resource

protectionStatus ProtectionStatusDetailsResponse

Specifies the protection status of the resource

provisioningState String

Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed

dataSourceSetInfo DatasourceSetResponse

Gets or sets the data source set information.

friendlyName String

Gets or sets the Backup Instance friendly name.

currentProtectionState string

Specifies the current protection state of the resource

dataSourceInfo DatasourceResponse

Gets or sets the data source information.

objectType string
policyInfo PolicyInfoResponse

Gets or sets the policy information.

protectionErrorDetails UserFacingErrorResponse

Specifies the protection error of the resource

protectionStatus ProtectionStatusDetailsResponse

Specifies the protection status of the resource

provisioningState string

Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed

dataSourceSetInfo DatasourceSetResponse

Gets or sets the data source set information.

friendlyName string

Gets or sets the Backup Instance friendly name.

current_protection_state str

Specifies the current protection state of the resource

data_source_info DatasourceResponse

Gets or sets the data source information.

object_type str
policy_info PolicyInfoResponse

Gets or sets the policy information.

protection_error_details UserFacingErrorResponse

Specifies the protection error of the resource

protection_status ProtectionStatusDetailsResponse

Specifies the protection status of the resource

provisioning_state 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.

friendly_name str

Gets or sets the Backup Instance friendly name.

currentProtectionState String

Specifies the current protection state of the resource

dataSourceInfo Property Map

Gets or sets the data source information.

objectType String
policyInfo Property Map

Gets or sets the policy information.

protectionErrorDetails Property Map

Specifies the protection error of the resource

protectionStatus Property Map

Specifies the protection status of the resource

provisioningState 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.

friendlyName String

Gets or sets the Backup Instance friendly name.

DatasourceResponse

ResourceID 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.

ResourceType string

Resource Type of Datasource.

ResourceUri string

Uri of the resource.

ResourceID 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.

ResourceType string

Resource Type of Datasource.

ResourceUri string

Uri of the resource.

resourceID 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.

resourceType String

Resource Type of Datasource.

resourceUri String

Uri of the resource.

resourceID 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.

resourceType string

Resource Type of Datasource.

resourceUri string

Uri of the resource.

resource_id 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_type str

Resource Type of Datasource.

resource_uri str

Uri of the resource.

resourceID 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.

resourceType String

Resource Type of Datasource.

resourceUri String

Uri of the resource.

DatasourceSetResponse

ResourceID 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.

ResourceType string

Resource Type of Datasource.

ResourceUri string

Uri of the resource.

ResourceID 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.

ResourceType string

Resource Type of Datasource.

ResourceUri string

Uri of the resource.

resourceID 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.

resourceType String

Resource Type of Datasource.

resourceUri String

Uri of the resource.

resourceID 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.

resourceType string

Resource Type of Datasource.

resourceUri string

Uri of the resource.

resource_id 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_type str

Resource Type of Datasource.

resource_uri str

Uri of the resource.

resourceID 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.

resourceType String

Resource Type of Datasource.

resourceUri String

Uri of the resource.

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.

PolicyInfoResponse

PolicyId string
PolicyVersion string
PolicyParameters PolicyParametersResponse

Policy parameters for the backup instance

policyId String
policyVersion String
policyParameters PolicyParametersResponse

Policy parameters for the backup instance

policyId string
policyVersion string
policyParameters PolicyParametersResponse

Policy parameters for the backup instance

policy_id str
policy_version str
policy_parameters PolicyParametersResponse

Policy parameters for the backup instance

policyId String
policyVersion String
policyParameters Property Map

Policy parameters for the backup instance

PolicyParametersResponse

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

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0