dataprotection.azure.com/v1api20230101

Package v1api20230101 contains API Schema definitions for the dataprotection v1api20230101 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2023-01-01"

AbsoluteDeleteOption

(Appears on:DeleteOption)

Field	Description
`duration` string	Duration: Duration of deletion after given timespan
`objectType` AbsoluteDeleteOption_ObjectType	ObjectType: Type of the specific object - used for deserializing

AbsoluteDeleteOption_ObjectType (`string` alias)

(Appears on:AbsoluteDeleteOption)

Value	Description
"AbsoluteDeleteOption"

AbsoluteDeleteOption_ObjectType_STATUS (`string` alias)

(Appears on:AbsoluteDeleteOption_STATUS)

Value	Description
"AbsoluteDeleteOption"

AbsoluteDeleteOption_STATUS

(Appears on:DeleteOption_STATUS)

Field	Description
`duration` string	Duration: Duration of deletion after given timespan
`objectType` AbsoluteDeleteOption_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing

AdhocBasedTaggingCriteria

(Appears on:AdhocBasedTriggerContext)

Adhoc backup tagging criteria

Field	Description
`tagInfo` RetentionTag	TagInfo: Retention tag information

AdhocBasedTaggingCriteria_STATUS

(Appears on:AdhocBasedTriggerContext_STATUS)

Adhoc backup tagging criteria

Field	Description
`tagInfo` RetentionTag_STATUS	TagInfo: Retention tag information

AdhocBasedTriggerContext

(Appears on:TriggerContext)

Field	Description
`objectType` AdhocBasedTriggerContext_ObjectType	ObjectType: Type of the specific object - used for deserializing
`taggingCriteria` AdhocBasedTaggingCriteria	TaggingCriteria: Tagging Criteria containing retention tag for adhoc backup.

AdhocBasedTriggerContext_ObjectType (`string` alias)

(Appears on:AdhocBasedTriggerContext)

Value	Description
"AdhocBasedTriggerContext"

AdhocBasedTriggerContext_ObjectType_STATUS (`string` alias)

(Appears on:AdhocBasedTriggerContext_STATUS)

Value	Description
"AdhocBasedTriggerContext"

AdhocBasedTriggerContext_STATUS

(Appears on:TriggerContext_STATUS)

Field	Description
`objectType` AdhocBasedTriggerContext_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing
`taggingCriteria` AdhocBasedTaggingCriteria_STATUS	TaggingCriteria: Tagging Criteria containing retention tag for adhoc backup.

AzureBackupParams

(Appears on:BackupParameters)

Field	Description
`backupType` string	BackupType: BackupType ; Full/Incremental etc
`objectType` AzureBackupParams_ObjectType	ObjectType: Type of the specific object - used for deserializing

AzureBackupParams_ObjectType (`string` alias)

(Appears on:AzureBackupParams)

Value	Description
"AzureBackupParams"

AzureBackupParams_ObjectType_STATUS (`string` alias)

(Appears on:AzureBackupParams_STATUS)

Value	Description
"AzureBackupParams"

AzureBackupParams_STATUS

(Appears on:BackupParameters_STATUS)

Field	Description
`backupType` string	BackupType: BackupType ; Full/Incremental etc
`objectType` AzureBackupParams_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing

AzureBackupRule

(Appears on:BasePolicyRule)

Field	Description
`backupParameters` BackupParameters
`dataStore` DataStoreInfoBase	DataStore: DataStoreInfo base
`name` string
`objectType` AzureBackupRule_ObjectType
`trigger` TriggerContext

AzureBackupRule_ObjectType (`string` alias)

(Appears on:AzureBackupRule)

Value	Description
"AzureBackupRule"

AzureBackupRule_ObjectType_STATUS (`string` alias)

(Appears on:AzureBackupRule_STATUS)

Value	Description
"AzureBackupRule"

AzureBackupRule_STATUS

(Appears on:BasePolicyRule_STATUS)

Field	Description
`backupParameters` BackupParameters_STATUS
`dataStore` DataStoreInfoBase_STATUS	DataStore: DataStoreInfo base
`name` string
`objectType` AzureBackupRule_ObjectType_STATUS
`trigger` TriggerContext_STATUS

AzureMonitorAlertSettings

(Appears on:MonitoringSettings)

Settings for Azure Monitor based alerts

