Azure Native v1.103.0, Jun 2 23
Azure Native v1.103.0, Jun 2 23
azure-native.dataprotection.getBackupPolicy
Explore with Pulumi AI
Gets a backup policy belonging to a backup vault API Version: 2021-01-01.
Using getBackupPolicy
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 getBackupPolicy(args: GetBackupPolicyArgs, opts?: InvokeOptions): Promise<GetBackupPolicyResult>
function getBackupPolicyOutput(args: GetBackupPolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupPolicyResult>
def get_backup_policy(backup_policy_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
vault_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackupPolicyResult
def get_backup_policy_output(backup_policy_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[GetBackupPolicyResult]
func LookupBackupPolicy(ctx *Context, args *LookupBackupPolicyArgs, opts ...InvokeOption) (*LookupBackupPolicyResult, error)
func LookupBackupPolicyOutput(ctx *Context, args *LookupBackupPolicyOutputArgs, opts ...InvokeOption) LookupBackupPolicyResultOutput
> Note: This function is named LookupBackupPolicy
in the Go SDK.
public static class GetBackupPolicy
{
public static Task<GetBackupPolicyResult> InvokeAsync(GetBackupPolicyArgs args, InvokeOptions? opts = null)
public static Output<GetBackupPolicyResult> Invoke(GetBackupPolicyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackupPolicyResult> getBackupPolicy(GetBackupPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:dataprotection:getBackupPolicy
arguments:
# arguments dictionary
The following arguments are supported:
- Backup
Policy stringName - 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
Policy stringName - 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
Policy StringName - 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
Policy stringName - 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_
policy_ strname - 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
Policy StringName - resource
Group StringName The name of the resource group where the backup vault is present.
- vault
Name String The name of the backup vault.
getBackupPolicy 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 Policy Response BaseBackupPolicyResource 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
Policy Response BaseBackupPolicyResource 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
Policy Response BaseBackupPolicyResource 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
Policy Response BaseBackupPolicyResource 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
Policy Response BaseBackupPolicyResource 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
BaseBackupPolicyResource 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
AbsoluteDeleteOptionResponse
- Duration string
Duration of deletion after given timespan
- Duration string
Duration of deletion after given timespan
- duration String
Duration of deletion after given timespan
- duration string
Duration of deletion after given timespan
- duration str
Duration of deletion after given timespan
- duration String
Duration of deletion after given timespan
AdhocBasedTaggingCriteriaResponse
- Tag
Info Pulumi.Azure Native. Data Protection. Inputs. Retention Tag Response Retention tag information
- Tag
Info RetentionTag Response Retention tag information
- tag
Info RetentionTag Response Retention tag information
- tag
Info RetentionTag Response Retention tag information
- tag_
info RetentionTag Response Retention tag information
- tag
Info Property Map Retention tag information
AdhocBasedTriggerContextResponse
- Tagging
Criteria Pulumi.Azure Native. Data Protection. Inputs. Adhoc Based Tagging Criteria Response Tagging Criteria containing retention tag for adhoc backup.
- Tagging
Criteria AdhocBased Tagging Criteria Response Tagging Criteria containing retention tag for adhoc backup.
- tagging
Criteria AdhocBased Tagging Criteria Response Tagging Criteria containing retention tag for adhoc backup.
- tagging
Criteria AdhocBased Tagging Criteria Response Tagging Criteria containing retention tag for adhoc backup.
- tagging_
criteria AdhocBased Tagging Criteria Response Tagging Criteria containing retention tag for adhoc backup.
- tagging
Criteria Property Map Tagging Criteria containing retention tag for adhoc backup.
AzureBackupParamsResponse
- Backup
Type string BackupType ; Full/Incremental etc
- Backup
Type string BackupType ; Full/Incremental etc
- backup
Type String BackupType ; Full/Incremental etc
- backup
Type string BackupType ; Full/Incremental etc
- backup_
type str BackupType ; Full/Incremental etc
- backup
Type String BackupType ; Full/Incremental etc
AzureBackupRuleResponse
- Data
Store Pulumi.Azure Native. Data Protection. Inputs. Data Store Info Base Response DataStoreInfo base
- Name string
- Trigger
Pulumi.
Azure | Pulumi.Native. Data Protection. Inputs. Adhoc Based Trigger Context Response Azure Native. Data Protection. Inputs. Schedule Based Trigger Context Response Trigger context
- Backup
Parameters Pulumi.Azure Native. Data Protection. Inputs. Azure Backup Params Response BackupParameters base
- Data
Store DataStore Info Base Response DataStoreInfo base
- Name string
- Trigger
Adhoc
Based | ScheduleTrigger Context Response Based Trigger Context Response Trigger context
- Backup
Parameters AzureBackup Params Response BackupParameters base
- data
Store DataStore Info Base Response DataStoreInfo base
- name String
- trigger
Adhoc
Based | ScheduleTrigger Context Response Based Trigger Context Response Trigger context
- backup
Parameters AzureBackup Params Response BackupParameters base
- data
Store DataStore Info Base Response DataStoreInfo base
- name string
- trigger
Adhoc
Based | ScheduleTrigger Context Response Based Trigger Context Response Trigger context
- backup
Parameters AzureBackup Params Response BackupParameters base
- data_
store DataStore Info Base Response DataStoreInfo base
- name str
- trigger
Adhoc
Based | ScheduleTrigger Context Response Based Trigger Context Response Trigger context
- backup_
parameters AzureBackup Params Response BackupParameters base
- data
Store Property Map DataStoreInfo base
- name String
- trigger Property Map | Property Map
Trigger context
- backup
Parameters Property Map BackupParameters base
AzureRetentionRuleResponse
- Lifecycles
[]Source
Life Cycle Response - Name string
- Is
Default bool
- lifecycles
List<Source
Life Cycle Response> - name String
- is
Default Boolean
- lifecycles
Source
Life Cycle Response[] - name string
- is
Default boolean
- lifecycles List<Property Map>
- name String
- is
Default Boolean
BackupPolicyResponse
- Datasource
Types List<string> Type of datasource for the backup management
- Policy
Rules List<Union<Pulumi.Azure Native. Data Protection. Inputs. Azure Backup Rule Response, Pulumi. Azure Native. Data Protection. Inputs. Azure Retention Rule Response>> Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- Datasource
Types []string Type of datasource for the backup management
- Policy
Rules []interface{} Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- datasource
Types List<String> Type of datasource for the backup management
- policy
Rules List<Either<AzureBackup Rule Response,Azure Retention Rule Response>> Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- datasource
Types string[] Type of datasource for the backup management
- policy
Rules (AzureBackup Rule Response | Azure Retention Rule Response)[] Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- datasource_
types Sequence[str] Type of datasource for the backup management
- policy_
rules Sequence[Union[AzureBackup Rule Response, Azure Retention Rule Response]] Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
- datasource
Types List<String> Type of datasource for the backup management
- policy
Rules List<Property Map | Property Map> Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc
BackupScheduleResponse
- Repeating
Time List<string>Intervals ISO 8601 repeating time interval format
- Repeating
Time []stringIntervals ISO 8601 repeating time interval format
- repeating
Time List<String>Intervals ISO 8601 repeating time interval format
- repeating
Time string[]Intervals ISO 8601 repeating time interval format
- repeating_
time_ Sequence[str]intervals ISO 8601 repeating time interval format
- repeating
Time List<String>Intervals ISO 8601 repeating time interval format
CopyOnExpiryOptionResponse
CustomCopyOptionResponse
- Duration string
Data copied after given timespan
- Duration string
Data copied after given timespan
- duration String
Data copied after given timespan
- duration string
Data copied after given timespan
- duration str
Data copied after given timespan
- duration String
Data copied after given timespan
DataStoreInfoBaseResponse
- Data
Store stringType type of datastore; Operational/Vault/Archive
- Object
Type string Type of Datasource object, used to initialize the right inherited type
- Data
Store stringType type of datastore; Operational/Vault/Archive
- Object
Type string Type of Datasource object, used to initialize the right inherited type
- data
Store StringType type of datastore; Operational/Vault/Archive
- object
Type String Type of Datasource object, used to initialize the right inherited type
- data
Store stringType type of datastore; Operational/Vault/Archive
- object
Type string Type of Datasource object, used to initialize the right inherited type
- data_
store_ strtype type of datastore; Operational/Vault/Archive
- object_
type str Type of Datasource object, used to initialize the right inherited type
- data
Store StringType type of datastore; Operational/Vault/Archive
- object
Type String Type of Datasource object, used to initialize the right inherited type
DayResponse
ImmediateCopyOptionResponse
RetentionTagResponse
ScheduleBasedBackupCriteriaResponse
- Absolute
Criteria List<string> it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- Days
Of List<Pulumi.Month Azure Native. Data Protection. Inputs. Day Response> This is day of the month from 1 to 28 other wise last of month
- Days
Of List<string>The Week It should be Sunday/Monday/T..../Saturday
- Months
Of List<string>Year It should be January/February/....../December
- Schedule
Times List<string> List of schedule times for backup
- Weeks
Of List<string>The Month It should be First/Second/Third/Fourth/Last
- Absolute
Criteria []string it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- Days
Of []DayMonth Response This is day of the month from 1 to 28 other wise last of month
- Days
Of []stringThe Week It should be Sunday/Monday/T..../Saturday
- Months
Of []stringYear It should be January/February/....../December
- Schedule
Times []string List of schedule times for backup
- Weeks
Of []stringThe Month It should be First/Second/Third/Fourth/Last
- absolute
Criteria List<String> it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- days
Of List<DayMonth Response> This is day of the month from 1 to 28 other wise last of month
- days
Of List<String>The Week It should be Sunday/Monday/T..../Saturday
- months
Of List<String>Year It should be January/February/....../December
- schedule
Times List<String> List of schedule times for backup
- weeks
Of List<String>The Month It should be First/Second/Third/Fourth/Last
- absolute
Criteria string[] it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- days
Of DayMonth Response[] This is day of the month from 1 to 28 other wise last of month
- days
Of string[]The Week It should be Sunday/Monday/T..../Saturday
- months
Of string[]Year It should be January/February/....../December
- schedule
Times string[] List of schedule times for backup
- weeks
Of string[]The Month It should be First/Second/Third/Fourth/Last
- absolute_
criteria Sequence[str] it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- days_
of_ Sequence[Daymonth Response] This is day of the month from 1 to 28 other wise last of month
- days_
of_ Sequence[str]the_ week It should be Sunday/Monday/T..../Saturday
- months_
of_ Sequence[str]year It should be January/February/....../December
- schedule_
times Sequence[str] List of schedule times for backup
- weeks_
of_ Sequence[str]the_ month It should be First/Second/Third/Fourth/Last
- absolute
Criteria List<String> it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
- days
Of List<Property Map>Month This is day of the month from 1 to 28 other wise last of month
- days
Of List<String>The Week It should be Sunday/Monday/T..../Saturday
- months
Of List<String>Year It should be January/February/....../December
- schedule
Times List<String> List of schedule times for backup
- weeks
Of List<String>The Month It should be First/Second/Third/Fourth/Last
ScheduleBasedTriggerContextResponse
- Schedule
Pulumi.
Azure Native. Data Protection. Inputs. Backup Schedule Response Schedule for this backup
- Tagging
Criteria List<Pulumi.Azure Native. Data Protection. Inputs. Tagging Criteria Response> List of tags that can be applicable for given schedule.
- Schedule
Backup
Schedule Response Schedule for this backup
- Tagging
Criteria []TaggingCriteria Response List of tags that can be applicable for given schedule.
- schedule
Backup
Schedule Response Schedule for this backup
- tagging
Criteria List<TaggingCriteria Response> List of tags that can be applicable for given schedule.
- schedule
Backup
Schedule Response Schedule for this backup
- tagging
Criteria TaggingCriteria Response[] List of tags that can be applicable for given schedule.
- schedule
Backup
Schedule Response Schedule for this backup
- tagging_
criteria Sequence[TaggingCriteria Response] List of tags that can be applicable for given schedule.
- schedule Property Map
Schedule for this backup
- tagging
Criteria List<Property Map> List of tags that can be applicable for given schedule.
SourceLifeCycleResponse
- Delete
After AbsoluteDelete Option Response Delete Option
- Source
Data DataStore Store Info Base Response DataStoreInfo base
- Target
Data []TargetStore Copy Settings Copy Setting Response
- delete
After AbsoluteDelete Option Response Delete Option
- source
Data DataStore Store Info Base Response DataStoreInfo base
- target
Data TargetStore Copy Settings Copy Setting Response[]
- delete
After Property Map Delete Option
- source
Data Property MapStore DataStoreInfo base
- target
Data List<Property Map>Store Copy Settings
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.
TaggingCriteriaResponse
- Is
Default bool Specifies if tag is default.
- Tag
Info Pulumi.Azure Native. Data Protection. Inputs. Retention Tag Response Retention tag information
- Tagging
Priority double Retention Tag priority.
- Criteria
List<Pulumi.
Azure Native. Data Protection. Inputs. Schedule Based Backup Criteria Response> Criteria which decides whether the tag can be applied to a triggered backup.
- Is
Default bool Specifies if tag is default.
- Tag
Info RetentionTag Response Retention tag information
- Tagging
Priority float64 Retention Tag priority.
- Criteria
[]Schedule
Based Backup Criteria Response Criteria which decides whether the tag can be applied to a triggered backup.
- is
Default Boolean Specifies if tag is default.
- tag
Info RetentionTag Response Retention tag information
- tagging
Priority Double Retention Tag priority.
- criteria
List<Schedule
Based Backup Criteria Response> Criteria which decides whether the tag can be applied to a triggered backup.
- is
Default boolean Specifies if tag is default.
- tag
Info RetentionTag Response Retention tag information
- tagging
Priority number Retention Tag priority.
- criteria
Schedule
Based Backup Criteria Response[] Criteria which decides whether the tag can be applied to a triggered backup.
- is_
default bool Specifies if tag is default.
- tag_
info RetentionTag Response Retention tag information
- tagging_
priority float Retention Tag priority.
- criteria
Sequence[Schedule
Based Backup Criteria Response] Criteria which decides whether the tag can be applied to a triggered backup.
- is
Default Boolean Specifies if tag is default.
- tag
Info Property Map Retention tag information
- tagging
Priority Number Retention Tag priority.
- criteria List<Property Map>
Criteria which decides whether the tag can be applied to a triggered backup.
TargetCopySettingResponse
- Copy
After Pulumi.Azure | Pulumi.Native. Data Protection. Inputs. Copy On Expiry Option Response Azure | Pulumi.Native. Data Protection. Inputs. Custom Copy Option Response Azure Native. Data Protection. Inputs. Immediate Copy Option Response It can be CustomCopyOption or ImmediateCopyOption.
- Data
Store Pulumi.Azure Native. Data Protection. Inputs. Data Store Info Base Response Info of target datastore
- Copy
After CopyOn | CustomExpiry Option Response Copy | ImmediateOption Response Copy Option Response It can be CustomCopyOption or ImmediateCopyOption.
- Data
Store DataStore Info Base Response Info of target datastore
- copy
After CopyOn | CustomExpiry Option Response Copy | ImmediateOption Response Copy Option Response It can be CustomCopyOption or ImmediateCopyOption.
- data
Store DataStore Info Base Response Info of target datastore
- copy
After CopyOn | CustomExpiry Option Response Copy | ImmediateOption Response Copy Option Response It can be CustomCopyOption or ImmediateCopyOption.
- data
Store DataStore Info Base Response Info of target datastore
- copy_
after CopyOn | CustomExpiry Option Response Copy | ImmediateOption Response Copy Option Response It can be CustomCopyOption or ImmediateCopyOption.
- data_
store DataStore Info Base Response Info of target datastore
- copy
After Property Map | Property Map | Property Map It can be CustomCopyOption or ImmediateCopyOption.
- data
Store Property Map Info of target datastore
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0