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:

BackupPolicyName string
ResourceGroupName string: The name of the resource group where the backup vault is present.
VaultName string: The name of the backup vault.

BackupPolicyName string
ResourceGroupName string: The name of the resource group where the backup vault is present.
VaultName string: The name of the backup vault.

backupPolicyName String
resourceGroupName String: The name of the resource group where the backup vault is present.
vaultName String: The name of the backup vault.

backupPolicyName string
resourceGroupName string: The name of the resource group where the backup vault is present.
vaultName string: The name of the backup vault.

backup_policy_name str
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.

backupPolicyName String
resourceGroupName String: The name of the resource group where the backup vault is present.
vaultName 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.AzureNative.DataProtection.Outputs.BackupPolicyResponse: BaseBackupPolicyResource 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 BackupPolicyResponse: BaseBackupPolicyResource 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 BackupPolicyResponse: BaseBackupPolicyResource 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 BackupPolicyResponse: BaseBackupPolicyResource 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 BackupPolicyResponse: BaseBackupPolicyResource 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: BaseBackupPolicyResource 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

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

TagInfo Pulumi.AzureNative.DataProtection.Inputs.RetentionTagResponse: Retention tag information

TagInfo RetentionTagResponse: Retention tag information

tagInfo RetentionTagResponse: Retention tag information

tagInfo RetentionTagResponse: Retention tag information

tag_info RetentionTagResponse: Retention tag information

tagInfo Property Map: Retention tag information

AdhocBasedTriggerContextResponse

TaggingCriteria Pulumi.AzureNative.DataProtection.Inputs.AdhocBasedTaggingCriteriaResponse: Tagging Criteria containing retention tag for adhoc backup.

TaggingCriteria AdhocBasedTaggingCriteriaResponse: Tagging Criteria containing retention tag for adhoc backup.

taggingCriteria AdhocBasedTaggingCriteriaResponse: Tagging Criteria containing retention tag for adhoc backup.

taggingCriteria AdhocBasedTaggingCriteriaResponse: Tagging Criteria containing retention tag for adhoc backup.

tagging_criteria AdhocBasedTaggingCriteriaResponse: Tagging Criteria containing retention tag for adhoc backup.

taggingCriteria Property Map: Tagging Criteria containing retention tag for adhoc backup.

AzureBackupParamsResponse

BackupType string: BackupType ; Full/Incremental etc

BackupType string: BackupType ; Full/Incremental etc

backupType String: BackupType ; Full/Incremental etc

backupType string: BackupType ; Full/Incremental etc

backup_type str: BackupType ; Full/Incremental etc

backupType String: BackupType ; Full/Incremental etc

AzureBackupRuleResponse

DataStore Pulumi.AzureNative.DataProtection.Inputs.DataStoreInfoBaseResponse: DataStoreInfo base
Name string
Trigger Pulumi.AzureNative.DataProtection.Inputs.AdhocBasedTriggerContextResponse | Pulumi.AzureNative.DataProtection.Inputs.ScheduleBasedTriggerContextResponse: Trigger context
BackupParameters Pulumi.AzureNative.DataProtection.Inputs.AzureBackupParamsResponse: BackupParameters base

DataStore DataStoreInfoBaseResponse: DataStoreInfo base
Name string
Trigger AdhocBasedTriggerContextResponse | ScheduleBasedTriggerContextResponse: Trigger context
BackupParameters AzureBackupParamsResponse: BackupParameters base

dataStore DataStoreInfoBaseResponse: DataStoreInfo base
name String
trigger AdhocBasedTriggerContextResponse | ScheduleBasedTriggerContextResponse: Trigger context
backupParameters AzureBackupParamsResponse: BackupParameters base

dataStore DataStoreInfoBaseResponse: DataStoreInfo base
name string
trigger AdhocBasedTriggerContextResponse | ScheduleBasedTriggerContextResponse: Trigger context
backupParameters AzureBackupParamsResponse: BackupParameters base

data_store DataStoreInfoBaseResponse: DataStoreInfo base
name str
trigger AdhocBasedTriggerContextResponse | ScheduleBasedTriggerContextResponse: Trigger context
backup_parameters AzureBackupParamsResponse: BackupParameters base

dataStore Property Map: DataStoreInfo base
name String
trigger Property Map | Property Map: Trigger context
backupParameters Property Map: BackupParameters base

AzureRetentionRuleResponse

Lifecycles List<Pulumi.AzureNative.DataProtection.Inputs.SourceLifeCycleResponse>
Name string
IsDefault bool

Lifecycles []SourceLifeCycleResponse
Name string
IsDefault bool

lifecycles List<SourceLifeCycleResponse>
name String
isDefault Boolean

lifecycles SourceLifeCycleResponse[]
name string
isDefault boolean

lifecycles Sequence[SourceLifeCycleResponse]
name str
is_default bool

lifecycles List<Property Map>
name String
isDefault Boolean

BackupPolicyResponse