Field	Description
`alertsForAllJobFailures` AzureMonitorAlertSettings_AlertsForAllJobFailures

AzureMonitorAlertSettings_AlertsForAllJobFailures (`string` alias)

(Appears on:AzureMonitorAlertSettings)

Value	Description
"Disabled"
"Enabled"

AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS (`string` alias)

(Appears on:AzureMonitorAlertSettings_STATUS)

Value	Description
"Disabled"
"Enabled"

AzureMonitorAlertSettings_STATUS

(Appears on:MonitoringSettings_STATUS)

Settings for Azure Monitor based alerts

Field	Description
`alertsForAllJobFailures` AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS

AzureRetentionRule

(Appears on:BasePolicyRule)

Field	Description
`isDefault` bool
`lifecycles` []SourceLifeCycle
`name` string
`objectType` AzureRetentionRule_ObjectType

AzureRetentionRule_ObjectType (`string` alias)

(Appears on:AzureRetentionRule)

Value	Description
"AzureRetentionRule"

AzureRetentionRule_ObjectType_STATUS (`string` alias)

(Appears on:AzureRetentionRule_STATUS)

Value	Description
"AzureRetentionRule"

AzureRetentionRule_STATUS

(Appears on:BasePolicyRule_STATUS)

Field	Description
`isDefault` bool
`lifecycles` []SourceLifeCycle_STATUS
`name` string
`objectType` AzureRetentionRule_ObjectType_STATUS

BackupCriteria

(Appears on:TaggingCriteria)

Field	Description
`scheduleBasedBackupCriteria` ScheduleBasedBackupCriteria	ScheduleBasedBackupCriteria: Mutually exclusive with all other properties

BackupCriteria_STATUS

(Appears on:TaggingCriteria_STATUS)

Field	Description
`scheduleBasedBackupCriteria` ScheduleBasedBackupCriteria_STATUS	ScheduleBasedBackupCriteria: Mutually exclusive with all other properties

BackupParameters

(Appears on:AzureBackupRule)

Field	Description
`azureBackupParams` AzureBackupParams	AzureBackupParams: Mutually exclusive with all other properties

BackupParameters_STATUS

(Appears on:AzureBackupRule_STATUS)

Field	Description
`azureBackupParams` AzureBackupParams_STATUS	AzureBackupParams: Mutually exclusive with all other properties

BackupPolicy

(Appears on:BaseBackupPolicy)

Field	Description
`datasourceTypes` []string	DatasourceTypes: Type of datasource for the backup management
`objectType` BackupPolicy_ObjectType
`policyRules` []BasePolicyRule	PolicyRules: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

BackupPolicy_ObjectType (`string` alias)

(Appears on:BackupPolicy)

Value	Description
"BackupPolicy"

BackupPolicy_ObjectType_STATUS (`string` alias)

(Appears on:BackupPolicy_STATUS)

Value	Description
"BackupPolicy"

BackupPolicy_STATUS

(Appears on:BaseBackupPolicy_STATUS)

Field	Description
`datasourceTypes` []string	DatasourceTypes: Type of datasource for the backup management
`objectType` BackupPolicy_ObjectType_STATUS
`policyRules` []BasePolicyRule_STATUS	PolicyRules: Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc

BackupSchedule

(Appears on:ScheduleBasedTriggerContext)

Schedule for backup

Field	Description
`repeatingTimeIntervals` []string	RepeatingTimeIntervals: ISO 8601 repeating time interval format
`timeZone` string	TimeZone: Time zone for a schedule. Example: Pacific Standard Time

BackupSchedule_STATUS

(Appears on:ScheduleBasedTriggerContext_STATUS)

Schedule for backup

Field	Description
`repeatingTimeIntervals` []string	RepeatingTimeIntervals: ISO 8601 repeating time interval format
`timeZone` string	TimeZone: Time zone for a schedule. Example: Pacific Standard Time

BackupVault

Generator information: - Generated from: /dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
BackupVault_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`identity` DppIdentityDetails	Identity: Input Managed Identity Details
`location` string	Location: Resource location.
`operatorSpec` BackupVaultOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`properties` BackupVaultSpec	Properties: BackupVaultResource properties
`tags` map[string]string	Tags: Resource tags.

status
BackupVaultResource_STATUS

BackupVaultOperatorConfigMaps

