dataprotection.azure.com/v1api20231101

dataprotection.azure.com/v1api20231101

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

Resource Types:

    APIVersion (string alias)

    Value Description

    "2023-11-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_ARM

    (Appears on:DeleteOption_ARM)

    Field Description
    duration
    string

    Duration: Duration of deletion after given timespan

    objectType
    AbsoluteDeleteOption_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    AbsoluteDeleteOption_ObjectType (string alias)

    (Appears on:AbsoluteDeleteOption)

    Value Description

    "AbsoluteDeleteOption"

    AbsoluteDeleteOption_ObjectType_ARM (string alias)

    (Appears on:AbsoluteDeleteOption_ARM)

    Value Description

    "AbsoluteDeleteOption"

    AbsoluteDeleteOption_ObjectType_STATUS (string alias)

    (Appears on:AbsoluteDeleteOption_STATUS)

    Value Description

    "AbsoluteDeleteOption"

    AbsoluteDeleteOption_ObjectType_STATUS_ARM (string alias)

    (Appears on:AbsoluteDeleteOption_STATUS_ARM)

    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

    AbsoluteDeleteOption_STATUS_ARM

    (Appears on:DeleteOption_STATUS_ARM)

    Field Description
    duration
    string

    Duration: Duration of deletion after given timespan

    objectType
    AbsoluteDeleteOption_ObjectType_STATUS_ARM

    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_ARM

    (Appears on:AdhocBasedTriggerContext_ARM)

    Adhoc backup tagging criteria

    Field Description
    tagInfo
    RetentionTag_ARM

    TagInfo: Retention tag information

    AdhocBasedTaggingCriteria_STATUS

    (Appears on:AdhocBasedTriggerContext_STATUS)

    Adhoc backup tagging criteria

    Field Description
    tagInfo
    RetentionTag_STATUS

    TagInfo: Retention tag information

    AdhocBasedTaggingCriteria_STATUS_ARM

    (Appears on:AdhocBasedTriggerContext_STATUS_ARM)

    Adhoc backup tagging criteria

    Field Description
    tagInfo
    RetentionTag_STATUS_ARM

    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_ARM

    (Appears on:TriggerContext_ARM)

    Field Description
    objectType
    AdhocBasedTriggerContext_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    taggingCriteria
    AdhocBasedTaggingCriteria_ARM

    TaggingCriteria: Tagging Criteria containing retention tag for adhoc backup.

    AdhocBasedTriggerContext_ObjectType (string alias)

    (Appears on:AdhocBasedTriggerContext)

    Value Description

    "AdhocBasedTriggerContext"

    AdhocBasedTriggerContext_ObjectType_ARM (string alias)

    (Appears on:AdhocBasedTriggerContext_ARM)

    Value Description

    "AdhocBasedTriggerContext"

    AdhocBasedTriggerContext_ObjectType_STATUS (string alias)

    (Appears on:AdhocBasedTriggerContext_STATUS)

    Value Description

    "AdhocBasedTriggerContext"

    AdhocBasedTriggerContext_ObjectType_STATUS_ARM (string alias)

    (Appears on:AdhocBasedTriggerContext_STATUS_ARM)

    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.

    AdhocBasedTriggerContext_STATUS_ARM

    (Appears on:TriggerContext_STATUS_ARM)

    Field Description
    objectType
    AdhocBasedTriggerContext_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    taggingCriteria
    AdhocBasedTaggingCriteria_STATUS_ARM

    TaggingCriteria: Tagging Criteria containing retention tag for adhoc backup.

    AuthCredentials

    (Appears on:BackupInstance)

    Field Description
    secretStoreBasedAuthCredentials
    SecretStoreBasedAuthCredentials

    SecretStoreBasedAuthCredentials: Mutually exclusive with all other properties

    AuthCredentials_ARM

    (Appears on:BackupInstance_ARM)

    Field Description
    secretStoreBasedAuthCredentials
    SecretStoreBasedAuthCredentials_ARM

    SecretStoreBasedAuthCredentials: Mutually exclusive with all other properties

    AuthCredentials_STATUS

    (Appears on:BackupInstance_STATUS)

    Field Description
    secretStoreBasedAuthCredentials
    SecretStoreBasedAuthCredentials_STATUS

    SecretStoreBasedAuthCredentials: Mutually exclusive with all other properties

    AuthCredentials_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    Field Description
    secretStoreBasedAuthCredentials
    SecretStoreBasedAuthCredentials_STATUS_ARM

    SecretStoreBasedAuthCredentials: Mutually exclusive with all other properties

    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_ARM

    (Appears on:BackupParameters_ARM)

    Field Description
    backupType
    string

    BackupType: BackupType ; Full/Incremental etc

    objectType
    AzureBackupParams_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    AzureBackupParams_ObjectType (string alias)

    (Appears on:AzureBackupParams)

    Value Description

    "AzureBackupParams"

    AzureBackupParams_ObjectType_ARM (string alias)

    (Appears on:AzureBackupParams_ARM)

    Value Description

    "AzureBackupParams"

    AzureBackupParams_ObjectType_STATUS (string alias)

    (Appears on:AzureBackupParams_STATUS)

    Value Description

    "AzureBackupParams"

    AzureBackupParams_ObjectType_STATUS_ARM (string alias)

    (Appears on:AzureBackupParams_STATUS_ARM)

    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

    AzureBackupParams_STATUS_ARM

    (Appears on:BackupParameters_STATUS_ARM)

    Field Description
    backupType
    string

    BackupType: BackupType ; Full/Incremental etc

    objectType
    AzureBackupParams_ObjectType_STATUS_ARM

    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_ARM

    (Appears on:BasePolicyRule_ARM)

    Field Description
    backupParameters
    BackupParameters_ARM
    dataStore
    DataStoreInfoBase_ARM

    DataStore: DataStoreInfo base

    name
    string
    objectType
    AzureBackupRule_ObjectType_ARM
    trigger
    TriggerContext_ARM

    AzureBackupRule_ObjectType (string alias)

    (Appears on:AzureBackupRule)

    Value Description

    "AzureBackupRule"

    AzureBackupRule_ObjectType_ARM (string alias)

    (Appears on:AzureBackupRule_ARM)

    Value Description

    "AzureBackupRule"

    AzureBackupRule_ObjectType_STATUS (string alias)

    (Appears on:AzureBackupRule_STATUS)

    Value Description

    "AzureBackupRule"

    AzureBackupRule_ObjectType_STATUS_ARM (string alias)

    (Appears on:AzureBackupRule_STATUS_ARM)

    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

    AzureBackupRule_STATUS_ARM

    (Appears on:BasePolicyRule_STATUS_ARM)

    Field Description
    backupParameters
    BackupParameters_STATUS_ARM
    dataStore
    DataStoreInfoBase_STATUS_ARM

    DataStore: DataStoreInfo base

    name
    string
    objectType
    AzureBackupRule_ObjectType_STATUS_ARM
    trigger
    TriggerContext_STATUS_ARM

    AzureMonitorAlertSettings

    (Appears on:MonitoringSettings)

    Settings for Azure Monitor based alerts

    Field Description
    alertsForAllJobFailures
    AzureMonitorAlertSettings_AlertsForAllJobFailures

    AzureMonitorAlertSettings_ARM

    (Appears on:MonitoringSettings_ARM)

    Settings for Azure Monitor based alerts

    Field Description
    alertsForAllJobFailures
    AzureMonitorAlertSettings_AlertsForAllJobFailures_ARM

    AzureMonitorAlertSettings_AlertsForAllJobFailures (string alias)

    (Appears on:AzureMonitorAlertSettings)

    Value Description

    "Disabled"

    "Enabled"

    AzureMonitorAlertSettings_AlertsForAllJobFailures_ARM (string alias)

    (Appears on:AzureMonitorAlertSettings_ARM)

    Value Description

    "Disabled"

    "Enabled"

    AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS (string alias)

    (Appears on:AzureMonitorAlertSettings_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS_ARM (string alias)

    (Appears on:AzureMonitorAlertSettings_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    AzureMonitorAlertSettings_STATUS

    (Appears on:MonitoringSettings_STATUS)

    Settings for Azure Monitor based alerts

    Field Description
    alertsForAllJobFailures
    AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS

    AzureMonitorAlertSettings_STATUS_ARM

    (Appears on:MonitoringSettings_STATUS_ARM)

    Settings for Azure Monitor based alerts

    Field Description
    alertsForAllJobFailures
    AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS_ARM

    AzureOperationalStoreParameters

    (Appears on:DataStoreParameters)

    Field Description
    dataStoreType
    AzureOperationalStoreParameters_DataStoreType

    DataStoreType: type of datastore; Operational/Vault/Archive

    objectType
    AzureOperationalStoreParameters_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    resourceGroupReference
    genruntime.ResourceReference

    ResourceGroupReference: Gets or sets the Snapshot Resource Group Uri.

    AzureOperationalStoreParameters_ARM

    (Appears on:DataStoreParameters_ARM)

    Field Description
    dataStoreType
    AzureOperationalStoreParameters_DataStoreType_ARM

    DataStoreType: type of datastore; Operational/Vault/Archive

    objectType
    AzureOperationalStoreParameters_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    resourceGroupId
    string

    AzureOperationalStoreParameters_DataStoreType (string alias)

    (Appears on:AzureOperationalStoreParameters)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    AzureOperationalStoreParameters_DataStoreType_ARM (string alias)

    (Appears on:AzureOperationalStoreParameters_ARM)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    AzureOperationalStoreParameters_DataStoreType_STATUS (string alias)

    (Appears on:AzureOperationalStoreParameters_STATUS)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    AzureOperationalStoreParameters_DataStoreType_STATUS_ARM (string alias)

    (Appears on:AzureOperationalStoreParameters_STATUS_ARM)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    AzureOperationalStoreParameters_ObjectType (string alias)

    (Appears on:AzureOperationalStoreParameters)

    Value Description

    "AzureOperationalStoreParameters"

    AzureOperationalStoreParameters_ObjectType_ARM (string alias)

    (Appears on:AzureOperationalStoreParameters_ARM)

    Value Description

    "AzureOperationalStoreParameters"

    AzureOperationalStoreParameters_ObjectType_STATUS (string alias)

    (Appears on:AzureOperationalStoreParameters_STATUS)

    Value Description

    "AzureOperationalStoreParameters"

    AzureOperationalStoreParameters_ObjectType_STATUS_ARM (string alias)

    (Appears on:AzureOperationalStoreParameters_STATUS_ARM)

    Value Description

    "AzureOperationalStoreParameters"

    AzureOperationalStoreParameters_STATUS

    (Appears on:DataStoreParameters_STATUS)

    Field Description
    dataStoreType
    AzureOperationalStoreParameters_DataStoreType_STATUS

    DataStoreType: type of datastore; Operational/Vault/Archive

    objectType
    AzureOperationalStoreParameters_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    resourceGroupId
    string

    ResourceGroupId: Gets or sets the Snapshot Resource Group Uri.

    AzureOperationalStoreParameters_STATUS_ARM

    (Appears on:DataStoreParameters_STATUS_ARM)

    Field Description
    dataStoreType
    AzureOperationalStoreParameters_DataStoreType_STATUS_ARM

    DataStoreType: type of datastore; Operational/Vault/Archive

    objectType
    AzureOperationalStoreParameters_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    resourceGroupId
    string

    ResourceGroupId: Gets or sets the Snapshot Resource Group Uri.

    AzureRetentionRule

    (Appears on:BasePolicyRule)

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

    AzureRetentionRule_ARM

    (Appears on:BasePolicyRule_ARM)

    Field Description
    isDefault
    bool
    lifecycles
    []SourceLifeCycle_ARM
    name
    string
    objectType
    AzureRetentionRule_ObjectType_ARM

    AzureRetentionRule_ObjectType (string alias)

    (Appears on:AzureRetentionRule)

    Value Description

    "AzureRetentionRule"

    AzureRetentionRule_ObjectType_ARM (string alias)

    (Appears on:AzureRetentionRule_ARM)

    Value Description

    "AzureRetentionRule"

    AzureRetentionRule_ObjectType_STATUS (string alias)

    (Appears on:AzureRetentionRule_STATUS)

    Value Description

    "AzureRetentionRule"

    AzureRetentionRule_ObjectType_STATUS_ARM (string alias)

    (Appears on:AzureRetentionRule_STATUS_ARM)

    Value Description

    "AzureRetentionRule"

    AzureRetentionRule_STATUS

    (Appears on:BasePolicyRule_STATUS)

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

    AzureRetentionRule_STATUS_ARM

    (Appears on:BasePolicyRule_STATUS_ARM)

    Field Description
    isDefault
    bool
    lifecycles
    []SourceLifeCycle_STATUS_ARM
    name
    string
    objectType
    AzureRetentionRule_ObjectType_STATUS_ARM

    BackupCriteria

    (Appears on:TaggingCriteria)

    Field Description
    scheduleBasedBackupCriteria
    ScheduleBasedBackupCriteria

    ScheduleBasedBackupCriteria: Mutually exclusive with all other properties

    BackupCriteria_ARM

    (Appears on:TaggingCriteria_ARM)

    Field Description
    scheduleBasedBackupCriteria
    ScheduleBasedBackupCriteria_ARM

    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

    BackupCriteria_STATUS_ARM

    (Appears on:TaggingCriteria_STATUS_ARM)

    Field Description
    scheduleBasedBackupCriteria
    ScheduleBasedBackupCriteria_STATUS_ARM

    ScheduleBasedBackupCriteria: Mutually exclusive with all other properties

    BackupDatasourceParameters

    (Appears on:PolicyParameters)

    Field Description
    blobBackupDatasourceParameters
    BlobBackupDatasourceParameters

    Blob: Mutually exclusive with all other properties

    kubernetesClusterBackupDatasourceParameters
    KubernetesClusterBackupDatasourceParameters

    KubernetesCluster: Mutually exclusive with all other properties

    BackupDatasourceParameters_ARM

    (Appears on:PolicyParameters_ARM)

    Field Description
    blobBackupDatasourceParameters
    BlobBackupDatasourceParameters_ARM

    Blob: Mutually exclusive with all other properties

    kubernetesClusterBackupDatasourceParameters
    KubernetesClusterBackupDatasourceParameters_ARM

    KubernetesCluster: Mutually exclusive with all other properties

    BackupDatasourceParameters_STATUS

    (Appears on:PolicyParameters_STATUS)

    Field Description
    blobBackupDatasourceParameters
    BlobBackupDatasourceParameters_STATUS

    Blob: Mutually exclusive with all other properties

    kubernetesClusterBackupDatasourceParameters
    KubernetesClusterBackupDatasourceParameters_STATUS

    KubernetesCluster: Mutually exclusive with all other properties

    BackupDatasourceParameters_STATUS_ARM

    (Appears on:PolicyParameters_STATUS_ARM)

    Field Description
    blobBackupDatasourceParameters
    BlobBackupDatasourceParameters_STATUS_ARM

    Blob: Mutually exclusive with all other properties

    kubernetesClusterBackupDatasourceParameters
    KubernetesClusterBackupDatasourceParameters_STATUS_ARM

    KubernetesCluster: Mutually exclusive with all other properties

    BackupInstance

    (Appears on:BackupVaults_BackupInstance_Spec)

    Backup Instance

    Field Description
    dataSourceInfo
    Datasource

    DataSourceInfo: Gets or sets the data source information.

    dataSourceSetInfo
    DatasourceSet

    DataSourceSetInfo: Gets or sets the data source set information.

    datasourceAuthCredentials
    AuthCredentials

    DatasourceAuthCredentials: Credentials to use to authenticate with data source provider.

    friendlyName
    string

    FriendlyName: Gets or sets the Backup Instance friendly name.

    identityDetails
    IdentityDetails

    IdentityDetails: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

    objectType
    string
    policyInfo
    PolicyInfo

    PolicyInfo: Gets or sets the policy information.

    validationType
    BackupInstance_ValidationType

    ValidationType: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

    BackupInstance_ARM

    (Appears on:BackupVaults_BackupInstance_Spec_ARM)

    Backup Instance

    Field Description
    dataSourceInfo
    Datasource_ARM

    DataSourceInfo: Gets or sets the data source information.

    dataSourceSetInfo
    DatasourceSet_ARM

    DataSourceSetInfo: Gets or sets the data source set information.

    datasourceAuthCredentials
    AuthCredentials_ARM

    DatasourceAuthCredentials: Credentials to use to authenticate with data source provider.

    friendlyName
    string

    FriendlyName: Gets or sets the Backup Instance friendly name.

    identityDetails
    IdentityDetails_ARM

    IdentityDetails: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

    objectType
    string
    policyInfo
    PolicyInfo_ARM

    PolicyInfo: Gets or sets the policy information.

    validationType
    BackupInstance_ValidationType_ARM

    ValidationType: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

    BackupInstance_CurrentProtectionState_STATUS (string alias)

    (Appears on:BackupInstance_STATUS)

    Value Description

    "BackupSchedulesSuspended"

    "ConfiguringProtection"

    "ConfiguringProtectionFailed"

    "Invalid"

    "NotProtected"

    "ProtectionConfigured"

    "ProtectionError"

    "ProtectionStopped"

    "RetentionSchedulesSuspended"

    "SoftDeleted"

    "SoftDeleting"

    "UpdatingProtection"

    BackupInstance_CurrentProtectionState_STATUS_ARM (string alias)

    (Appears on:BackupInstance_STATUS_ARM)

    Value Description

    "BackupSchedulesSuspended"

    "ConfiguringProtection"

    "ConfiguringProtectionFailed"

    "Invalid"

    "NotProtected"

    "ProtectionConfigured"

    "ProtectionError"

    "ProtectionStopped"

    "RetentionSchedulesSuspended"

    "SoftDeleted"

    "SoftDeleting"

    "UpdatingProtection"

    BackupInstance_STATUS

    (Appears on:BackupVaults_BackupInstance_STATUS)

    Backup Instance

    Field Description
    currentProtectionState
    BackupInstance_CurrentProtectionState_STATUS

    CurrentProtectionState: Specifies the current protection state of the resource

    dataSourceInfo
    Datasource_STATUS

    DataSourceInfo: Gets or sets the data source information.

    dataSourceSetInfo
    DatasourceSet_STATUS

    DataSourceSetInfo: Gets or sets the data source set information.

    datasourceAuthCredentials
    AuthCredentials_STATUS

    DatasourceAuthCredentials: Credentials to use to authenticate with data source provider.

    friendlyName
    string

    FriendlyName: Gets or sets the Backup Instance friendly name.

    identityDetails
    IdentityDetails_STATUS

    IdentityDetails: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

    objectType
    string
    policyInfo
    PolicyInfo_STATUS

    PolicyInfo: Gets or sets the policy information.

    protectionErrorDetails
    UserFacingError_STATUS

    ProtectionErrorDetails: Specifies the protection error of the resource

    protectionStatus
    ProtectionStatusDetails_STATUS

    ProtectionStatus: Specifies the protection status of the resource

    provisioningState
    string

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

    validationType
    BackupInstance_ValidationType_STATUS

    ValidationType: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

    BackupInstance_STATUS_ARM

    (Appears on:BackupVaults_BackupInstance_STATUS_ARM)

    Backup Instance

    Field Description
    currentProtectionState
    BackupInstance_CurrentProtectionState_STATUS_ARM

    CurrentProtectionState: Specifies the current protection state of the resource

    dataSourceInfo
    Datasource_STATUS_ARM

    DataSourceInfo: Gets or sets the data source information.

    dataSourceSetInfo
    DatasourceSet_STATUS_ARM

    DataSourceSetInfo: Gets or sets the data source set information.

    datasourceAuthCredentials
    AuthCredentials_STATUS_ARM

    DatasourceAuthCredentials: Credentials to use to authenticate with data source provider.

    friendlyName
    string

    FriendlyName: Gets or sets the Backup Instance friendly name.

    identityDetails
    IdentityDetails_STATUS_ARM

    IdentityDetails: Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.

    objectType
    string
    policyInfo
    PolicyInfo_STATUS_ARM

    PolicyInfo: Gets or sets the policy information.

    protectionErrorDetails
    UserFacingError_STATUS_ARM

    ProtectionErrorDetails: Specifies the protection error of the resource

    protectionStatus
    ProtectionStatusDetails_STATUS_ARM

    ProtectionStatus: Specifies the protection status of the resource

    provisioningState
    string

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

    validationType
    BackupInstance_ValidationType_STATUS_ARM

    ValidationType: Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.

    BackupInstance_ValidationType (string alias)

    (Appears on:BackupInstance)

    Value Description

    "DeepValidation"

    "ShallowValidation"

    BackupInstance_ValidationType_ARM (string alias)

    (Appears on:BackupInstance_ARM)

    Value Description

    "DeepValidation"

    "ShallowValidation"

    BackupInstance_ValidationType_STATUS (string alias)

    (Appears on:BackupInstance_STATUS)

    Value Description

    "DeepValidation"

    "ShallowValidation"

    BackupInstance_ValidationType_STATUS_ARM (string alias)

    (Appears on:BackupInstance_STATUS_ARM)

    Value Description

    "DeepValidation"

    "ShallowValidation"

    BackupParameters

    (Appears on:AzureBackupRule)

    Field Description
    azureBackupParams
    AzureBackupParams

    AzureBackupParams: Mutually exclusive with all other properties

    BackupParameters_ARM

    (Appears on:AzureBackupRule_ARM)

    Field Description
    azureBackupParams
    AzureBackupParams_ARM

    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

    BackupParameters_STATUS_ARM

    (Appears on:AzureBackupRule_STATUS_ARM)

    Field Description
    azureBackupParams
    AzureBackupParams_STATUS_ARM

    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_ARM

    (Appears on:BaseBackupPolicy_ARM)

    Field Description
    datasourceTypes
    []string

    DatasourceTypes: Type of datasource for the backup management

    objectType
    BackupPolicy_ObjectType_ARM
    policyRules
    []BasePolicyRule_ARM

    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_ARM (string alias)

    (Appears on:BackupPolicy_ARM)

    Value Description

    "BackupPolicy"

    BackupPolicy_ObjectType_STATUS (string alias)

    (Appears on:BackupPolicy_STATUS)

    Value Description

    "BackupPolicy"

    BackupPolicy_ObjectType_STATUS_ARM (string alias)

    (Appears on:BackupPolicy_STATUS_ARM)

    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

    BackupPolicy_STATUS_ARM

    (Appears on:BaseBackupPolicy_STATUS_ARM)

    Field Description
    datasourceTypes
    []string

    DatasourceTypes: Type of datasource for the backup management

    objectType
    BackupPolicy_ObjectType_STATUS_ARM
    policyRules
    []BasePolicyRule_STATUS_ARM

    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_ARM

    (Appears on:ScheduleBasedTriggerContext_ARM)

    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

    BackupSchedule_STATUS_ARM

    (Appears on:ScheduleBasedTriggerContext_STATUS_ARM)

    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-11-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
    configMaps
    BackupVaultOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    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/…

    BackupVaultResource_STATUS_ARM

    Backup Vault Resource

    Field Description
    eTag
    string

    ETag: Optional ETag.

    id
    string

    Id: Resource Id represents the complete path to the resource.

    identity
    DppIdentityDetails_STATUS_ARM

    Identity: Input Managed Identity Details

    location
    string

    Location: Resource location.

    name
    string

    Name: Resource name associated with the resource.

    properties
    BackupVault_STATUS_ARM

    Properties: BackupVaultResource properties

    systemData
    SystemData_STATUS_ARM

    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

    replicatedRegions
    []string

    ReplicatedRegions: List of replicated regions for Backup Vault

    securitySettings
    SecuritySettings

    SecuritySettings: Security Settings

    storageSettings
    []StorageSetting

    StorageSettings: Storage Settings

    BackupVaultSpec_ARM

    (Appears on:BackupVault_Spec_ARM)

    Backup Vault

    Field Description
    featureSettings
    FeatureSettings_ARM

    FeatureSettings: Feature Settings

    monitoringSettings
    MonitoringSettings_ARM

    MonitoringSettings: Monitoring Settings

    replicatedRegions
    []string

    ReplicatedRegions: List of replicated regions for Backup Vault

    securitySettings
    SecuritySettings_ARM

    SecuritySettings: Security Settings

    storageSettings
    []StorageSetting_ARM

    StorageSettings: Storage Settings

    BackupVault_ProvisioningState_STATUS (string alias)

    (Appears on:BackupVault_STATUS)

    Value Description

    "Failed"

    "Provisioning"

    "Succeeded"

    "Unknown"

    "Updating"

    BackupVault_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:BackupVault_STATUS_ARM)

    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_ResourceMoveState_STATUS_ARM (string alias)

    (Appears on:BackupVault_STATUS_ARM)

    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

    replicatedRegions
    []string

    ReplicatedRegions: List of replicated regions for Backup Vault

    resourceMoveDetails
    ResourceMoveDetails_STATUS

    ResourceMoveDetails: Resource move details for backup vault

    resourceMoveState
    BackupVault_ResourceMoveState_STATUS

    ResourceMoveState: Resource move state for backup vault

    secureScore
    BackupVault_SecureScore_STATUS

    SecureScore: Secure Score of Backup Vault

    securitySettings
    SecuritySettings_STATUS

    SecuritySettings: Security Settings

    storageSettings
    []StorageSetting_STATUS

    StorageSettings: Storage Settings

    BackupVault_STATUS_ARM

    (Appears on:BackupVaultResource_STATUS_ARM)

    Backup Vault

    Field Description
    featureSettings
    FeatureSettings_STATUS_ARM

    FeatureSettings: Feature Settings

    isVaultProtectedByResourceGuard
    bool

    IsVaultProtectedByResourceGuard: Is vault protected by resource guard

    monitoringSettings
    MonitoringSettings_STATUS_ARM

    MonitoringSettings: Monitoring Settings

    provisioningState
    BackupVault_ProvisioningState_STATUS_ARM

    ProvisioningState: Provisioning state of the BackupVault resource

    replicatedRegions
    []string

    ReplicatedRegions: List of replicated regions for Backup Vault

    resourceMoveDetails
    ResourceMoveDetails_STATUS_ARM

    ResourceMoveDetails: Resource move details for backup vault

    resourceMoveState
    BackupVault_ResourceMoveState_STATUS_ARM

    ResourceMoveState: Resource move state for backup vault

    secureScore
    BackupVault_SecureScore_STATUS_ARM

    SecureScore: Secure Score of Backup Vault

    securitySettings
    SecuritySettings_STATUS_ARM

    SecuritySettings: Security Settings

    storageSettings
    []StorageSetting_STATUS_ARM

    StorageSettings: Storage Settings

    BackupVault_SecureScore_STATUS (string alias)

    (Appears on:BackupVault_STATUS)

    Value Description

    "Adequate"

    "Maximum"

    "Minimum"

    "None"

    "NotSupported"

    BackupVault_SecureScore_STATUS_ARM (string alias)

    (Appears on:BackupVault_STATUS_ARM)

    Value Description

    "Adequate"

    "Maximum"

    "Minimum"

    "None"

    "NotSupported"

    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.

    BackupVault_Spec_ARM

    Field Description
    identity
    DppIdentityDetails_ARM

    Identity: Input Managed Identity Details

    location
    string

    Location: Resource location.

    name
    string
    properties
    BackupVaultSpec_ARM

    Properties: BackupVaultResource properties

    tags
    map[string]string

    Tags: Resource tags.

    BackupVaultsBackupInstance

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    BackupVaults_BackupInstance_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.

    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
    BackupInstance

    Properties: BackupInstanceResource properties

    tags
    map[string]string

    Tags: Proxy Resource tags.

    status
    BackupVaults_BackupInstance_STATUS

    BackupVaultsBackupPolicy

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

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    BackupVaults_BackupPolicy_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.

    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
    BackupVaults_BackupPolicy_STATUS

    BackupVaults_BackupInstance_STATUS

    (Appears on:BackupVaultsBackupInstance)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Proxy Resource Id represents the complete path to the resource.

    name
    string

    Name: Proxy Resource name associated with the resource.

    properties
    BackupInstance_STATUS

    Properties: BackupInstanceResource properties

    systemData
    SystemData_STATUS

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Proxy Resource tags.

    type
    string

    Type: Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

    BackupVaults_BackupInstance_STATUS_ARM

    Field Description
    id
    string

    Id: Proxy Resource Id represents the complete path to the resource.

    name
    string

    Name: Proxy Resource name associated with the resource.

    properties
    BackupInstance_STATUS_ARM

    Properties: BackupInstanceResource properties

    systemData
    SystemData_STATUS_ARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    tags
    map[string]string

    Tags: Proxy Resource tags.

    type
    string

    Type: Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/…

    BackupVaults_BackupInstance_Spec

    (Appears on:BackupVaultsBackupInstance)

    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.

    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
    BackupInstance

    Properties: BackupInstanceResource properties

    tags
    map[string]string

    Tags: Proxy Resource tags.

    BackupVaults_BackupInstance_Spec_ARM

    Field Description
    name
    string
    properties
    BackupInstance_ARM

    Properties: BackupInstanceResource properties

    tags
    map[string]string

    Tags: Proxy Resource tags.

    BackupVaults_BackupPolicy_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/…

    BackupVaults_BackupPolicy_STATUS_ARM

    Field Description
    id
    string

    Id: Resource Id represents the complete path to the resource.

    name
    string

    Name: Resource name associated with the resource.

    properties
    BaseBackupPolicy_STATUS_ARM

    Properties: BaseBackupPolicyResource properties

    systemData
    SystemData_STATUS_ARM

    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/…

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

    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

    BackupVaults_BackupPolicy_Spec_ARM

    Field Description
    name
    string
    properties
    BaseBackupPolicy_ARM

    Properties: BaseBackupPolicyResource properties

    BaseBackupPolicy

    (Appears on:BackupVaults_BackupPolicy_Spec)

    Field Description
    backupPolicy
    BackupPolicy

    BackupPolicy: Mutually exclusive with all other properties

    BaseBackupPolicy_ARM

    (Appears on:BackupVaults_BackupPolicy_Spec_ARM)

    Field Description
    backupPolicy
    BackupPolicy_ARM

    BackupPolicy: Mutually exclusive with all other properties

    BaseBackupPolicy_STATUS

    (Appears on:BackupVaults_BackupPolicy_STATUS)

    Field Description
    backupPolicy
    BackupPolicy_STATUS

    BackupPolicy: Mutually exclusive with all other properties

    BaseBackupPolicy_STATUS_ARM

    (Appears on:BackupVaults_BackupPolicy_STATUS_ARM)

    Field Description
    backupPolicy
    BackupPolicy_STATUS_ARM

    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_ARM

    (Appears on:BackupPolicy_ARM)

    Field Description
    azureBackupRule
    AzureBackupRule_ARM

    AzureBackup: Mutually exclusive with all other properties

    azureRetentionRule
    AzureRetentionRule_ARM

    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

    BasePolicyRule_STATUS_ARM

    (Appears on:BackupPolicy_STATUS_ARM)

    Field Description
    azureBackupRule
    AzureBackupRule_STATUS_ARM

    AzureBackup: Mutually exclusive with all other properties

    azureRetentionRule
    AzureRetentionRule_STATUS_ARM

    AzureRetention: Mutually exclusive with all other properties

    BaseResourceProperties

    (Appears on:Datasource, DatasourceSet)

    Field Description
    defaultResourceProperties
    DefaultResourceProperties

    DefaultResourceProperties: Mutually exclusive with all other properties

    BaseResourceProperties_ARM

    (Appears on:DatasourceSet_ARM, Datasource_ARM)

    Field Description
    defaultResourceProperties
    DefaultResourceProperties_ARM

    DefaultResourceProperties: Mutually exclusive with all other properties

    BaseResourceProperties_STATUS

    (Appears on:DatasourceSet_STATUS, Datasource_STATUS)

    Field Description
    defaultResourceProperties
    DefaultResourceProperties_STATUS

    DefaultResourceProperties: Mutually exclusive with all other properties

    BaseResourceProperties_STATUS_ARM

    (Appears on:DatasourceSet_STATUS_ARM, Datasource_STATUS_ARM)

    Field Description
    defaultResourceProperties
    DefaultResourceProperties_STATUS_ARM

    DefaultResourceProperties: Mutually exclusive with all other properties

    BlobBackupDatasourceParameters

    (Appears on:BackupDatasourceParameters)

    Field Description
    containersList
    []string

    ContainersList: List of containers to be backed up during configuration of backup of blobs

    objectType
    BlobBackupDatasourceParameters_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    BlobBackupDatasourceParameters_ARM

    (Appears on:BackupDatasourceParameters_ARM)

    Field Description
    containersList
    []string

    ContainersList: List of containers to be backed up during configuration of backup of blobs

    objectType
    BlobBackupDatasourceParameters_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    BlobBackupDatasourceParameters_ObjectType (string alias)

    (Appears on:BlobBackupDatasourceParameters)

    Value Description

    "BlobBackupDatasourceParameters"

    BlobBackupDatasourceParameters_ObjectType_ARM (string alias)

    (Appears on:BlobBackupDatasourceParameters_ARM)

    Value Description

    "BlobBackupDatasourceParameters"

    BlobBackupDatasourceParameters_ObjectType_STATUS (string alias)

    (Appears on:BlobBackupDatasourceParameters_STATUS)

    Value Description

    "BlobBackupDatasourceParameters"

    BlobBackupDatasourceParameters_ObjectType_STATUS_ARM (string alias)

    (Appears on:BlobBackupDatasourceParameters_STATUS_ARM)

    Value Description

    "BlobBackupDatasourceParameters"

    BlobBackupDatasourceParameters_STATUS

    (Appears on:BackupDatasourceParameters_STATUS)

    Field Description
    containersList
    []string

    ContainersList: List of containers to be backed up during configuration of backup of blobs

    objectType
    BlobBackupDatasourceParameters_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    BlobBackupDatasourceParameters_STATUS_ARM

    (Appears on:BackupDatasourceParameters_STATUS_ARM)

    Field Description
    containersList
    []string

    ContainersList: List of containers to be backed up during configuration of backup of blobs

    objectType
    BlobBackupDatasourceParameters_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    CopyOnExpiryOption

    (Appears on:CopyOption)

    Field Description
    objectType
    CopyOnExpiryOption_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    CopyOnExpiryOption_ARM

    (Appears on:CopyOption_ARM)

    Field Description
    objectType
    CopyOnExpiryOption_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    CopyOnExpiryOption_ObjectType (string alias)

    (Appears on:CopyOnExpiryOption)

    Value Description

    "CopyOnExpiryOption"

    CopyOnExpiryOption_ObjectType_ARM (string alias)

    (Appears on:CopyOnExpiryOption_ARM)

    Value Description

    "CopyOnExpiryOption"

    CopyOnExpiryOption_ObjectType_STATUS (string alias)

    (Appears on:CopyOnExpiryOption_STATUS)

    Value Description

    "CopyOnExpiryOption"

    CopyOnExpiryOption_ObjectType_STATUS_ARM (string alias)

    (Appears on:CopyOnExpiryOption_STATUS_ARM)

    Value Description

    "CopyOnExpiryOption"

    CopyOnExpiryOption_STATUS

    (Appears on:CopyOption_STATUS)

    Field Description
    objectType
    CopyOnExpiryOption_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    CopyOnExpiryOption_STATUS_ARM

    (Appears on:CopyOption_STATUS_ARM)

    Field Description
    objectType
    CopyOnExpiryOption_ObjectType_STATUS_ARM

    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_ARM

    (Appears on:TargetCopySetting_ARM)

    Field Description
    copyOnExpiryOption
    CopyOnExpiryOption_ARM

    CopyOnExpiry: Mutually exclusive with all other properties

    customCopyOption
    CustomCopyOption_ARM

    CustomCopy: Mutually exclusive with all other properties

    immediateCopyOption
    ImmediateCopyOption_ARM

    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

    CopyOption_STATUS_ARM

    (Appears on:TargetCopySetting_STATUS_ARM)

    Field Description
    copyOnExpiryOption
    CopyOnExpiryOption_STATUS_ARM

    CopyOnExpiry: Mutually exclusive with all other properties

    customCopyOption
    CustomCopyOption_STATUS_ARM

    CustomCopy: Mutually exclusive with all other properties

    immediateCopyOption
    ImmediateCopyOption_STATUS_ARM

    ImmediateCopy: Mutually exclusive with all other properties

    CrossRegionRestoreSettings

    (Appears on:FeatureSettings)

    Field Description
    state
    CrossRegionRestoreSettings_State

    State: CrossRegionRestore state

    CrossRegionRestoreSettings_ARM

    (Appears on:FeatureSettings_ARM)

    Field Description
    state
    CrossRegionRestoreSettings_State_ARM

    State: CrossRegionRestore state

    CrossRegionRestoreSettings_STATUS

    (Appears on:FeatureSettings_STATUS)

    Field Description
    state
    CrossRegionRestoreSettings_State_STATUS

    State: CrossRegionRestore state

    CrossRegionRestoreSettings_STATUS_ARM

    (Appears on:FeatureSettings_STATUS_ARM)

    Field Description
    state
    CrossRegionRestoreSettings_State_STATUS_ARM

    State: CrossRegionRestore state

    CrossRegionRestoreSettings_State (string alias)

    (Appears on:CrossRegionRestoreSettings)

    Value Description

    "Disabled"

    "Enabled"

    CrossRegionRestoreSettings_State_ARM (string alias)

    (Appears on:CrossRegionRestoreSettings_ARM)

    Value Description

    "Disabled"

    "Enabled"

    CrossRegionRestoreSettings_State_STATUS (string alias)

    (Appears on:CrossRegionRestoreSettings_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    CrossRegionRestoreSettings_State_STATUS_ARM (string alias)

    (Appears on:CrossRegionRestoreSettings_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    CrossSubscriptionRestoreSettings

    (Appears on:FeatureSettings)

    CrossSubscriptionRestore Settings

    Field Description
    state
    CrossSubscriptionRestoreSettings_State

    State: CrossSubscriptionRestore state

    CrossSubscriptionRestoreSettings_ARM

    (Appears on:FeatureSettings_ARM)

    CrossSubscriptionRestore Settings

    Field Description
    state
    CrossSubscriptionRestoreSettings_State_ARM

    State: CrossSubscriptionRestore state

    CrossSubscriptionRestoreSettings_STATUS

    (Appears on:FeatureSettings_STATUS)

    CrossSubscriptionRestore Settings

    Field Description
    state
    CrossSubscriptionRestoreSettings_State_STATUS

    State: CrossSubscriptionRestore state

    CrossSubscriptionRestoreSettings_STATUS_ARM

    (Appears on:FeatureSettings_STATUS_ARM)

    CrossSubscriptionRestore Settings

    Field Description
    state
    CrossSubscriptionRestoreSettings_State_STATUS_ARM

    State: CrossSubscriptionRestore state

    CrossSubscriptionRestoreSettings_State (string alias)

    (Appears on:CrossSubscriptionRestoreSettings)

    Value Description

    "Disabled"

    "Enabled"

    "PermanentlyDisabled"

    CrossSubscriptionRestoreSettings_State_ARM (string alias)

    (Appears on:CrossSubscriptionRestoreSettings_ARM)

    Value Description

    "Disabled"

    "Enabled"

    "PermanentlyDisabled"

    CrossSubscriptionRestoreSettings_State_STATUS (string alias)

    (Appears on:CrossSubscriptionRestoreSettings_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    "PermanentlyDisabled"

    CrossSubscriptionRestoreSettings_State_STATUS_ARM (string alias)

    (Appears on:CrossSubscriptionRestoreSettings_STATUS_ARM)

    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_ARM

    (Appears on:CopyOption_ARM)

    Field Description
    duration
    string

    Duration: Data copied after given timespan

    objectType
    CustomCopyOption_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    CustomCopyOption_ObjectType (string alias)

    (Appears on:CustomCopyOption)

    Value Description

    "CustomCopyOption"

    CustomCopyOption_ObjectType_ARM (string alias)

    (Appears on:CustomCopyOption_ARM)

    Value Description

    "CustomCopyOption"

    CustomCopyOption_ObjectType_STATUS (string alias)

    (Appears on:CustomCopyOption_STATUS)

    Value Description

    "CustomCopyOption"

    CustomCopyOption_ObjectType_STATUS_ARM (string alias)

    (Appears on:CustomCopyOption_STATUS_ARM)

    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

    CustomCopyOption_STATUS_ARM

    (Appears on:CopyOption_STATUS_ARM)

    Field Description
    duration
    string

    Duration: Data copied after given timespan

    objectType
    CustomCopyOption_ObjectType_STATUS_ARM

    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_ARM

    (Appears on:AzureBackupRule_ARM, SourceLifeCycle_ARM, TargetCopySetting_ARM)

    DataStoreInfo base

    Field Description
    dataStoreType
    DataStoreInfoBase_DataStoreType_ARM

    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_ARM (string alias)

    (Appears on:DataStoreInfoBase_ARM)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    DataStoreInfoBase_DataStoreType_STATUS (string alias)

    (Appears on:DataStoreInfoBase_STATUS)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    DataStoreInfoBase_DataStoreType_STATUS_ARM (string alias)

    (Appears on:DataStoreInfoBase_STATUS_ARM)

    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

    DataStoreInfoBase_STATUS_ARM

    (Appears on:AzureBackupRule_STATUS_ARM, SourceLifeCycle_STATUS_ARM, TargetCopySetting_STATUS_ARM)

    DataStoreInfo base

    Field Description
    dataStoreType
    DataStoreInfoBase_DataStoreType_STATUS_ARM

    DataStoreType: type of datastore; Operational/Vault/Archive

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    DataStoreParameters

    (Appears on:PolicyParameters)

    Field Description
    azureOperationalStoreParameters
    AzureOperationalStoreParameters

    AzureOperationalStoreParameters: Mutually exclusive with all other properties

    DataStoreParameters_ARM

    (Appears on:PolicyParameters_ARM)

    Field Description
    azureOperationalStoreParameters
    AzureOperationalStoreParameters_ARM

    AzureOperationalStoreParameters: Mutually exclusive with all other properties

    DataStoreParameters_STATUS

    (Appears on:PolicyParameters_STATUS)

    Field Description
    azureOperationalStoreParameters
    AzureOperationalStoreParameters_STATUS

    AzureOperationalStoreParameters: Mutually exclusive with all other properties

    DataStoreParameters_STATUS_ARM

    (Appears on:PolicyParameters_STATUS_ARM)

    Field Description
    azureOperationalStoreParameters
    AzureOperationalStoreParameters_STATUS_ARM

    AzureOperationalStoreParameters: Mutually exclusive with all other properties

    Datasource

    (Appears on:BackupInstance)

    Datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties

    ResourceProperties: Properties specific to data source

    resourceReference
    genruntime.ResourceReference

    ResourceReference: 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.

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    DatasourceSet

    (Appears on:BackupInstance)

    DatasourceSet details of datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties

    ResourceProperties: Properties specific to data source set

    resourceReference
    genruntime.ResourceReference

    ResourceReference: 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.

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    DatasourceSet_ARM

    (Appears on:BackupInstance_ARM)

    DatasourceSet details of datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string
    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_ARM

    ResourceProperties: Properties specific to data source set

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    DatasourceSet_STATUS

    (Appears on:BackupInstance_STATUS)

    DatasourceSet details of datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string

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

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_STATUS

    ResourceProperties: Properties specific to data source set

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    DatasourceSet_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    DatasourceSet details of datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string

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

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_STATUS_ARM

    ResourceProperties: Properties specific to data source set

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    Datasource_ARM

    (Appears on:BackupInstance_ARM)

    Datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string
    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_ARM

    ResourceProperties: Properties specific to data source

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    Datasource_STATUS

    (Appears on:BackupInstance_STATUS)

    Datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string

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

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_STATUS

    ResourceProperties: Properties specific to data source

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    Datasource_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    Datasource to be backed up

    Field Description
    datasourceType
    string

    DatasourceType: DatasourceType of the resource.

    objectType
    string

    ObjectType: Type of Datasource object, used to initialize the right inherited type

    resourceID
    string

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

    resourceLocation
    string

    ResourceLocation: Location of datasource.

    resourceName
    string

    ResourceName: Unique identifier of the resource in the context of parent.

    resourceProperties
    BaseResourceProperties_STATUS_ARM

    ResourceProperties: Properties specific to data source

    resourceType
    string

    ResourceType: Resource Type of Datasource.

    resourceUri
    string

    ResourceUri: Uri of the resource.

    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_ARM

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    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

    Day_STATUS_ARM

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    Day of the week

    Field Description
    date
    int

    Date: Date of the month

    isLast
    bool

    IsLast: Whether Date is last date of month

    DefaultResourceProperties

    (Appears on:BaseResourceProperties)

    Field Description
    objectType
    DefaultResourceProperties_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    DefaultResourceProperties_ARM

    (Appears on:BaseResourceProperties_ARM)

    Field Description
    objectType
    DefaultResourceProperties_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    DefaultResourceProperties_ObjectType (string alias)

    (Appears on:DefaultResourceProperties)

    Value Description

    "DefaultResourceProperties"

    DefaultResourceProperties_ObjectType_ARM (string alias)

    (Appears on:DefaultResourceProperties_ARM)

    Value Description

    "DefaultResourceProperties"

    DefaultResourceProperties_ObjectType_STATUS (string alias)

    (Appears on:DefaultResourceProperties_STATUS)

    Value Description

    "DefaultResourceProperties"

    DefaultResourceProperties_ObjectType_STATUS_ARM (string alias)

    (Appears on:DefaultResourceProperties_STATUS_ARM)

    Value Description

    "DefaultResourceProperties"

    DefaultResourceProperties_STATUS

    (Appears on:BaseResourceProperties_STATUS)

    Field Description
    objectType
    DefaultResourceProperties_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    DefaultResourceProperties_STATUS_ARM

    (Appears on:BaseResourceProperties_STATUS_ARM)

    Field Description
    objectType
    DefaultResourceProperties_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    DeleteOption

    (Appears on:SourceLifeCycle)

    Field Description
    absoluteDeleteOption
    AbsoluteDeleteOption

    AbsoluteDeleteOption: Mutually exclusive with all other properties

    DeleteOption_ARM

    (Appears on:SourceLifeCycle_ARM)

    Field Description
    absoluteDeleteOption
    AbsoluteDeleteOption_ARM

    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

    DeleteOption_STATUS_ARM

    (Appears on:SourceLifeCycle_STATUS_ARM)

    Field Description
    absoluteDeleteOption
    AbsoluteDeleteOption_STATUS_ARM

    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, UserAssigned, ‘SystemAssigned,UserAssigned’ or None

    userAssignedIdentities
    []UserAssignedIdentityDetails

    UserAssignedIdentities: Gets or sets the user assigned identities.

    DppIdentityDetails_ARM

    (Appears on:BackupVault_Spec_ARM)

    Identity details

    Field Description
    type
    string

    Type: The identityType which can be either SystemAssigned, UserAssigned, ‘SystemAssigned,UserAssigned’ or None

    userAssignedIdentities
    map[string]./api/dataprotection/v1api20231101.UserAssignedIdentityDetails_ARM

    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, UserAssigned, ‘SystemAssigned,UserAssigned’ or None

    userAssignedIdentities
    map[string]./api/dataprotection/v1api20231101.UserAssignedIdentity_STATUS

    UserAssignedIdentities: Gets or sets the user assigned identities.

    DppIdentityDetails_STATUS_ARM

    (Appears on:BackupVaultResource_STATUS_ARM)

    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, UserAssigned, ‘SystemAssigned,UserAssigned’ or None

    userAssignedIdentities
    map[string]./api/dataprotection/v1api20231101.UserAssignedIdentity_STATUS_ARM

    UserAssignedIdentities: Gets or sets the user assigned identities.

    FeatureSettings

    (Appears on:BackupVaultSpec)

    Class containing feature settings of vault

    Field Description
    crossRegionRestoreSettings
    CrossRegionRestoreSettings
    crossSubscriptionRestoreSettings
    CrossSubscriptionRestoreSettings

    CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

    FeatureSettings_ARM

    (Appears on:BackupVaultSpec_ARM)

    Class containing feature settings of vault

    Field Description
    crossRegionRestoreSettings
    CrossRegionRestoreSettings_ARM
    crossSubscriptionRestoreSettings
    CrossSubscriptionRestoreSettings_ARM

    CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

    FeatureSettings_STATUS

    (Appears on:BackupVault_STATUS)

    Class containing feature settings of vault

    Field Description
    crossRegionRestoreSettings
    CrossRegionRestoreSettings_STATUS
    crossSubscriptionRestoreSettings
    CrossSubscriptionRestoreSettings_STATUS

    CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

    FeatureSettings_STATUS_ARM

    (Appears on:BackupVault_STATUS_ARM)

    Class containing feature settings of vault

    Field Description
    crossRegionRestoreSettings
    CrossRegionRestoreSettings_STATUS_ARM
    crossSubscriptionRestoreSettings
    CrossSubscriptionRestoreSettings_STATUS_ARM

    CrossSubscriptionRestoreSettings: CrossSubscriptionRestore Settings

    IdentityDetails

    (Appears on:BackupInstance)

    Field Description
    useSystemAssignedIdentity
    bool

    UseSystemAssignedIdentity: Specifies if the BI is protected by System Identity.

    userAssignedIdentityArmUrl
    string

    UserAssignedIdentityArmUrl: ARM URL for User Assigned Identity.

    IdentityDetails_ARM

    (Appears on:BackupInstance_ARM)

    Field Description
    useSystemAssignedIdentity
    bool

    UseSystemAssignedIdentity: Specifies if the BI is protected by System Identity.

    userAssignedIdentityArmUrl
    string

    UserAssignedIdentityArmUrl: ARM URL for User Assigned Identity.

    IdentityDetails_STATUS

    (Appears on:BackupInstance_STATUS)

    Field Description
    useSystemAssignedIdentity
    bool

    UseSystemAssignedIdentity: Specifies if the BI is protected by System Identity.

    userAssignedIdentityArmUrl
    string

    UserAssignedIdentityArmUrl: ARM URL for User Assigned Identity.

    IdentityDetails_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    Field Description
    useSystemAssignedIdentity
    bool

    UseSystemAssignedIdentity: Specifies if the BI is protected by System Identity.

    userAssignedIdentityArmUrl
    string

    UserAssignedIdentityArmUrl: ARM URL for User Assigned Identity.

    ImmediateCopyOption

    (Appears on:CopyOption)

    Field Description
    objectType
    ImmediateCopyOption_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    ImmediateCopyOption_ARM

    (Appears on:CopyOption_ARM)

    Field Description
    objectType
    ImmediateCopyOption_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    ImmediateCopyOption_ObjectType (string alias)

    (Appears on:ImmediateCopyOption)

    Value Description

    "ImmediateCopyOption"

    ImmediateCopyOption_ObjectType_ARM (string alias)

    (Appears on:ImmediateCopyOption_ARM)

    Value Description

    "ImmediateCopyOption"

    ImmediateCopyOption_ObjectType_STATUS (string alias)

    (Appears on:ImmediateCopyOption_STATUS)

    Value Description

    "ImmediateCopyOption"

    ImmediateCopyOption_ObjectType_STATUS_ARM (string alias)

    (Appears on:ImmediateCopyOption_STATUS_ARM)

    Value Description

    "ImmediateCopyOption"

    ImmediateCopyOption_STATUS

    (Appears on:CopyOption_STATUS)

    Field Description
    objectType
    ImmediateCopyOption_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    ImmediateCopyOption_STATUS_ARM

    (Appears on:CopyOption_STATUS_ARM)

    Field Description
    objectType
    ImmediateCopyOption_ObjectType_STATUS_ARM

    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_ARM

    (Appears on:SecuritySettings_ARM)

    Immutability Settings at vault level

    Field Description
    state
    ImmutabilitySettings_State_ARM

    State: Immutability state

    ImmutabilitySettings_STATUS

    (Appears on:SecuritySettings_STATUS)

    Immutability Settings at vault level

    Field Description
    state
    ImmutabilitySettings_State_STATUS

    State: Immutability state

    ImmutabilitySettings_STATUS_ARM

    (Appears on:SecuritySettings_STATUS_ARM)

    Immutability Settings at vault level

    Field Description
    state
    ImmutabilitySettings_State_STATUS_ARM

    State: Immutability state

    ImmutabilitySettings_State (string alias)

    (Appears on:ImmutabilitySettings)

    Value Description

    "Disabled"

    "Locked"

    "Unlocked"

    ImmutabilitySettings_State_ARM (string alias)

    (Appears on:ImmutabilitySettings_ARM)

    Value Description

    "Disabled"

    "Locked"

    "Unlocked"

    ImmutabilitySettings_State_STATUS (string alias)

    (Appears on:ImmutabilitySettings_STATUS)

    Value Description

    "Disabled"

    "Locked"

    "Unlocked"

    ImmutabilitySettings_State_STATUS_ARM (string alias)

    (Appears on:ImmutabilitySettings_STATUS_ARM)

    Value Description

    "Disabled"

    "Locked"

    "Unlocked"

    InnerError_STATUS

    (Appears on:UserFacingError_STATUS, UserFacingError_STATUS_Unrolled)

    Inner Error

    Field Description
    additionalInfo
    map[string]string

    AdditionalInfo: Any Key value pairs that can be provided to the client for additional verbose information.

    code
    string

    Code: Unique code for this error

    embeddedInnerError
    InnerError_STATUS_Unrolled

    EmbeddedInnerError: Child Inner Error, to allow Nesting.

    InnerError_STATUS_ARM

    (Appears on:UserFacingError_STATUS_ARM, UserFacingError_STATUS_Unrolled_ARM)

    Inner Error

    Field Description
    additionalInfo
    map[string]string

    AdditionalInfo: Any Key value pairs that can be provided to the client for additional verbose information.

    code
    string

    Code: Unique code for this error

    embeddedInnerError
    InnerError_STATUS_Unrolled_ARM

    EmbeddedInnerError: Child Inner Error, to allow Nesting.

    InnerError_STATUS_Unrolled

    (Appears on:InnerError_STATUS)

    Field Description
    additionalInfo
    map[string]string

    AdditionalInfo: Any Key value pairs that can be provided to the client for additional verbose information.

    code
    string

    Code: Unique code for this error

    InnerError_STATUS_Unrolled_ARM

    (Appears on:InnerError_STATUS_ARM)

    Field Description
    additionalInfo
    map[string]string

    AdditionalInfo: Any Key value pairs that can be provided to the client for additional verbose information.

    code
    string

    Code: Unique code for this error

    KubernetesClusterBackupDatasourceParameters

    (Appears on:BackupDatasourceParameters)

    Field Description
    backupHookReferences
    []NamespacedNameResource

    BackupHookReferences: Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

    excludedNamespaces
    []string

    ExcludedNamespaces: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.

    excludedResourceTypes
    []string

    ExcludedResourceTypes: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.

    includeClusterScopeResources
    bool

    IncludeClusterScopeResources: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.

    includedNamespaces
    []string

    IncludedNamespaces: Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.

    includedResourceTypes
    []string

    IncludedResourceTypes: Gets or sets the include resource types property. This property sets the resource types to be included during backup.

    labelSelectors
    []string

    LabelSelectors: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.

    objectType
    KubernetesClusterBackupDatasourceParameters_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    snapshotVolumes
    bool

    SnapshotVolumes: Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.

    KubernetesClusterBackupDatasourceParameters_ARM

    (Appears on:BackupDatasourceParameters_ARM)

    Field Description
    backupHookReferences
    []NamespacedNameResource_ARM

    BackupHookReferences: Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

    excludedNamespaces
    []string

    ExcludedNamespaces: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.

    excludedResourceTypes
    []string

    ExcludedResourceTypes: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.

    includeClusterScopeResources
    bool

    IncludeClusterScopeResources: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.

    includedNamespaces
    []string

    IncludedNamespaces: Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.

    includedResourceTypes
    []string

    IncludedResourceTypes: Gets or sets the include resource types property. This property sets the resource types to be included during backup.

    labelSelectors
    []string

    LabelSelectors: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.

    objectType
    KubernetesClusterBackupDatasourceParameters_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    snapshotVolumes
    bool

    SnapshotVolumes: Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.

    KubernetesClusterBackupDatasourceParameters_ObjectType (string alias)

    (Appears on:KubernetesClusterBackupDatasourceParameters)

    Value Description

    "KubernetesClusterBackupDatasourceParameters"

    KubernetesClusterBackupDatasourceParameters_ObjectType_ARM (string alias)

    (Appears on:KubernetesClusterBackupDatasourceParameters_ARM)

    Value Description

    "KubernetesClusterBackupDatasourceParameters"

    KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS (string alias)

    (Appears on:KubernetesClusterBackupDatasourceParameters_STATUS)

    Value Description

    "KubernetesClusterBackupDatasourceParameters"

    KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS_ARM (string alias)

    (Appears on:KubernetesClusterBackupDatasourceParameters_STATUS_ARM)

    Value Description

    "KubernetesClusterBackupDatasourceParameters"

    KubernetesClusterBackupDatasourceParameters_STATUS

    (Appears on:BackupDatasourceParameters_STATUS)

    Field Description
    backupHookReferences
    []NamespacedNameResource_STATUS

    BackupHookReferences: Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

    excludedNamespaces
    []string

    ExcludedNamespaces: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.

    excludedResourceTypes
    []string

    ExcludedResourceTypes: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.

    includeClusterScopeResources
    bool

    IncludeClusterScopeResources: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.

    includedNamespaces
    []string

    IncludedNamespaces: Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.

    includedResourceTypes
    []string

    IncludedResourceTypes: Gets or sets the include resource types property. This property sets the resource types to be included during backup.

    labelSelectors
    []string

    LabelSelectors: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.

    objectType
    KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    snapshotVolumes
    bool

    SnapshotVolumes: Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.

    KubernetesClusterBackupDatasourceParameters_STATUS_ARM

    (Appears on:BackupDatasourceParameters_STATUS_ARM)

    Field Description
    backupHookReferences
    []NamespacedNameResource_STATUS_ARM

    BackupHookReferences: Gets or sets the backup hook references. This property sets the hook reference to be executed during backup.

    excludedNamespaces
    []string

    ExcludedNamespaces: Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup.

    excludedResourceTypes
    []string

    ExcludedResourceTypes: Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup.

    includeClusterScopeResources
    bool

    IncludeClusterScopeResources: Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup.

    includedNamespaces
    []string

    IncludedNamespaces: Gets or sets the include namespaces property. This property sets the namespaces to be included during backup.

    includedResourceTypes
    []string

    IncludedResourceTypes: Gets or sets the include resource types property. This property sets the resource types to be included during backup.

    labelSelectors
    []string

    LabelSelectors: Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup.

    objectType
    KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    snapshotVolumes
    bool

    SnapshotVolumes: Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup.

    MonitoringSettings

    (Appears on:BackupVaultSpec)

    Monitoring Settings

    Field Description
    azureMonitorAlertSettings
    AzureMonitorAlertSettings

    AzureMonitorAlertSettings: Settings for Azure Monitor based alerts

    MonitoringSettings_ARM

    (Appears on:BackupVaultSpec_ARM)

    Monitoring Settings

    Field Description
    azureMonitorAlertSettings
    AzureMonitorAlertSettings_ARM

    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

    MonitoringSettings_STATUS_ARM

    (Appears on:BackupVault_STATUS_ARM)

    Monitoring Settings

    Field Description
    azureMonitorAlertSettings
    AzureMonitorAlertSettings_STATUS_ARM

    AzureMonitorAlertSettings: Settings for Azure Monitor based alerts

    NamespacedNameResource

    (Appears on:KubernetesClusterBackupDatasourceParameters)

    Class to refer resources which contains namespace and name

    Field Description
    name
    string

    Name: Name of the resource

    namespace
    string

    Namespace: Namespace in which the resource exists

    NamespacedNameResource_ARM

    (Appears on:KubernetesClusterBackupDatasourceParameters_ARM)

    Class to refer resources which contains namespace and name

    Field Description
    name
    string

    Name: Name of the resource

    namespace
    string

    Namespace: Namespace in which the resource exists

    NamespacedNameResource_STATUS

    (Appears on:KubernetesClusterBackupDatasourceParameters_STATUS)

    Class to refer resources which contains namespace and name

    Field Description
    name
    string

    Name: Name of the resource

    namespace
    string

    Namespace: Namespace in which the resource exists

    NamespacedNameResource_STATUS_ARM

    (Appears on:KubernetesClusterBackupDatasourceParameters_STATUS_ARM)

    Class to refer resources which contains namespace and name

    Field Description
    name
    string

    Name: Name of the resource

    namespace
    string

    Namespace: Namespace in which the resource exists

    PolicyInfo

    (Appears on:BackupInstance)

    Policy Info in backupInstance

    Field Description
    policyParameters
    PolicyParameters

    PolicyParameters: Policy parameters for the backup instance

    policyReference
    genruntime.ResourceReference

    PolicyInfo_ARM

    (Appears on:BackupInstance_ARM)

    Policy Info in backupInstance

    Field Description
    policyId
    string
    policyParameters
    PolicyParameters_ARM

    PolicyParameters: Policy parameters for the backup instance

    PolicyInfo_STATUS

    (Appears on:BackupInstance_STATUS)

    Policy Info in backupInstance

    Field Description
    policyId
    string
    policyParameters
    PolicyParameters_STATUS

    PolicyParameters: Policy parameters for the backup instance

    policyVersion
    string

    PolicyInfo_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    Policy Info in backupInstance

    Field Description
    policyId
    string
    policyParameters
    PolicyParameters_STATUS_ARM

    PolicyParameters: Policy parameters for the backup instance

    policyVersion
    string

    PolicyParameters

    (Appears on:PolicyInfo)

    Parameters in Policy

    Field Description
    backupDatasourceParametersList
    []BackupDatasourceParameters

    BackupDatasourceParametersList: Gets or sets the Backup Data Source Parameters

    dataStoreParametersList
    []DataStoreParameters

    DataStoreParametersList: Gets or sets the DataStore Parameters

    PolicyParameters_ARM

    (Appears on:PolicyInfo_ARM)

    Parameters in Policy

    Field Description
    backupDatasourceParametersList
    []BackupDatasourceParameters_ARM

    BackupDatasourceParametersList: Gets or sets the Backup Data Source Parameters

    dataStoreParametersList
    []DataStoreParameters_ARM

    DataStoreParametersList: Gets or sets the DataStore Parameters

    PolicyParameters_STATUS

    (Appears on:PolicyInfo_STATUS)

    Parameters in Policy

    Field Description
    backupDatasourceParametersList
    []BackupDatasourceParameters_STATUS

    BackupDatasourceParametersList: Gets or sets the Backup Data Source Parameters

    dataStoreParametersList
    []DataStoreParameters_STATUS

    DataStoreParametersList: Gets or sets the DataStore Parameters

    PolicyParameters_STATUS_ARM

    (Appears on:PolicyInfo_STATUS_ARM)

    Parameters in Policy

    Field Description
    backupDatasourceParametersList
    []BackupDatasourceParameters_STATUS_ARM

    BackupDatasourceParametersList: Gets or sets the Backup Data Source Parameters

    dataStoreParametersList
    []DataStoreParameters_STATUS_ARM

    DataStoreParametersList: Gets or sets the DataStore Parameters

    ProtectionStatusDetails_STATUS

    (Appears on:BackupInstance_STATUS)

    Protection status details

    Field Description
    errorDetails
    UserFacingError_STATUS

    ErrorDetails: Specifies the protection status error of the resource

    status
    ProtectionStatusDetails_Status_STATUS

    Status: Specifies the protection status of the resource

    ProtectionStatusDetails_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM)

    Protection status details

    Field Description
    errorDetails
    UserFacingError_STATUS_ARM

    ErrorDetails: Specifies the protection status error of the resource

    status
    ProtectionStatusDetails_Status_STATUS_ARM

    Status: Specifies the protection status of the resource

    ProtectionStatusDetails_Status_STATUS (string alias)

    (Appears on:ProtectionStatusDetails_STATUS)

    Value Description

    "ConfiguringProtection"

    "ConfiguringProtectionFailed"

    "ProtectionConfigured"

    "ProtectionStopped"

    "SoftDeleted"

    "SoftDeleting"

    ProtectionStatusDetails_Status_STATUS_ARM (string alias)

    (Appears on:ProtectionStatusDetails_STATUS_ARM)

    Value Description

    "ConfiguringProtection"

    "ConfiguringProtectionFailed"

    "ProtectionConfigured"

    "ProtectionStopped"

    "SoftDeleted"

    "SoftDeleting"

    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

    ResourceMoveDetails_STATUS_ARM

    (Appears on:BackupVault_STATUS_ARM)

    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_ARM

    (Appears on:AdhocBasedTaggingCriteria_ARM, TaggingCriteria_ARM)

    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.

    RetentionTag_STATUS_ARM

    (Appears on:AdhocBasedTaggingCriteria_STATUS_ARM, TaggingCriteria_STATUS_ARM)

    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_ARM

    (Appears on:BackupCriteria_ARM)

    Field Description
    absoluteCriteria
    []ScheduleBasedBackupCriteria_AbsoluteCriteria_ARM

    AbsoluteCriteria: it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum

    daysOfMonth
    []Day_ARM

    DaysOfMonth: This is day of the month from 1 to 28 other wise last of month

    daysOfTheWeek
    []ScheduleBasedBackupCriteria_DaysOfTheWeek_ARM

    DaysOfTheWeek: It should be Sunday/Monday/T…./Saturday

    monthsOfYear
    []ScheduleBasedBackupCriteria_MonthsOfYear_ARM

    MonthsOfYear: It should be January/February/……/December

    objectType
    ScheduleBasedBackupCriteria_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    scheduleTimes
    []string

    ScheduleTimes: List of schedule times for backup

    weeksOfTheMonth
    []ScheduleBasedBackupCriteria_WeeksOfTheMonth_ARM

    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_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    Value Description

    "AllBackup"

    "FirstOfDay"

    "FirstOfMonth"

    "FirstOfWeek"

    "FirstOfYear"

    ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS)

    Value Description

    "AllBackup"

    "FirstOfDay"

    "FirstOfMonth"

    "FirstOfWeek"

    "FirstOfYear"

    ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    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_DaysOfTheWeek_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    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_MonthsOfYear_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    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_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    Value Description

    "ScheduleBasedBackupCriteria"

    ScheduleBasedBackupCriteria_ObjectType_STATUS (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS)

    Value Description

    "ScheduleBasedBackupCriteria"

    ScheduleBasedBackupCriteria_ObjectType_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    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_STATUS_ARM

    (Appears on:BackupCriteria_STATUS_ARM)

    Field Description
    absoluteCriteria
    []ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS_ARM

    AbsoluteCriteria: it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum

    daysOfMonth
    []Day_STATUS_ARM

    DaysOfMonth: This is day of the month from 1 to 28 other wise last of month

    daysOfTheWeek
    []ScheduleBasedBackupCriteria_DaysOfTheWeek_STATUS_ARM

    DaysOfTheWeek: It should be Sunday/Monday/T…./Saturday

    monthsOfYear
    []ScheduleBasedBackupCriteria_MonthsOfYear_STATUS_ARM

    MonthsOfYear: It should be January/February/……/December

    objectType
    ScheduleBasedBackupCriteria_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    scheduleTimes
    []string

    ScheduleTimes: List of schedule times for backup

    weeksOfTheMonth
    []ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS_ARM

    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_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_ARM)

    Value Description

    "First"

    "Fourth"

    "Last"

    "Second"

    "Third"

    ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS)

    Value Description

    "First"

    "Fourth"

    "Last"

    "Second"

    "Third"

    ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedBackupCriteria_STATUS_ARM)

    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_ARM

    (Appears on:TriggerContext_ARM)

    Field Description
    objectType
    ScheduleBasedTriggerContext_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    schedule
    BackupSchedule_ARM

    Schedule: Schedule for this backup

    taggingCriteria
    []TaggingCriteria_ARM

    TaggingCriteria: List of tags that can be applicable for given schedule.

    ScheduleBasedTriggerContext_ObjectType (string alias)

    (Appears on:ScheduleBasedTriggerContext)

    Value Description

    "ScheduleBasedTriggerContext"

    ScheduleBasedTriggerContext_ObjectType_ARM (string alias)

    (Appears on:ScheduleBasedTriggerContext_ARM)

    Value Description

    "ScheduleBasedTriggerContext"

    ScheduleBasedTriggerContext_ObjectType_STATUS (string alias)

    (Appears on:ScheduleBasedTriggerContext_STATUS)

    Value Description

    "ScheduleBasedTriggerContext"

    ScheduleBasedTriggerContext_ObjectType_STATUS_ARM (string alias)

    (Appears on:ScheduleBasedTriggerContext_STATUS_ARM)

    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.

    ScheduleBasedTriggerContext_STATUS_ARM

    (Appears on:TriggerContext_STATUS_ARM)

    Field Description
    objectType
    ScheduleBasedTriggerContext_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    schedule
    BackupSchedule_STATUS_ARM

    Schedule: Schedule for this backup

    taggingCriteria
    []TaggingCriteria_STATUS_ARM

    TaggingCriteria: List of tags that can be applicable for given schedule.

    SecretStoreBasedAuthCredentials

    (Appears on:AuthCredentials)

    Field Description
    objectType
    SecretStoreBasedAuthCredentials_ObjectType

    ObjectType: Type of the specific object - used for deserializing

    secretStoreResource
    SecretStoreResource

    SecretStoreResource: Secret store resource

    SecretStoreBasedAuthCredentials_ARM

    (Appears on:AuthCredentials_ARM)

    Field Description
    objectType
    SecretStoreBasedAuthCredentials_ObjectType_ARM

    ObjectType: Type of the specific object - used for deserializing

    secretStoreResource
    SecretStoreResource_ARM

    SecretStoreResource: Secret store resource

    SecretStoreBasedAuthCredentials_ObjectType (string alias)

    (Appears on:SecretStoreBasedAuthCredentials)

    Value Description

    "SecretStoreBasedAuthCredentials"

    SecretStoreBasedAuthCredentials_ObjectType_ARM (string alias)

    (Appears on:SecretStoreBasedAuthCredentials_ARM)

    Value Description

    "SecretStoreBasedAuthCredentials"

    SecretStoreBasedAuthCredentials_ObjectType_STATUS (string alias)

    (Appears on:SecretStoreBasedAuthCredentials_STATUS)

    Value Description

    "SecretStoreBasedAuthCredentials"

    SecretStoreBasedAuthCredentials_ObjectType_STATUS_ARM (string alias)

    (Appears on:SecretStoreBasedAuthCredentials_STATUS_ARM)

    Value Description

    "SecretStoreBasedAuthCredentials"

    SecretStoreBasedAuthCredentials_STATUS

    (Appears on:AuthCredentials_STATUS)

    Field Description
    objectType
    SecretStoreBasedAuthCredentials_ObjectType_STATUS

    ObjectType: Type of the specific object - used for deserializing

    secretStoreResource
    SecretStoreResource_STATUS

    SecretStoreResource: Secret store resource

    SecretStoreBasedAuthCredentials_STATUS_ARM

    (Appears on:AuthCredentials_STATUS_ARM)

    Field Description
    objectType
    SecretStoreBasedAuthCredentials_ObjectType_STATUS_ARM

    ObjectType: Type of the specific object - used for deserializing

    secretStoreResource
    SecretStoreResource_STATUS_ARM

    SecretStoreResource: Secret store resource

    SecretStoreResource

    (Appears on:SecretStoreBasedAuthCredentials)

    Class representing a secret store resource.

    Field Description
    secretStoreType
    SecretStoreResource_SecretStoreType

    SecretStoreType: Gets or sets the type of secret store

    uri
    string

    Uri: Uri to get to the resource

    value
    string

    Value: Gets or sets value stored in secret store resource

    SecretStoreResource_ARM

    (Appears on:SecretStoreBasedAuthCredentials_ARM)

    Class representing a secret store resource.

    Field Description
    secretStoreType
    SecretStoreResource_SecretStoreType_ARM

    SecretStoreType: Gets or sets the type of secret store

    uri
    string

    Uri: Uri to get to the resource

    value
    string

    Value: Gets or sets value stored in secret store resource

    SecretStoreResource_STATUS

    (Appears on:SecretStoreBasedAuthCredentials_STATUS)

    Class representing a secret store resource.

    Field Description
    secretStoreType
    SecretStoreResource_SecretStoreType_STATUS

    SecretStoreType: Gets or sets the type of secret store

    uri
    string

    Uri: Uri to get to the resource

    value
    string

    Value: Gets or sets value stored in secret store resource

    SecretStoreResource_STATUS_ARM

    (Appears on:SecretStoreBasedAuthCredentials_STATUS_ARM)

    Class representing a secret store resource.

    Field Description
    secretStoreType
    SecretStoreResource_SecretStoreType_STATUS_ARM

    SecretStoreType: Gets or sets the type of secret store

    uri
    string

    Uri: Uri to get to the resource

    value
    string

    Value: Gets or sets value stored in secret store resource

    SecretStoreResource_SecretStoreType (string alias)

    (Appears on:SecretStoreResource)

    Value Description

    "AzureKeyVault"

    "Invalid"

    SecretStoreResource_SecretStoreType_ARM (string alias)

    (Appears on:SecretStoreResource_ARM)

    Value Description

    "AzureKeyVault"

    "Invalid"

    SecretStoreResource_SecretStoreType_STATUS (string alias)

    (Appears on:SecretStoreResource_STATUS)

    Value Description

    "AzureKeyVault"

    "Invalid"

    SecretStoreResource_SecretStoreType_STATUS_ARM (string alias)

    (Appears on:SecretStoreResource_STATUS_ARM)

    Value Description

    "AzureKeyVault"

    "Invalid"

    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_ARM

    (Appears on:BackupVaultSpec_ARM)

    Class containing security settings of vault

    Field Description
    immutabilitySettings
    ImmutabilitySettings_ARM

    ImmutabilitySettings: Immutability Settings at vault level

    softDeleteSettings
    SoftDeleteSettings_ARM

    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

    SecuritySettings_STATUS_ARM

    (Appears on:BackupVault_STATUS_ARM)

    Class containing security settings of vault

    Field Description
    immutabilitySettings
    ImmutabilitySettings_STATUS_ARM

    ImmutabilitySettings: Immutability Settings at vault level

    softDeleteSettings
    SoftDeleteSettings_STATUS_ARM

    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_ARM

    (Appears on:SecuritySettings_ARM)

    Soft delete related settings

    Field Description
    retentionDurationInDays
    float64

    RetentionDurationInDays: Soft delete retention duration

    state
    SoftDeleteSettings_State_ARM

    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_STATUS_ARM

    (Appears on:SecuritySettings_STATUS_ARM)

    Soft delete related settings

    Field Description
    retentionDurationInDays
    float64

    RetentionDurationInDays: Soft delete retention duration

    state
    SoftDeleteSettings_State_STATUS_ARM

    State: State of soft delete

    SoftDeleteSettings_State (string alias)

    (Appears on:SoftDeleteSettings)

    Value Description

    "AlwaysOn"

    "Off"

    "On"

    SoftDeleteSettings_State_ARM (string alias)

    (Appears on:SoftDeleteSettings_ARM)

    Value Description

    "AlwaysOn"

    "Off"

    "On"

    SoftDeleteSettings_State_STATUS (string alias)

    (Appears on:SoftDeleteSettings_STATUS)

    Value Description

    "AlwaysOn"

    "Off"

    "On"

    SoftDeleteSettings_State_STATUS_ARM (string alias)

    (Appears on:SoftDeleteSettings_STATUS_ARM)

    Value Description

    "AlwaysOn"

    "Off"

    "On"

    SourceLifeCycle

    (Appears on:AzureRetentionRule)

    Source LifeCycle

    Field Description
    deleteAfter
    DeleteOption
    sourceDataStore
    DataStoreInfoBase

    SourceDataStore: DataStoreInfo base

    targetDataStoreCopySettings
    []TargetCopySetting

    SourceLifeCycle_ARM

    (Appears on:AzureRetentionRule_ARM)

    Source LifeCycle

    Field Description
    deleteAfter
    DeleteOption_ARM
    sourceDataStore
    DataStoreInfoBase_ARM

    SourceDataStore: DataStoreInfo base

    targetDataStoreCopySettings
    []TargetCopySetting_ARM

    SourceLifeCycle_STATUS

    (Appears on:AzureRetentionRule_STATUS)

    Source LifeCycle

    Field Description
    deleteAfter
    DeleteOption_STATUS
    sourceDataStore
    DataStoreInfoBase_STATUS

    SourceDataStore: DataStoreInfo base

    targetDataStoreCopySettings
    []TargetCopySetting_STATUS

    SourceLifeCycle_STATUS_ARM

    (Appears on:AzureRetentionRule_STATUS_ARM)

    Source LifeCycle

    Field Description
    deleteAfter
    DeleteOption_STATUS_ARM
    sourceDataStore
    DataStoreInfoBase_STATUS_ARM

    SourceDataStore: DataStoreInfo base

    targetDataStoreCopySettings
    []TargetCopySetting_STATUS_ARM

    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_ARM

    (Appears on:BackupVaultSpec_ARM)

    Storage setting

    Field Description
    datastoreType
    StorageSetting_DatastoreType_ARM

    DatastoreType: Gets or sets the type of the datastore.

    type
    StorageSetting_Type_ARM

    Type: Gets or sets the type.

    StorageSetting_DatastoreType (string alias)

    (Appears on:StorageSetting)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    StorageSetting_DatastoreType_ARM (string alias)

    (Appears on:StorageSetting_ARM)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    StorageSetting_DatastoreType_STATUS (string alias)

    (Appears on:StorageSetting_STATUS)

    Value Description

    "ArchiveStore"

    "OperationalStore"

    "VaultStore"

    StorageSetting_DatastoreType_STATUS_ARM (string alias)

    (Appears on:StorageSetting_STATUS_ARM)

    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_STATUS_ARM

    (Appears on:BackupVault_STATUS_ARM)

    Storage setting

    Field Description
    datastoreType
    StorageSetting_DatastoreType_STATUS_ARM

    DatastoreType: Gets or sets the type of the datastore.

    type
    StorageSetting_Type_STATUS_ARM

    Type: Gets or sets the type.

    StorageSetting_Type (string alias)

    (Appears on:StorageSetting)

    Value Description

    "GeoRedundant"

    "LocallyRedundant"

    "ZoneRedundant"

    StorageSetting_Type_ARM (string alias)

    (Appears on:StorageSetting_ARM)

    Value Description

    "GeoRedundant"

    "LocallyRedundant"

    "ZoneRedundant"

    StorageSetting_Type_STATUS (string alias)

    (Appears on:StorageSetting_STATUS)

    Value Description

    "GeoRedundant"

    "LocallyRedundant"

    "ZoneRedundant"

    StorageSetting_Type_STATUS_ARM (string alias)

    (Appears on:StorageSetting_STATUS_ARM)

    Value Description

    "GeoRedundant"

    "LocallyRedundant"

    "ZoneRedundant"

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:BackupVaultResource_STATUS, BackupVaults_BackupInstance_STATUS, BackupVaults_BackupPolicy_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.

    SystemData_STATUS_ARM

    (Appears on:BackupVaultResource_STATUS_ARM, BackupVaults_BackupInstance_STATUS_ARM, BackupVaults_BackupPolicy_STATUS_ARM)

    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_ARM

    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_ARM

    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_ARM

    (Appears on:ScheduleBasedTriggerContext_ARM)

    Tagging criteria

    Field Description
    criteria
    []BackupCriteria_ARM

    Criteria: Criteria which decides whether the tag can be applied to a triggered backup.

    isDefault
    bool

    IsDefault: Specifies if tag is default.

    tagInfo
    RetentionTag_ARM

    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.

    TaggingCriteria_STATUS_ARM

    (Appears on:ScheduleBasedTriggerContext_STATUS_ARM)

    Tagging criteria

    Field Description
    criteria
    []BackupCriteria_STATUS_ARM

    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_ARM

    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_ARM

    (Appears on:SourceLifeCycle_ARM)

    Target copy settings

    Field Description
    copyAfter
    CopyOption_ARM

    CopyAfter: It can be CustomCopyOption or ImmediateCopyOption.

    dataStore
    DataStoreInfoBase_ARM

    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

    TargetCopySetting_STATUS_ARM

    (Appears on:SourceLifeCycle_STATUS_ARM)

    Target copy settings

    Field Description
    copyAfter
    CopyOption_STATUS_ARM

    CopyAfter: It can be CustomCopyOption or ImmediateCopyOption.

    dataStore
    DataStoreInfoBase_STATUS_ARM

    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_ARM

    (Appears on:AzureBackupRule_ARM)

    Field Description
    adhocBasedTriggerContext
    AdhocBasedTriggerContext_ARM

    Adhoc: Mutually exclusive with all other properties

    scheduleBasedTriggerContext
    ScheduleBasedTriggerContext_ARM

    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

    TriggerContext_STATUS_ARM

    (Appears on:AzureBackupRule_STATUS_ARM)

    Field Description
    adhocBasedTriggerContext
    AdhocBasedTriggerContext_STATUS_ARM

    Adhoc: Mutually exclusive with all other properties

    scheduleBasedTriggerContext
    ScheduleBasedTriggerContext_STATUS_ARM

    Schedule: Mutually exclusive with all other properties

    UserAssignedIdentityDetails

    (Appears on:DppIdentityDetails)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:DppIdentityDetails_ARM)

    Information about the user assigned identity for the resource

    UserAssignedIdentity_STATUS

    (Appears on:DppIdentityDetails_STATUS)

    User assigned identity properties

    Field Description
    clientId
    string

    ClientId: The client ID of the assigned identity.

    principalId
    string

    PrincipalId: The principal ID of the assigned identity.

    UserAssignedIdentity_STATUS_ARM

    (Appears on:DppIdentityDetails_STATUS_ARM)

    User assigned identity properties

    Field Description
    clientId
    string

    ClientId: The client ID of the assigned identity.

    principalId
    string

    PrincipalId: The principal ID of the assigned identity.

    UserFacingError_STATUS

    (Appears on:BackupInstance_STATUS, ProtectionStatusDetails_STATUS)

    Error object used by layers that have access to localized content, and propagate that to user

    Field Description
    code
    string

    Code: Unique code for this error

    details
    []UserFacingError_STATUS_Unrolled

    Details: Additional related Errors

    innerError
    InnerError_STATUS

    InnerError: Inner Error

    isRetryable
    bool

    IsRetryable: Whether the operation will be retryable or not

    isUserError
    bool

    IsUserError: Whether the operation is due to a user error or service error

    message
    string
    properties
    map[string]string

    Properties: Any key value pairs that can be injected inside error object

    recommendedAction
    []string

    RecommendedAction: RecommendedAction � localized.

    target
    string

    Target: Target of the error.

    UserFacingError_STATUS_ARM

    (Appears on:BackupInstance_STATUS_ARM, ProtectionStatusDetails_STATUS_ARM)

    Error object used by layers that have access to localized content, and propagate that to user

    Field Description
    code
    string

    Code: Unique code for this error

    details
    []UserFacingError_STATUS_Unrolled_ARM

    Details: Additional related Errors

    innerError
    InnerError_STATUS_ARM

    InnerError: Inner Error

    isRetryable
    bool

    IsRetryable: Whether the operation will be retryable or not

    isUserError
    bool

    IsUserError: Whether the operation is due to a user error or service error

    message
    string
    properties
    map[string]string

    Properties: Any key value pairs that can be injected inside error object

    recommendedAction
    []string

    RecommendedAction: RecommendedAction � localized.

    target
    string

    Target: Target of the error.

    UserFacingError_STATUS_Unrolled

    (Appears on:UserFacingError_STATUS)

    Field Description
    code
    string

    Code: Unique code for this error

    innerError
    InnerError_STATUS

    InnerError: Inner Error

    isRetryable
    bool

    IsRetryable: Whether the operation will be retryable or not

    isUserError
    bool

    IsUserError: Whether the operation is due to a user error or service error

    message
    string
    properties
    map[string]string

    Properties: Any key value pairs that can be injected inside error object

    recommendedAction
    []string

    RecommendedAction: RecommendedAction � localized.

    target
    string

    Target: Target of the error.

    UserFacingError_STATUS_Unrolled_ARM

    (Appears on:UserFacingError_STATUS_ARM)

    Field Description
    code
    string

    Code: Unique code for this error

    innerError
    InnerError_STATUS_ARM

    InnerError: Inner Error

    isRetryable
    bool

    IsRetryable: Whether the operation will be retryable or not

    isUserError
    bool

    IsUserError: Whether the operation is due to a user error or service error

    message
    string
    properties
    map[string]string

    Properties: Any key value pairs that can be injected inside error object

    recommendedAction
    []string

    RecommendedAction: RecommendedAction � localized.

    target
    string

    Target: Target of the error.