DatasourceTypes List<string>: Type of datasource for the backup management
PolicyRules List<Union<Pulumi.AzureNative.DataProtection.Inputs.AzureBackupRuleResponse, Pulumi.AzureNative.DataProtection.Inputs.AzureRetentionRuleResponse>>: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

DatasourceTypes []string: Type of datasource for the backup management
PolicyRules []interface{}: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

datasourceTypes List<String>: Type of datasource for the backup management
policyRules List<Either<AzureBackupRuleResponse,AzureRetentionRuleResponse>>: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

datasourceTypes string[]: Type of datasource for the backup management
policyRules (AzureBackupRuleResponse | AzureRetentionRuleResponse)[]: 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[AzureBackupRuleResponse, AzureRetentionRuleResponse]]: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

datasourceTypes List<String>: Type of datasource for the backup management
policyRules List<Property Map | Property Map>: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

BackupScheduleResponse

RepeatingTimeIntervals List<string>: ISO 8601 repeating time interval format

RepeatingTimeIntervals []string: ISO 8601 repeating time interval format

repeatingTimeIntervals List<String>: ISO 8601 repeating time interval format

repeatingTimeIntervals string[]: ISO 8601 repeating time interval format

repeating_time_intervals Sequence[str]: ISO 8601 repeating time interval format

repeatingTimeIntervals List<String>: 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

DataStoreType string: type of datastore; Operational/Vault/Archive
ObjectType string: Type of Datasource object, used to initialize the right inherited type

DataStoreType string: type of datastore; Operational/Vault/Archive
ObjectType string: Type of Datasource object, used to initialize the right inherited type

dataStoreType String: type of datastore; Operational/Vault/Archive
objectType String: Type of Datasource object, used to initialize the right inherited type

dataStoreType string: type of datastore; Operational/Vault/Archive
objectType string: Type of Datasource object, used to initialize the right inherited type

data_store_type str: type of datastore; Operational/Vault/Archive
object_type str: Type of Datasource object, used to initialize the right inherited type

dataStoreType String: type of datastore; Operational/Vault/Archive
objectType String: Type of Datasource object, used to initialize the right inherited type

DayResponse

Date int: Date of the month
IsLast bool: Whether Date is last date of month

Date int: Date of the month
IsLast bool: Whether Date is last date of month

date Integer: Date of the month
isLast Boolean: Whether Date is last date of month

date number: Date of the month
isLast boolean: Whether Date is last date of month

date int: Date of the month
is_last bool: Whether Date is last date of month

date Number: Date of the month
isLast Boolean: Whether Date is last date of month

ImmediateCopyOptionResponse

RetentionTagResponse

ETag string: Retention Tag version.
Id string: Retention Tag version.
TagName string: Retention Tag Name to relate it to retention rule.

ETag string: Retention Tag version.
Id string: Retention Tag version.
TagName string: Retention Tag Name to relate it to retention rule.

eTag String: Retention Tag version.
id String: Retention Tag version.
tagName String: Retention Tag Name to relate it to retention rule.

eTag string: Retention Tag version.
id string: Retention Tag version.
tagName string: Retention Tag Name to relate it to retention rule.

e_tag str: Retention Tag version.
id str: Retention Tag version.
tag_name str: Retention Tag Name to relate it to retention rule.

eTag String: Retention Tag version.
id String: Retention Tag version.
tagName String: Retention Tag Name to relate it to retention rule.

ScheduleBasedBackupCriteriaResponse

AbsoluteCriteria List<string>: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
DaysOfMonth List<Pulumi.AzureNative.DataProtection.Inputs.DayResponse>: This is day of the month from 1 to 28 other wise last of month
DaysOfTheWeek List<string>: It should be Sunday/Monday/T..../Saturday
MonthsOfYear List<string>: It should be January/February/....../December
ScheduleTimes List<string>: List of schedule times for backup
WeeksOfTheMonth List<string>: It should be First/Second/Third/Fourth/Last

AbsoluteCriteria []string: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
DaysOfMonth []DayResponse: This is day of the month from 1 to 28 other wise last of month
DaysOfTheWeek []string: It should be Sunday/Monday/T..../Saturday
MonthsOfYear []string: It should be January/February/....../December
ScheduleTimes []string: List of schedule times for backup
WeeksOfTheMonth []string: It should be First/Second/Third/Fourth/Last

absoluteCriteria List<String>: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
daysOfMonth List<DayResponse>: This is day of the month from 1 to 28 other wise last of month
daysOfTheWeek List<String>: It should be Sunday/Monday/T..../Saturday
monthsOfYear List<String>: It should be January/February/....../December
scheduleTimes List<String>: List of schedule times for backup
weeksOfTheMonth List<String>: It should be First/Second/Third/Fourth/Last

absoluteCriteria string[]: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
daysOfMonth DayResponse[]: This is day of the month from 1 to 28 other wise last of month
daysOfTheWeek string[]: It should be Sunday/Monday/T..../Saturday
monthsOfYear string[]: It should be January/February/....../December
scheduleTimes string[]: List of schedule times for backup
weeksOfTheMonth string[]: 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_month Sequence[DayResponse]: This is day of the month from 1 to 28 other wise last of month
days_of_the_week Sequence[str]: It should be Sunday/Monday/T..../Saturday
months_of_year Sequence[str]: It should be January/February/....../December
schedule_times Sequence[str]: List of schedule times for backup
weeks_of_the_month Sequence[str]: It should be First/Second/Third/Fourth/Last

absoluteCriteria List<String>: it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" and should be part of AbsoluteMarker enum
daysOfMonth List<Property Map>: This is day of the month from 1 to 28 other wise last of month
daysOfTheWeek List<String>: It should be Sunday/Monday/T..../Saturday
monthsOfYear List<String>: It should be January/February/....../December
scheduleTimes List<String>: List of schedule times for backup
weeksOfTheMonth List<String>: It should be First/Second/Third/Fourth/Last

ScheduleBasedTriggerContextResponse

Schedule Pulumi.AzureNative.DataProtection.Inputs.BackupScheduleResponse: Schedule for this backup
TaggingCriteria List<Pulumi.AzureNative.DataProtection.Inputs.TaggingCriteriaResponse>: List of tags that can be applicable for given schedule.

Schedule BackupScheduleResponse: Schedule for this backup
TaggingCriteria []TaggingCriteriaResponse: List of tags that can be applicable for given schedule.

schedule BackupScheduleResponse: Schedule for this backup
taggingCriteria List<TaggingCriteriaResponse>: List of tags that can be applicable for given schedule.

schedule BackupScheduleResponse: Schedule for this backup
taggingCriteria TaggingCriteriaResponse[]: List of tags that can be applicable for given schedule.

schedule BackupScheduleResponse: Schedule for this backup
tagging_criteria Sequence[TaggingCriteriaResponse]: List of tags that can be applicable for given schedule.

schedule Property Map: Schedule for this backup
taggingCriteria List<Property Map>: List of tags that can be applicable for given schedule.

SourceLifeCycleResponse

DeleteAfter Pulumi.AzureNative.DataProtection.Inputs.AbsoluteDeleteOptionResponse: Delete Option
SourceDataStore Pulumi.AzureNative.DataProtection.Inputs.DataStoreInfoBaseResponse: DataStoreInfo base
TargetDataStoreCopySettings List<Pulumi.AzureNative.DataProtection.Inputs.TargetCopySettingResponse>

DeleteAfter AbsoluteDeleteOptionResponse: Delete Option
SourceDataStore DataStoreInfoBaseResponse: DataStoreInfo base
TargetDataStoreCopySettings []TargetCopySettingResponse

deleteAfter AbsoluteDeleteOptionResponse: Delete Option
sourceDataStore DataStoreInfoBaseResponse: DataStoreInfo base
targetDataStoreCopySettings List<TargetCopySettingResponse>

deleteAfter AbsoluteDeleteOptionResponse: Delete Option
sourceDataStore DataStoreInfoBaseResponse: DataStoreInfo base
targetDataStoreCopySettings TargetCopySettingResponse[]

delete_after AbsoluteDeleteOptionResponse: Delete Option
source_data_store DataStoreInfoBaseResponse: DataStoreInfo base
target_data_store_copy_settings Sequence[TargetCopySettingResponse]

deleteAfter Property Map: Delete Option
sourceDataStore Property Map: DataStoreInfo base
targetDataStoreCopySettings List<Property Map>

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.

TaggingCriteriaResponse

IsDefault bool: Specifies if tag is default.
TagInfo Pulumi.AzureNative.DataProtection.Inputs.RetentionTagResponse: Retention tag information
TaggingPriority double: Retention Tag priority.
Criteria List<Pulumi.AzureNative.DataProtection.Inputs.ScheduleBasedBackupCriteriaResponse>: Criteria which decides whether the tag can be applied to a triggered backup.

IsDefault bool: Specifies if tag is default.
TagInfo RetentionTagResponse: Retention tag information
TaggingPriority float64: Retention Tag priority.
Criteria []ScheduleBasedBackupCriteriaResponse: Criteria which decides whether the tag can be applied to a triggered backup.

isDefault Boolean: Specifies if tag is default.
tagInfo RetentionTagResponse: Retention tag information
taggingPriority Double: Retention Tag priority.
criteria List<ScheduleBasedBackupCriteriaResponse>: Criteria which decides whether the tag can be applied to a triggered backup.

isDefault boolean: Specifies if tag is default.
tagInfo RetentionTagResponse: Retention tag information
taggingPriority number: Retention Tag priority.
criteria ScheduleBasedBackupCriteriaResponse[]: Criteria which decides whether the tag can be applied to a triggered backup.

is_default bool: Specifies if tag is default.
tag_info RetentionTagResponse: Retention tag information
tagging_priority float: Retention Tag priority.
criteria Sequence[ScheduleBasedBackupCriteriaResponse]: Criteria which decides whether the tag can be applied to a triggered backup.

isDefault Boolean: Specifies if tag is default.
tagInfo Property Map: Retention tag information
taggingPriority Number: Retention Tag priority.
criteria List<Property Map>: Criteria which decides whether the tag can be applied to a triggered backup.