(Appears on:BackupVaultOperatorSpec)

Field	Description
`principalId` genruntime.ConfigMapDestination	PrincipalId: indicates where the PrincipalId config map should be placed. If omitted, no config map will be created.

BackupVaultOperatorSpec

(Appears on:BackupVault_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`configMaps` BackupVaultOperatorConfigMaps	ConfigMaps: configures where to place operator written ConfigMaps.
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

BackupVaultResource_STATUS

(Appears on:BackupVault)

Backup Vault Resource

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`eTag` string	ETag: Optional ETag.
`id` string	Id: Resource Id represents the complete path to the resource.
`identity` DppIdentityDetails_STATUS	Identity: Input Managed Identity Details
`location` string	Location: Resource location.
`name` string	Name: Resource name associated with the resource.
`properties` BackupVault_STATUS	Properties: BackupVaultResource properties
`systemData` SystemData_STATUS	SystemData: Metadata pertaining to creation and last modification of the resource.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

BackupVaultSpec

(Appears on:BackupVault_Spec)

Backup Vault

Field	Description
`featureSettings` FeatureSettings	FeatureSettings: Feature Settings
`monitoringSettings` MonitoringSettings	MonitoringSettings: Monitoring Settings
`securitySettings` SecuritySettings	SecuritySettings: Security Settings
`storageSettings` []StorageSetting	StorageSettings: Storage Settings

BackupVault_ProvisioningState_STATUS (`string` alias)

(Appears on:BackupVault_STATUS)

Value	Description
"Failed"
"Provisioning"
"Succeeded"
"Unknown"
"Updating"

BackupVault_ResourceMoveState_STATUS (`string` alias)

(Appears on:BackupVault_STATUS)

Value	Description
"CommitFailed"
"CommitTimedout"
"CriticalFailure"
"Failed"
"InProgress"
"MoveSucceeded"
"PartialSuccess"
"PrepareFailed"
"PrepareTimedout"
"Unknown"

BackupVault_STATUS

(Appears on:BackupVaultResource_STATUS)

Backup Vault

Field	Description
`featureSettings` FeatureSettings_STATUS	FeatureSettings: Feature Settings
`isVaultProtectedByResourceGuard` bool	IsVaultProtectedByResourceGuard: Is vault protected by resource guard
`monitoringSettings` MonitoringSettings_STATUS	MonitoringSettings: Monitoring Settings
`provisioningState` BackupVault_ProvisioningState_STATUS	ProvisioningState: Provisioning state of the BackupVault resource
`resourceMoveDetails` ResourceMoveDetails_STATUS	ResourceMoveDetails: Resource move details for backup vault
`resourceMoveState` BackupVault_ResourceMoveState_STATUS	ResourceMoveState: Resource move state for backup vault
`securitySettings` SecuritySettings_STATUS	SecuritySettings: Security Settings
`storageSettings` []StorageSetting_STATUS	StorageSettings: Storage Settings

BackupVault_Spec

(Appears on:BackupVault)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`identity` DppIdentityDetails	Identity: Input Managed Identity Details
`location` string	Location: Resource location.
`operatorSpec` BackupVaultOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`properties` BackupVaultSpec	Properties: BackupVaultResource properties
`tags` map[string]string	Tags: Resource tags.

BackupVaultsBackupPolicy

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
BackupVaultsBackupPolicy_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`operatorSpec` BackupVaultsBackupPolicyOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dataprotection.azure.com/BackupVault resource
`properties` BaseBackupPolicy	Properties: BaseBackupPolicyResource properties

status
BackupVaultsBackupPolicy_STATUS

BackupVaultsBackupPolicyOperatorSpec

(Appears on:BackupVaultsBackupPolicy_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

BackupVaultsBackupPolicy_STATUS

(Appears on:BackupVaultsBackupPolicy)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`id` string	Id: Resource Id represents the complete path to the resource.
`name` string	Name: Resource name associated with the resource.
`properties` BaseBackupPolicy_STATUS	Properties: BaseBackupPolicyResource properties
`systemData` SystemData_STATUS	SystemData: Metadata pertaining to creation and last modification of the resource.
`type` string	Type: Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

BackupVaultsBackupPolicy_Spec

(Appears on:BackupVaultsBackupPolicy)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`operatorSpec` BackupVaultsBackupPolicyOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a dataprotection.azure.com/BackupVault resource
`properties` BaseBackupPolicy	Properties: BaseBackupPolicyResource properties

BaseBackupPolicy

(Appears on:BackupVaultsBackupPolicy_Spec)

Field	Description
`backupPolicy` BackupPolicy	BackupPolicy: Mutually exclusive with all other properties

BaseBackupPolicy_STATUS

(Appears on:BackupVaultsBackupPolicy_STATUS)

Field	Description
`backupPolicy` BackupPolicy_STATUS	BackupPolicy: Mutually exclusive with all other properties

BasePolicyRule

(Appears on:BackupPolicy)

Field	Description
`azureBackupRule` AzureBackupRule	AzureBackup: Mutually exclusive with all other properties
`azureRetentionRule` AzureRetentionRule	AzureRetention: Mutually exclusive with all other properties

BasePolicyRule_STATUS

(Appears on:BackupPolicy_STATUS)

Field	Description
`azureBackupRule` AzureBackupRule_STATUS	AzureBackup: Mutually exclusive with all other properties
`azureRetentionRule` AzureRetentionRule_STATUS	AzureRetention: Mutually exclusive with all other properties

CopyOnExpiryOption

(Appears on:CopyOption)

Field	Description
`objectType` CopyOnExpiryOption_ObjectType	ObjectType: Type of the specific object - used for deserializing

CopyOnExpiryOption_ObjectType (`string` alias)

(Appears on:CopyOnExpiryOption)

Value	Description
"CopyOnExpiryOption"

CopyOnExpiryOption_ObjectType_STATUS (`string` alias)

(Appears on:CopyOnExpiryOption_STATUS)

Value	Description
"CopyOnExpiryOption"

CopyOnExpiryOption_STATUS

(Appears on:CopyOption_STATUS)

Field	Description
`objectType` CopyOnExpiryOption_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing

CopyOption

(Appears on:TargetCopySetting)

Field	Description
`copyOnExpiryOption` CopyOnExpiryOption	CopyOnExpiry: Mutually exclusive with all other properties
`customCopyOption` CustomCopyOption	CustomCopy: Mutually exclusive with all other properties
`immediateCopyOption` ImmediateCopyOption	ImmediateCopy: Mutually exclusive with all other properties

CopyOption_STATUS

(Appears on:TargetCopySetting_STATUS)

Field	Description
`copyOnExpiryOption` CopyOnExpiryOption_STATUS	CopyOnExpiry: Mutually exclusive with all other properties
`customCopyOption` CustomCopyOption_STATUS	CustomCopy: Mutually exclusive with all other properties
`immediateCopyOption` ImmediateCopyOption_STATUS	ImmediateCopy: Mutually exclusive with all other properties

CrossSubscriptionRestoreSettings

(Appears on:FeatureSettings)

CrossSubscriptionRestore Settings

Field	Description
`state` CrossSubscriptionRestoreSettings_State	State: CrossSubscriptionRestore state

CrossSubscriptionRestoreSettings_STATUS

(Appears on:FeatureSettings_STATUS)

CrossSubscriptionRestore Settings

Field	Description
`state` CrossSubscriptionRestoreSettings_State_STATUS	State: CrossSubscriptionRestore state

CrossSubscriptionRestoreSettings_State (`string` alias)

(Appears on:CrossSubscriptionRestoreSettings)

Value	Description
"Disabled"
"Enabled"
"PermanentlyDisabled"

CrossSubscriptionRestoreSettings_State_STATUS (`string` alias)

(Appears on:CrossSubscriptionRestoreSettings_STATUS)

Value	Description
"Disabled"
"Enabled"
"PermanentlyDisabled"

CustomCopyOption

(Appears on:CopyOption)

Field	Description
`duration` string	Duration: Data copied after given timespan
`objectType` CustomCopyOption_ObjectType	ObjectType: Type of the specific object - used for deserializing

CustomCopyOption_ObjectType (`string` alias)

(Appears on:CustomCopyOption)

Value	Description
"CustomCopyOption"

CustomCopyOption_ObjectType_STATUS (`string` alias)

(Appears on:CustomCopyOption_STATUS)

Value	Description
"CustomCopyOption"

CustomCopyOption_STATUS

(Appears on:CopyOption_STATUS)

Field	Description
`duration` string	Duration: Data copied after given timespan
`objectType` CustomCopyOption_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing

DataStoreInfoBase

(Appears on:AzureBackupRule, SourceLifeCycle, TargetCopySetting)

DataStoreInfo base

Field	Description
`dataStoreType` DataStoreInfoBase_DataStoreType	DataStoreType: type of datastore; Operational/Vault/Archive
`objectType` string	ObjectType: Type of Datasource object, used to initialize the right inherited type

DataStoreInfoBase_DataStoreType (`string` alias)

(Appears on:DataStoreInfoBase)

Value	Description
"ArchiveStore"
"OperationalStore"
"VaultStore"

DataStoreInfoBase_DataStoreType_STATUS (`string` alias)

(Appears on:DataStoreInfoBase_STATUS)

Value	Description
"ArchiveStore"
"OperationalStore"
"VaultStore"

DataStoreInfoBase_STATUS

(Appears on:AzureBackupRule_STATUS, SourceLifeCycle_STATUS, TargetCopySetting_STATUS)

DataStoreInfo base

Field	Description
`dataStoreType` DataStoreInfoBase_DataStoreType_STATUS	DataStoreType: type of datastore; Operational/Vault/Archive
`objectType` string	ObjectType: Type of Datasource object, used to initialize the right inherited type

Day

(Appears on:ScheduleBasedBackupCriteria)

Day of the week

Field	Description
`date` int	Date: Date of the month
`isLast` bool	IsLast: Whether Date is last date of month

Day_STATUS

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Day of the week

Field	Description
`date` int	Date: Date of the month
`isLast` bool	IsLast: Whether Date is last date of month

DeleteOption

(Appears on:SourceLifeCycle)

Field	Description
`absoluteDeleteOption` AbsoluteDeleteOption	AbsoluteDeleteOption: Mutually exclusive with all other properties

DeleteOption_STATUS

(Appears on:SourceLifeCycle_STATUS)

Field	Description
`absoluteDeleteOption` AbsoluteDeleteOption_STATUS	AbsoluteDeleteOption: Mutually exclusive with all other properties

DppIdentityDetails

(Appears on:BackupVault_Spec)

Identity details

Field	Description
`type` string	Type: The identityType which can be either SystemAssigned or None

DppIdentityDetails_STATUS

(Appears on:BackupVaultResource_STATUS)

Identity details

Field	Description
`principalId` string	PrincipalId: The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.
`tenantId` string	TenantId: A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.
`type` string	Type: The identityType which can be either SystemAssigned or None

FeatureSettings

(Appears on:BackupVaultSpec)

Class containing feature settings of vault

Field	Description
`crossSubscriptionRestoreSettings` CrossSubscriptionRestoreSettings	CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

FeatureSettings_STATUS

(Appears on:BackupVault_STATUS)

Class containing feature settings of vault

Field	Description
`crossSubscriptionRestoreSettings` CrossSubscriptionRestoreSettings_STATUS	CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

ImmediateCopyOption

(Appears on:CopyOption)

Field	Description
`objectType` ImmediateCopyOption_ObjectType	ObjectType: Type of the specific object - used for deserializing

ImmediateCopyOption_ObjectType (`string` alias)

(Appears on:ImmediateCopyOption)

Value	Description
"ImmediateCopyOption"

ImmediateCopyOption_ObjectType_STATUS (`string` alias)

(Appears on:ImmediateCopyOption_STATUS)

Value	Description
"ImmediateCopyOption"

ImmediateCopyOption_STATUS

(Appears on:CopyOption_STATUS)

Field	Description
`objectType` ImmediateCopyOption_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing

ImmutabilitySettings

(Appears on:SecuritySettings)

Immutability Settings at vault level

Field	Description
`state` ImmutabilitySettings_State	State: Immutability state

ImmutabilitySettings_STATUS

(Appears on:SecuritySettings_STATUS)

Immutability Settings at vault level

Field	Description
`state` ImmutabilitySettings_State_STATUS	State: Immutability state

ImmutabilitySettings_State (`string` alias)

(Appears on:ImmutabilitySettings)

Value	Description
"Disabled"
"Locked"
"Unlocked"

ImmutabilitySettings_State_STATUS (`string` alias)

(Appears on:ImmutabilitySettings_STATUS)

Value	Description
"Disabled"
"Locked"
"Unlocked"

MonitoringSettings

(Appears on:BackupVaultSpec)

Monitoring Settings

Field	Description
`azureMonitorAlertSettings` AzureMonitorAlertSettings	AzureMonitorAlertSettings: Settings for Azure Monitor based alerts

MonitoringSettings_STATUS

(Appears on:BackupVault_STATUS)

Monitoring Settings

Field	Description
`azureMonitorAlertSettings` AzureMonitorAlertSettings_STATUS	AzureMonitorAlertSettings: Settings for Azure Monitor based alerts

ResourceMoveDetails_STATUS

(Appears on:BackupVault_STATUS)

ResourceMoveDetails will be returned in response to GetResource call from ARM

Field	Description
`completionTimeUtc` string	CompletionTimeUtc: Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
`operationId` string	OperationId: CorrelationId of latest ResourceMove operation attempted
`sourceResourcePath` string	SourceResourcePath: ARM resource path of source resource
`startTimeUtc` string	StartTimeUtc: Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.
`targetResourcePath` string	TargetResourcePath: ARM resource path of target resource used in latest ResourceMove operation

RetentionTag

(Appears on:AdhocBasedTaggingCriteria, TaggingCriteria)

Retention tag

Field	Description
`tagName` string	TagName: Retention Tag Name to relate it to retention rule.

RetentionTag_STATUS

(Appears on:AdhocBasedTaggingCriteria_STATUS, TaggingCriteria_STATUS)

Retention tag

Field	Description
`eTag` string	ETag: Retention Tag version.
`id` string	Id: Retention Tag version.
`tagName` string	TagName: Retention Tag Name to relate it to retention rule.

ScheduleBasedBackupCriteria

(Appears on:BackupCriteria)

Field	Description
`absoluteCriteria` []ScheduleBasedBackupCriteria_AbsoluteCriteria	AbsoluteCriteria: it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum
`daysOfMonth` []Day	DaysOfMonth: This is day of the month from 1 to 28 other wise last of month
`daysOfTheWeek` []ScheduleBasedBackupCriteria_DaysOfTheWeek	DaysOfTheWeek: It should be Sunday/Monday/T…./Saturday
`monthsOfYear` []ScheduleBasedBackupCriteria_MonthsOfYear	MonthsOfYear: It should be January/February/……/December
`objectType` ScheduleBasedBackupCriteria_ObjectType	ObjectType: Type of the specific object - used for deserializing
`scheduleTimes` []string	ScheduleTimes: List of schedule times for backup
`weeksOfTheMonth` []ScheduleBasedBackupCriteria_WeeksOfTheMonth	WeeksOfTheMonth: It should be First/Second/Third/Fourth/Last

ScheduleBasedBackupCriteria_AbsoluteCriteria (`string` alias)

(Appears on:ScheduleBasedBackupCriteria)

Value	Description
"AllBackup"
"FirstOfDay"
"FirstOfMonth"
"FirstOfWeek"
"FirstOfYear"

ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS (`string` alias)

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Value	Description
"AllBackup"
"FirstOfDay"
"FirstOfMonth"
"FirstOfWeek"
"FirstOfYear"

ScheduleBasedBackupCriteria_DaysOfTheWeek (`string` alias)

(Appears on:ScheduleBasedBackupCriteria)

Value	Description
"Friday"
"Monday"
"Saturday"
"Sunday"
"Thursday"
"Tuesday"
"Wednesday"

ScheduleBasedBackupCriteria_DaysOfTheWeek_STATUS (`string` alias)

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Value	Description
"Friday"
"Monday"
"Saturday"
"Sunday"
"Thursday"
"Tuesday"
"Wednesday"

ScheduleBasedBackupCriteria_MonthsOfYear (`string` alias)

(Appears on:ScheduleBasedBackupCriteria)

Value	Description
"April"
"August"
"December"
"February"
"January"
"July"
"June"
"March"
"May"
"November"
"October"
"September"

ScheduleBasedBackupCriteria_MonthsOfYear_STATUS (`string` alias)

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Value	Description
"April"
"August"
"December"
"February"
"January"
"July"
"June"
"March"
"May"
"November"
"October"
"September"

ScheduleBasedBackupCriteria_ObjectType (`string` alias)

(Appears on:ScheduleBasedBackupCriteria)

Value	Description
"ScheduleBasedBackupCriteria"

ScheduleBasedBackupCriteria_ObjectType_STATUS (`string` alias)

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Value	Description
"ScheduleBasedBackupCriteria"

ScheduleBasedBackupCriteria_STATUS

(Appears on:BackupCriteria_STATUS)

Field	Description
`absoluteCriteria` []ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS	AbsoluteCriteria: it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum
`daysOfMonth` []Day_STATUS	DaysOfMonth: This is day of the month from 1 to 28 other wise last of month
`daysOfTheWeek` []ScheduleBasedBackupCriteria_DaysOfTheWeek_STATUS	DaysOfTheWeek: It should be Sunday/Monday/T…./Saturday
`monthsOfYear` []ScheduleBasedBackupCriteria_MonthsOfYear_STATUS	MonthsOfYear: It should be January/February/……/December
`objectType` ScheduleBasedBackupCriteria_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing
`scheduleTimes` []string	ScheduleTimes: List of schedule times for backup
`weeksOfTheMonth` []ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS	WeeksOfTheMonth: It should be First/Second/Third/Fourth/Last

ScheduleBasedBackupCriteria_WeeksOfTheMonth (`string` alias)

(Appears on:ScheduleBasedBackupCriteria)

Value	Description
"First"
"Fourth"
"Last"
"Second"
"Third"

ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS (`string` alias)

(Appears on:ScheduleBasedBackupCriteria_STATUS)

Value	Description
"First"
"Fourth"
"Last"
"Second"
"Third"

ScheduleBasedTriggerContext

(Appears on:TriggerContext)

Field	Description
`objectType` ScheduleBasedTriggerContext_ObjectType	ObjectType: Type of the specific object - used for deserializing
`schedule` BackupSchedule	Schedule: Schedule for this backup
`taggingCriteria` []TaggingCriteria	TaggingCriteria: List of tags that can be applicable for given schedule.

ScheduleBasedTriggerContext_ObjectType (`string` alias)

(Appears on:ScheduleBasedTriggerContext)

Value	Description
"ScheduleBasedTriggerContext"

ScheduleBasedTriggerContext_ObjectType_STATUS (`string` alias)

(Appears on:ScheduleBasedTriggerContext_STATUS)

Value	Description
"ScheduleBasedTriggerContext"

ScheduleBasedTriggerContext_STATUS

(Appears on:TriggerContext_STATUS)

Field	Description
`objectType` ScheduleBasedTriggerContext_ObjectType_STATUS	ObjectType: Type of the specific object - used for deserializing
`schedule` BackupSchedule_STATUS	Schedule: Schedule for this backup
`taggingCriteria` []TaggingCriteria_STATUS	TaggingCriteria: List of tags that can be applicable for given schedule.

SecuritySettings

(Appears on:BackupVaultSpec)

Class containing security settings of vault

Field	Description
`immutabilitySettings` ImmutabilitySettings	ImmutabilitySettings: Immutability Settings at vault level
`softDeleteSettings` SoftDeleteSettings	SoftDeleteSettings: Soft delete related settings

SecuritySettings_STATUS

(Appears on:BackupVault_STATUS)

Class containing security settings of vault

Field	Description
`immutabilitySettings` ImmutabilitySettings_STATUS	ImmutabilitySettings: Immutability Settings at vault level
`softDeleteSettings` SoftDeleteSettings_STATUS	SoftDeleteSettings: Soft delete related settings

SoftDeleteSettings

(Appears on:SecuritySettings)

Soft delete related settings

Field	Description
`retentionDurationInDays` float64	RetentionDurationInDays: Soft delete retention duration
`state` SoftDeleteSettings_State	State: State of soft delete

SoftDeleteSettings_STATUS

(Appears on:SecuritySettings_STATUS)

Soft delete related settings

Field	Description
`retentionDurationInDays` float64	RetentionDurationInDays: Soft delete retention duration
`state` SoftDeleteSettings_State_STATUS	State: State of soft delete

SoftDeleteSettings_State (`string` alias)

(Appears on:SoftDeleteSettings)

Value	Description
"AlwaysOn"
"Off"
"On"

SoftDeleteSettings_State_STATUS (`string` alias)

(Appears on:SoftDeleteSettings_STATUS)

Value	Description
"AlwaysOn"
"Off"
"On"

SourceLifeCycle

(Appears on:AzureRetentionRule)

Source LifeCycle

Field	Description
`deleteAfter` DeleteOption
`sourceDataStore` DataStoreInfoBase	SourceDataStore: DataStoreInfo base
`targetDataStoreCopySettings` []TargetCopySetting

SourceLifeCycle_STATUS

(Appears on:AzureRetentionRule_STATUS)

Source LifeCycle

Field	Description
`deleteAfter` DeleteOption_STATUS
`sourceDataStore` DataStoreInfoBase_STATUS	SourceDataStore: DataStoreInfo base
`targetDataStoreCopySettings` []TargetCopySetting_STATUS

StorageSetting

(Appears on:BackupVaultSpec)

Storage setting

Field	Description
`datastoreType` StorageSetting_DatastoreType	DatastoreType: Gets or sets the type of the datastore.
`type` StorageSetting_Type	Type: Gets or sets the type.

StorageSetting_DatastoreType (`string` alias)

(Appears on:StorageSetting)

Value	Description
"ArchiveStore"
"OperationalStore"
"VaultStore"

StorageSetting_DatastoreType_STATUS (`string` alias)

(Appears on:StorageSetting_STATUS)

Value	Description
"ArchiveStore"
"OperationalStore"
"VaultStore"

StorageSetting_STATUS

(Appears on:BackupVault_STATUS)

Storage setting

Field	Description
`datastoreType` StorageSetting_DatastoreType_STATUS	DatastoreType: Gets or sets the type of the datastore.
`type` StorageSetting_Type_STATUS	Type: Gets or sets the type.

StorageSetting_Type (`string` alias)

(Appears on:StorageSetting)

Value	Description
"GeoRedundant"
"LocallyRedundant"
"ZoneRedundant"

StorageSetting_Type_STATUS (`string` alias)

(Appears on:StorageSetting_STATUS)

Value	Description
"GeoRedundant"
"LocallyRedundant"
"ZoneRedundant"

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:BackupVaultResource_STATUS, BackupVaultsBackupPolicy_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

TaggingCriteria

(Appears on:ScheduleBasedTriggerContext)

Tagging criteria

Field	Description
`criteria` []BackupCriteria	Criteria: Criteria which decides whether the tag can be applied to a triggered backup.
`isDefault` bool	IsDefault: Specifies if tag is default.
`tagInfo` RetentionTag	TagInfo: Retention tag information
`taggingPriority` int	TaggingPriority: Retention Tag priority.

TaggingCriteria_STATUS

(Appears on:ScheduleBasedTriggerContext_STATUS)

Tagging criteria

Field	Description
`criteria` []BackupCriteria_STATUS	Criteria: Criteria which decides whether the tag can be applied to a triggered backup.
`isDefault` bool	IsDefault: Specifies if tag is default.
`tagInfo` RetentionTag_STATUS	TagInfo: Retention tag information
`taggingPriority` int	TaggingPriority: Retention Tag priority.

TargetCopySetting

(Appears on:SourceLifeCycle)

Target copy settings

Field	Description
`copyAfter` CopyOption	CopyAfter: It can be CustomCopyOption or ImmediateCopyOption.
`dataStore` DataStoreInfoBase	DataStore: Info of target datastore

TargetCopySetting_STATUS

(Appears on:SourceLifeCycle_STATUS)

Target copy settings

Field	Description
`copyAfter` CopyOption_STATUS	CopyAfter: It can be CustomCopyOption or ImmediateCopyOption.
`dataStore` DataStoreInfoBase_STATUS	DataStore: Info of target datastore

TriggerContext

(Appears on:AzureBackupRule)

Field	Description
`adhocBasedTriggerContext` AdhocBasedTriggerContext	Adhoc: Mutually exclusive with all other properties
`scheduleBasedTriggerContext` ScheduleBasedTriggerContext	Schedule: Mutually exclusive with all other properties

TriggerContext_STATUS

(Appears on:AzureBackupRule_STATUS)

Field	Description
`adhocBasedTriggerContext` AdhocBasedTriggerContext_STATUS	Adhoc: Mutually exclusive with all other properties
`scheduleBasedTriggerContext` ScheduleBasedTriggerContext_STATUS	Schedule: Mutually exclusive with all other properties

dataprotection.azure.com/v1api20230101