These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.dataprotection.getBackupInstance
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
Gets a backup instance with name in a backup vault 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:
- Backup
Instance stringName - The name of the backup instance
- Resource
Group stringName - The name of the resource group where the backup vault is present.
- Vault
Name string - The name of the backup vault.
- Backup
Instance stringName - The name of the backup instance
- Resource
Group stringName - The name of the resource group where the backup vault is present.
- Vault
Name string - The name of the backup vault.
- backup
Instance StringName - The name of the backup instance
- resource
Group StringName - The name of the resource group where the backup vault is present.
- vault
Name String - The name of the backup vault.
- backup
Instance stringName - The name of the backup instance
- resource
Group stringName - The name of the resource group where the backup vault is present.
- vault
Name string - The name of the backup vault.
- backup_
instance_ strname - The name of the backup instance
- resource_
group_ strname - The name of the resource group where the backup vault is present.
- vault_
name str - The name of the backup vault.
- backup
Instance StringName - The name of the backup instance
- resource
Group StringName - The name of the resource group where the backup vault is present.
- vault
Name 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.
Azure Native. Data Protection. Outputs. Backup Instance Response - BackupInstanceResource properties
- System
Data Pulumi.Azure Native. Data Protection. Outputs. System Data Response - 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
Backup
Instance Response - BackupInstanceResource properties
- System
Data SystemData Response - 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
Backup
Instance Response - BackupInstanceResource properties
- system
Data SystemData Response - 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
Backup
Instance Response - BackupInstanceResource properties
- system
Data SystemData Response - 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
Backup
Instance Response - BackupInstanceResource properties
- system_
data SystemData Response - 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
- system
Data 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
- Data
Store stringType - type of datastore; Operational/Vault/Archive
- Resource
Group stringId - Gets or sets the Snapshot Resource Group Uri.
- Data
Store stringType - type of datastore; Operational/Vault/Archive
- Resource
Group stringId - Gets or sets the Snapshot Resource Group Uri.
- data
Store StringType - type of datastore; Operational/Vault/Archive
- resource
Group StringId - Gets or sets the Snapshot Resource Group Uri.
- data
Store stringType - type of datastore; Operational/Vault/Archive
- resource
Group stringId - Gets or sets the Snapshot Resource Group Uri.
- data_
store_ strtype - type of datastore; Operational/Vault/Archive
- resource_
group_ strid - Gets or sets the Snapshot Resource Group Uri.
- data
Store StringType - type of datastore; Operational/Vault/Archive
- resource
Group StringId - Gets or sets the Snapshot Resource Group Uri.
BackupInstanceResponse
- Current
Protection stringState - Specifies the current protection state of the resource
- Data
Source Pulumi.Info Azure Native. Data Protection. Inputs. Datasource Response - Gets or sets the data source information.
- Object
Type string - Policy
Info Pulumi.Azure Native. Data Protection. Inputs. Policy Info Response - Gets or sets the policy information.
- Protection
Error Pulumi.Details Azure Native. Data Protection. Inputs. User Facing Error Response - Specifies the protection error of the resource
- Protection
Status Pulumi.Azure Native. Data Protection. Inputs. Protection Status Details Response - Specifies the protection status of the resource
- Provisioning
State string - Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
- Data
Source Pulumi.Set Info Azure Native. Data Protection. Inputs. Datasource Set Response - Gets or sets the data source set information.
- Friendly
Name string - Gets or sets the Backup Instance friendly name.
- Current
Protection stringState - Specifies the current protection state of the resource
- Data
Source DatasourceInfo Response - Gets or sets the data source information.
- Object
Type string - Policy
Info PolicyInfo Response - Gets or sets the policy information.
- Protection
Error UserDetails Facing Error Response - Specifies the protection error of the resource
- Protection
Status ProtectionStatus Details Response - Specifies the protection status of the resource
- Provisioning
State string - Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
- Data
Source DatasourceSet Info Set Response - Gets or sets the data source set information.
- Friendly
Name string - Gets or sets the Backup Instance friendly name.
- current
Protection StringState - Specifies the current protection state of the resource
- data
Source DatasourceInfo Response - Gets or sets the data source information.
- object
Type String - policy
Info PolicyInfo Response - Gets or sets the policy information.
- protection
Error UserDetails Facing Error Response - Specifies the protection error of the resource
- protection
Status ProtectionStatus Details Response - Specifies the protection status of the resource
- provisioning
State String - Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
- data
Source DatasourceSet Info Set Response - Gets or sets the data source set information.
- friendly
Name String - Gets or sets the Backup Instance friendly name.
- current
Protection stringState - Specifies the current protection state of the resource
- data
Source DatasourceInfo Response - Gets or sets the data source information.
- object
Type string - policy
Info PolicyInfo Response - Gets or sets the policy information.
- protection
Error UserDetails Facing Error Response - Specifies the protection error of the resource
- protection
Status ProtectionStatus Details Response - Specifies the protection status of the resource
- provisioning
State string - Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
- data
Source DatasourceSet Info Set Response - Gets or sets the data source set information.
- friendly
Name string - Gets or sets the Backup Instance friendly name.
- current_
protection_ strstate - Specifies the current protection state of the resource
- data_
source_ Datasourceinfo Response - Gets or sets the data source information.
- object_
type str - policy_
info PolicyInfo Response - Gets or sets the policy information.
- protection_
error_ Userdetails Facing Error Response - Specifies the protection error of the resource
- protection_
status ProtectionStatus Details Response - 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_ Datasourceset_ info Set Response - Gets or sets the data source set information.
- friendly_
name str - Gets or sets the Backup Instance friendly name.
- current
Protection StringState - Specifies the current protection state of the resource
- data
Source Property MapInfo - Gets or sets the data source information.
- object
Type String - policy
Info Property Map - Gets or sets the policy information.
- protection
Error Property MapDetails - Specifies the protection error of the resource
- protection
Status Property Map - Specifies the protection status of the resource
- provisioning
State String - Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed
- data
Source Property MapSet Info - Gets or sets the data source set information.
- friendly
Name String - Gets or sets the Backup Instance friendly name.
DatasourceResponse
- Resource
ID 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.
- Datasource
Type string - DatasourceType of the resource.
- Object
Type string - Type of Datasource object, used to initialize the right inherited type
- Resource
Location string - Location of datasource.
- Resource
Name string - Unique identifier of the resource in the context of parent.
- Resource
Type string - Resource Type of Datasource.
- Resource
Uri string - Uri of the resource.
- Resource
ID 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.
- Datasource
Type string - DatasourceType of the resource.
- Object
Type string - Type of Datasource object, used to initialize the right inherited type
- Resource
Location string - Location of datasource.
- Resource
Name string - Unique identifier of the resource in the context of parent.
- Resource
Type string - Resource Type of Datasource.
- Resource
Uri string - Uri of the resource.
- resource
ID 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.
- datasource
Type String - DatasourceType of the resource.
- object
Type String - Type of Datasource object, used to initialize the right inherited type
- resource
Location String - Location of datasource.
- resource
Name String - Unique identifier of the resource in the context of parent.
- resource
Type String - Resource Type of Datasource.
- resource
Uri String - Uri of the resource.
- resource
ID 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.
- datasource
Type string - DatasourceType of the resource.
- object
Type string - Type of Datasource object, used to initialize the right inherited type
- resource
Location string - Location of datasource.
- resource
Name string - Unique identifier of the resource in the context of parent.
- resource
Type string - Resource Type of Datasource.
- resource
Uri 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.
- resource
ID 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.
- datasource
Type String - DatasourceType of the resource.
- object
Type String - Type of Datasource object, used to initialize the right inherited type
- resource
Location String - Location of datasource.
- resource
Name String - Unique identifier of the resource in the context of parent.
- resource
Type String - Resource Type of Datasource.
- resource
Uri String - Uri of the resource.
DatasourceSetResponse
- Resource
ID 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.
- Datasource
Type string - DatasourceType of the resource.
- Object
Type string - Type of Datasource object, used to initialize the right inherited type
- Resource
Location string - Location of datasource.
- Resource
Name string - Unique identifier of the resource in the context of parent.
- Resource
Type string - Resource Type of Datasource.
- Resource
Uri string - Uri of the resource.
- Resource
ID 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.
- Datasource
Type string - DatasourceType of the resource.
- Object
Type string - Type of Datasource object, used to initialize the right inherited type
- Resource
Location string - Location of datasource.
- Resource
Name string - Unique identifier of the resource in the context of parent.
- Resource
Type string - Resource Type of Datasource.
- Resource
Uri string - Uri of the resource.
- resource
ID 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.
- datasource
Type String - DatasourceType of the resource.
- object
Type String - Type of Datasource object, used to initialize the right inherited type
- resource
Location String - Location of datasource.
- resource
Name String - Unique identifier of the resource in the context of parent.
- resource
Type String - Resource Type of Datasource.
- resource
Uri String - Uri of the resource.
- resource
ID 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.
- datasource
Type string - DatasourceType of the resource.
- object
Type string - Type of Datasource object, used to initialize the right inherited type
- resource
Location string - Location of datasource.
- resource
Name string - Unique identifier of the resource in the context of parent.
- resource
Type string - Resource Type of Datasource.
- resource
Uri 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.
- resource
ID 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.
- datasource
Type String - DatasourceType of the resource.
- object
Type String - Type of Datasource object, used to initialize the right inherited type
- resource
Location String - Location of datasource.
- resource
Name String - Unique identifier of the resource in the context of parent.
- resource
Type String - Resource Type of Datasource.
- resource
Uri String - Uri of the resource.
InnerErrorResponse
- Additional
Info 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
- Embedded
Inner Pulumi.Error Azure Native. Data Protection. Inputs. Inner Error Response - Child Inner Error, to allow Nesting.
- Additional
Info 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
- Embedded
Inner InnerError Error Response - Child Inner Error, to allow Nesting.
- additional
Info 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
- embedded
Inner InnerError Error Response - Child Inner Error, to allow Nesting.
- additional
Info {[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
- embedded
Inner InnerError Error Response - 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_ Innererror Error Response - Child Inner Error, to allow Nesting.
- additional
Info Map<String> - Any Key value pairs that can be provided to the client for additional verbose information.
- code String
- Unique code for this error
- embedded
Inner Property MapError - Child Inner Error, to allow Nesting.
PolicyInfoResponse
- Policy
Id string - Policy
Version string - Policy
Parameters Pulumi.Azure Native. Data Protection. Inputs. Policy Parameters Response - Policy parameters for the backup instance
- Policy
Id string - Policy
Version string - Policy
Parameters PolicyParameters Response - Policy parameters for the backup instance
- policy
Id String - policy
Version String - policy
Parameters PolicyParameters Response - Policy parameters for the backup instance
- policy
Id string - policy
Version string - policy
Parameters PolicyParameters Response - Policy parameters for the backup instance
- policy_
id str - policy_
version str - policy_
parameters PolicyParameters Response - Policy parameters for the backup instance
- policy
Id String - policy
Version String - policy
Parameters Property Map - Policy parameters for the backup instance
PolicyParametersResponse
- Data
Store List<Pulumi.Parameters List Azure Native. Data Protection. Inputs. Azure Operational Store Parameters Response> - Gets or sets the DataStore Parameters
- Data
Store []AzureParameters List Operational Store Parameters Response - Gets or sets the DataStore Parameters
- data
Store List<AzureParameters List Operational Store Parameters Response> - Gets or sets the DataStore Parameters
- data
Store AzureParameters List Operational Store Parameters Response[] - Gets or sets the DataStore Parameters
- data_
store_ Sequence[Azureparameters_ list Operational Store Parameters Response] - Gets or sets the DataStore Parameters
- data
Store List<Property Map>Parameters List - Gets or sets the DataStore Parameters
ProtectionStatusDetailsResponse
- Error
Details Pulumi.Azure Native. Data Protection. Inputs. User Facing Error Response - Specifies the protection status error of the resource
- Status string
- Specifies the protection status of the resource
- Error
Details UserFacing Error Response - Specifies the protection status error of the resource
- Status string
- Specifies the protection status of the resource
- error
Details UserFacing Error Response - Specifies the protection status error of the resource
- status String
- Specifies the protection status of the resource
- error
Details UserFacing Error Response - Specifies the protection status error of the resource
- status string
- Specifies the protection status of the resource
- error_
details UserFacing Error Response - Specifies the protection status error of the resource
- status str
- Specifies the protection status of the resource
- error
Details Property Map - Specifies the protection status error of the resource
- status String
- Specifies the protection status of the resource
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserFacingErrorResponse
- Code string
- Unique code for this error
- Details
List<Pulumi.
Azure Native. Data Protection. Inputs. User Facing Error Response> - Additional related Errors
- Inner
Error Pulumi.Azure Native. Data Protection. Inputs. Inner Error Response - Inner Error
- Is
Retryable bool - Whether the operation will be retryable or not
- Is
User boolError - 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
- Recommended
Action List<string> - RecommendedAction � localized.
- Target string
- Target of the error.
- Code string
- Unique code for this error
- Details
[]User
Facing Error Response - Additional related Errors
- Inner
Error InnerError Response - Inner Error
- Is
Retryable bool - Whether the operation will be retryable or not
- Is
User boolError - 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
- Recommended
Action []string - RecommendedAction � localized.
- Target string
- Target of the error.
- code String
- Unique code for this error
- details
List<User
Facing Error Response> - Additional related Errors
- inner
Error InnerError Response - Inner Error
- is
Retryable Boolean - Whether the operation will be retryable or not
- is
User BooleanError - 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
- recommended
Action List<String> - RecommendedAction � localized.
- target String
- Target of the error.
- code string
- Unique code for this error
- details
User
Facing Error Response[] - Additional related Errors
- inner
Error InnerError Response - Inner Error
- is
Retryable boolean - Whether the operation will be retryable or not
- is
User booleanError - 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
- recommended
Action string[] - RecommendedAction � localized.
- target string
- Target of the error.
- code str
- Unique code for this error
- details
Sequence[User
Facing Error Response] - Additional related Errors
- inner_
error InnerError Response - Inner Error
- is_
retryable bool - Whether the operation will be retryable or not
- is_
user_ boolerror - 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
- inner
Error Property Map - Inner Error
- is
Retryable Boolean - Whether the operation will be retryable or not
- is
User BooleanError - 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
- recommended
Action List<String> - RecommendedAction � localized.
- target String
- Target of the error.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi