dataprotection.azure.com/v1api20231101
APIVersion
| Value | Description |
|---|---|
| “2023-11-01” |
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}
Used by: BackupVaultList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | BackupVault_Spec Optional |
|
| status | BackupVaultResource_STATUS Optional |
BackupVault_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| identity | Input Managed Identity Details | DppIdentityDetails Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BackupVaultResource properties | BackupVaultSpec Required |
| tags | Resource tags. | map[string]string Optional |
BackupVaultResource_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| eTag | Optional ETag. | string Optional |
| id | Resource Id represents the complete path to the resource. | string Optional |
| identity | Input Managed Identity Details | DppIdentityDetails_STATUS Optional |
| location | Resource location. | string Optional |
| name | Resource name associated with the resource. | string Optional |
| properties | BackupVaultResource properties | BackupVault_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupVaultList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | BackupVault[] Optional |
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}
Used by: BackupVaultsBackupInstanceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | BackupVaultsBackupInstance_Spec Optional |
|
| status | BackupVaultsBackupInstance_STATUS Optional |
BackupVaultsBackupInstance_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultsBackupInstanceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BackupInstanceResource properties | BackupInstance Optional |
| tags | Proxy Resource tags. | map[string]string Optional |
BackupVaultsBackupInstance_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Proxy Resource Id represents the complete path to the resource. | string Optional |
| name | Proxy Resource name associated with the resource. | string Optional |
| properties | BackupInstanceResource properties | BackupInstance_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Proxy Resource tags. | map[string]string Optional |
| type | Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupVaultsBackupInstanceList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | BackupVaultsBackupInstance[] Optional |
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}
Used by: BackupVaultsBackupPolicyList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | BackupVaultsBackupPolicy_Spec Optional |
|
| status | BackupVaultsBackupPolicy_STATUS Optional |
BackupVaultsBackupPolicy_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultsBackupPolicyOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BaseBackupPolicyResource properties | BaseBackupPolicy Optional |
BackupVaultsBackupPolicy_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Resource Id represents the complete path to the resource. | string Optional |
| name | Resource name associated with the resource. | string Optional |
| properties | BaseBackupPolicyResource properties | BaseBackupPolicy_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| type | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupVaultsBackupPolicyList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | BackupVaultsBackupPolicy[] Optional |
BackupVault_Spec
Used by: BackupVault.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| identity | Input Managed Identity Details | DppIdentityDetails Optional |
| location | Resource location. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BackupVaultResource properties | BackupVaultSpec Required |
| tags | Resource tags. | map[string]string Optional |
BackupVaultResource_STATUS
Backup Vault Resource
Used by: BackupVault.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| eTag | Optional ETag. | string Optional |
| id | Resource Id represents the complete path to the resource. | string Optional |
| identity | Input Managed Identity Details | DppIdentityDetails_STATUS Optional |
| location | Resource location. | string Optional |
| name | Resource name associated with the resource. | string Optional |
| properties | BackupVaultResource properties | BackupVault_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupVaultsBackupInstance_Spec
Used by: BackupVaultsBackupInstance.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultsBackupInstanceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BackupInstanceResource properties | BackupInstance Optional |
| tags | Proxy Resource tags. | map[string]string Optional |
BackupVaultsBackupInstance_STATUS
Used by: BackupVaultsBackupInstance.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Proxy Resource Id represents the complete path to the resource. | string Optional |
| name | Proxy Resource name associated with the resource. | string Optional |
| properties | BackupInstanceResource properties | BackupInstance_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Proxy Resource tags. | map[string]string Optional |
| type | Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupVaultsBackupPolicy_Spec
Used by: BackupVaultsBackupPolicy.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | BackupVaultsBackupPolicyOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| properties | BaseBackupPolicyResource properties | BaseBackupPolicy Optional |
BackupVaultsBackupPolicy_STATUS
Used by: BackupVaultsBackupPolicy.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | Resource Id represents the complete path to the resource. | string Optional |
| name | Resource name associated with the resource. | string Optional |
| properties | BaseBackupPolicyResource properties | BaseBackupPolicy_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| type | Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/… | string Optional |
BackupInstance
Backup Instance
Used by: BackupVaultsBackupInstance_Spec.
| Property | Description | Type |
|---|---|---|
| datasourceAuthCredentials | Credentials to use to authenticate with data source provider. | AuthCredentials Optional |
| dataSourceInfo | Gets or sets the data source information. | Datasource Required |
| dataSourceSetInfo | Gets or sets the data source set information. | DatasourceSet Optional |
| friendlyName | Gets or sets the Backup Instance friendly name. | string Optional |
| identityDetails | Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. | IdentityDetails Optional |
| objectType | string Required |
|
| policyInfo | Gets or sets the policy information. | PolicyInfo Required |
| validationType | Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. | BackupInstance_ValidationType Optional |
BackupInstance_STATUS
Backup Instance
Used by: BackupVaultsBackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| currentProtectionState | Specifies the current protection state of the resource | BackupInstance_CurrentProtectionState_STATUS Optional |
| datasourceAuthCredentials | Credentials to use to authenticate with data source provider. | AuthCredentials_STATUS Optional |
| dataSourceInfo | Gets or sets the data source information. | Datasource_STATUS Optional |
| dataSourceSetInfo | Gets or sets the data source set information. | DatasourceSet_STATUS Optional |
| friendlyName | Gets or sets the Backup Instance friendly name. | string Optional |
| identityDetails | Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned. | IdentityDetails_STATUS Optional |
| objectType | string Optional |
|
| policyInfo | Gets or sets the policy information. | PolicyInfo_STATUS Optional |
| protectionErrorDetails | Specifies the protection error of the resource | UserFacingError_STATUS Optional |
| protectionStatus | Specifies the protection status of the resource | ProtectionStatusDetails_STATUS Optional |
| provisioningState | Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed | string Optional |
| validationType | Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. | BackupInstance_ValidationType_STATUS Optional |
BackupVault_STATUS
Backup Vault
Used by: BackupVaultResource_STATUS.
| Property | Description | Type |
|---|---|---|
| featureSettings | Feature Settings | FeatureSettings_STATUS Optional |
| isVaultProtectedByResourceGuard | Is vault protected by resource guard | bool Optional |
| monitoringSettings | Monitoring Settings | MonitoringSettings_STATUS Optional |
| provisioningState | Provisioning state of the BackupVault resource | BackupVault_ProvisioningState_STATUS Optional |
| replicatedRegions | List of replicated regions for Backup Vault | string[] Optional |
| resourceMoveDetails | Resource move details for backup vault | ResourceMoveDetails_STATUS Optional |
| resourceMoveState | Resource move state for backup vault | BackupVault_ResourceMoveState_STATUS Optional |
| secureScore | Secure Score of Backup Vault | BackupVault_SecureScore_STATUS Optional |
| securitySettings | Security Settings | SecuritySettings_STATUS Optional |
| storageSettings | Storage Settings | StorageSetting_STATUS[] Optional |
BackupVaultOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: BackupVault_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| configMaps | configures where to place operator written ConfigMaps. | BackupVaultOperatorConfigMaps Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
BackupVaultsBackupInstanceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: BackupVaultsBackupInstance_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
BackupVaultsBackupPolicyOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: BackupVaultsBackupPolicy_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
BackupVaultSpec
Backup Vault
Used by: BackupVault_Spec.
| Property | Description | Type |
|---|---|---|
| featureSettings | Feature Settings | FeatureSettings Optional |
| monitoringSettings | Monitoring Settings | MonitoringSettings Optional |
| replicatedRegions | List of replicated regions for Backup Vault | string[] Optional |
| securitySettings | Security Settings | SecuritySettings Optional |
| storageSettings | Storage Settings | StorageSetting[] Required |
BaseBackupPolicy
Used by: BackupVaultsBackupPolicy_Spec.
| Property | Description | Type |
|---|---|---|
| backupPolicy | Mutually exclusive with all other properties | BackupPolicy Optional |
BaseBackupPolicy_STATUS
Used by: BackupVaultsBackupPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| backupPolicy | Mutually exclusive with all other properties | BackupPolicy_STATUS Optional |
DppIdentityDetails
Identity details
Used by: BackupVault_Spec.
| Property | Description | Type |
|---|---|---|
| type | The identityType which can be either SystemAssigned, UserAssigned, ‘SystemAssigned,UserAssigned’ or None | string Optional |
| userAssignedIdentities | Gets or sets the user assigned identities. | UserAssignedIdentityDetails[] Optional |
DppIdentityDetails_STATUS
Identity details
Used by: BackupVaultResource_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| tenantId | A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. | string Optional |
| type | The identityType which can be either SystemAssigned, UserAssigned, ‘SystemAssigned,UserAssigned’ or None | string Optional |
| userAssignedIdentities | Gets or sets the user assigned identities. | map[string]UserAssignedIdentity_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: BackupVaultResource_STATUS, BackupVaultsBackupInstance_STATUS, and BackupVaultsBackupPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
AuthCredentials
Used by: BackupInstance.
| Property | Description | Type |
|---|---|---|
| secretStoreBasedAuthCredentials | Mutually exclusive with all other properties | SecretStoreBasedAuthCredentials Optional |
AuthCredentials_STATUS
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| secretStoreBasedAuthCredentials | Mutually exclusive with all other properties | SecretStoreBasedAuthCredentials_STATUS Optional |
BackupInstance_CurrentProtectionState_STATUS
Used by: BackupInstance_STATUS.
| Value | Description |
|---|---|
| “BackupSchedulesSuspended” | |
| “ConfiguringProtection” | |
| “ConfiguringProtectionFailed” | |
| “Invalid” | |
| “NotProtected” | |
| “ProtectionConfigured” | |
| “ProtectionError” | |
| “ProtectionStopped” | |
| “RetentionSchedulesSuspended” | |
| “SoftDeleted” | |
| “SoftDeleting” | |
| “UpdatingProtection” |
BackupInstance_ValidationType
Used by: BackupInstance.
| Value | Description |
|---|---|
| “DeepValidation” | |
| “ShallowValidation” |
BackupInstance_ValidationType_STATUS
Used by: BackupInstance_STATUS.
| Value | Description |
|---|---|
| “DeepValidation” | |
| “ShallowValidation” |
BackupPolicy
Used by: BaseBackupPolicy.
| Property | Description | Type |
|---|---|---|
| datasourceTypes | Type of datasource for the backup management | string[] Required |
| objectType | BackupPolicy_ObjectType Required |
|
| policyRules | Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc | BasePolicyRule[] Required |
BackupPolicy_STATUS
Used by: BaseBackupPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| datasourceTypes | Type of datasource for the backup management | string[] Optional |
| objectType | BackupPolicy_ObjectType_STATUS Optional |
|
| policyRules | Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc | BasePolicyRule_STATUS[] Optional |
BackupVault_ProvisioningState_STATUS
Used by: BackupVault_STATUS.
| Value | Description |
|---|---|
| “Failed” | |
| “Provisioning” | |
| “Succeeded” | |
| “Unknown” | |
| “Updating” |
BackupVault_ResourceMoveState_STATUS
Used by: BackupVault_STATUS.
| Value | Description |
|---|---|
| “CommitFailed” | |
| “CommitTimedout” | |
| “CriticalFailure” | |
| “Failed” | |
| “InProgress” | |
| “MoveSucceeded” | |
| “PartialSuccess” | |
| “PrepareFailed” | |
| “PrepareTimedout” | |
| “Unknown” |
BackupVault_SecureScore_STATUS
Used by: BackupVault_STATUS.
| Value | Description |
|---|---|
| “Adequate” | |
| “Maximum” | |
| “Minimum” | |
| “None” | |
| “NotSupported” |
BackupVaultOperatorConfigMaps
Used by: BackupVaultOperatorSpec.
| Property | Description | Type |
|---|---|---|
| principalId | indicates where the PrincipalId config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
Datasource
Datasource to be backed up
Used by: BackupInstance.
| Property | Description | Type |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string Optional |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Optional |
| resourceLocation | Location of datasource. | string Optional |
| resourceName | Unique identifier of the resource in the context of parent. | string Optional |
| resourceProperties | Properties specific to data source | BaseResourceProperties Optional |
| 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. | genruntime.ResourceReference Required |
| resourceType | Resource Type of Datasource. | string Optional |
| resourceUri | Uri of the resource. | string Optional |
Datasource_STATUS
Datasource to be backed up
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string Optional |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Optional |
| 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. | string Optional |
| resourceLocation | Location of datasource. | string Optional |
| resourceName | Unique identifier of the resource in the context of parent. | string Optional |
| resourceProperties | Properties specific to data source | BaseResourceProperties_STATUS Optional |
| resourceType | Resource Type of Datasource. | string Optional |
| resourceUri | Uri of the resource. | string Optional |
DatasourceSet
DatasourceSet details of datasource to be backed up
Used by: BackupInstance.
| Property | Description | Type |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string Optional |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Optional |
| resourceLocation | Location of datasource. | string Optional |
| resourceName | Unique identifier of the resource in the context of parent. | string Optional |
| resourceProperties | Properties specific to data source set | BaseResourceProperties Optional |
| 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. | genruntime.ResourceReference Required |
| resourceType | Resource Type of Datasource. | string Optional |
| resourceUri | Uri of the resource. | string Optional |
DatasourceSet_STATUS
DatasourceSet details of datasource to be backed up
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| datasourceType | DatasourceType of the resource. | string Optional |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Optional |
| 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. | string Optional |
| resourceLocation | Location of datasource. | string Optional |
| resourceName | Unique identifier of the resource in the context of parent. | string Optional |
| resourceProperties | Properties specific to data source set | BaseResourceProperties_STATUS Optional |
| resourceType | Resource Type of Datasource. | string Optional |
| resourceUri | Uri of the resource. | string Optional |
FeatureSettings
Class containing feature settings of vault
Used by: BackupVaultSpec.
| Property | Description | Type |
|---|---|---|
| crossRegionRestoreSettings | CrossRegionRestoreSettings Optional |
|
| crossSubscriptionRestoreSettings | CrossSubscriptionRestore Settings | CrossSubscriptionRestoreSettings Optional |
FeatureSettings_STATUS
Class containing feature settings of vault
Used by: BackupVault_STATUS.
| Property | Description | Type |
|---|---|---|
| crossRegionRestoreSettings | CrossRegionRestoreSettings_STATUS Optional |
|
| crossSubscriptionRestoreSettings | CrossSubscriptionRestore Settings | CrossSubscriptionRestoreSettings_STATUS Optional |
IdentityDetails
Used by: BackupInstance.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityArmUrl | ARM URL for User Assigned Identity. | string Optional |
| useSystemAssignedIdentity | Specifies if the BI is protected by System Identity. | bool Optional |
IdentityDetails_STATUS
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityArmUrl | ARM URL for User Assigned Identity. | string Optional |
| useSystemAssignedIdentity | Specifies if the BI is protected by System Identity. | bool Optional |
MonitoringSettings
Monitoring Settings
Used by: BackupVaultSpec.
| Property | Description | Type |
|---|---|---|
| azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings Optional |
MonitoringSettings_STATUS
Monitoring Settings
Used by: BackupVault_STATUS.
| Property | Description | Type |
|---|---|---|
| azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings_STATUS Optional |
PolicyInfo
Policy Info in backupInstance
Used by: BackupInstance.
| Property | Description | Type |
|---|---|---|
| policyParameters | Policy parameters for the backup instance | PolicyParameters Optional |
| policyReference | genruntime.ResourceReference Required |
PolicyInfo_STATUS
Policy Info in backupInstance
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| policyId | string Optional |
|
| policyParameters | Policy parameters for the backup instance | PolicyParameters_STATUS Optional |
| policyVersion | string Optional |
ProtectionStatusDetails_STATUS
Protection status details
Used by: BackupInstance_STATUS.
| Property | Description | Type |
|---|---|---|
| errorDetails | Specifies the protection status error of the resource | UserFacingError_STATUS Optional |
| status | Specifies the protection status of the resource | ProtectionStatusDetails_Status_STATUS Optional |
ResourceMoveDetails_STATUS
ResourceMoveDetails will be returned in response to GetResource call from ARM
Used by: BackupVault_STATUS.
| Property | Description | Type |
|---|---|---|
| completionTimeUtc | Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. | string Optional |
| operationId | CorrelationId of latest ResourceMove operation attempted | string Optional |
| sourceResourcePath | ARM resource path of source resource | string Optional |
| startTimeUtc | Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. | string Optional |
| targetResourcePath | ARM resource path of target resource used in latest ResourceMove operation | string Optional |
SecuritySettings
Class containing security settings of vault
Used by: BackupVaultSpec.
| Property | Description | Type |
|---|---|---|
| immutabilitySettings | Immutability Settings at vault level | ImmutabilitySettings Optional |
| softDeleteSettings | Soft delete related settings | SoftDeleteSettings Optional |
SecuritySettings_STATUS
Class containing security settings of vault
Used by: BackupVault_STATUS.
| Property | Description | Type |
|---|---|---|
| immutabilitySettings | Immutability Settings at vault level | ImmutabilitySettings_STATUS Optional |
| softDeleteSettings | Soft delete related settings | SoftDeleteSettings_STATUS Optional |
StorageSetting
Storage setting
Used by: BackupVaultSpec.
| Property | Description | Type |
|---|---|---|
| datastoreType | Gets or sets the type of the datastore. | StorageSetting_DatastoreType Optional |
| type | Gets or sets the type. | StorageSetting_Type Optional |
StorageSetting_STATUS
Storage setting
Used by: BackupVault_STATUS.
| Property | Description | Type |
|---|---|---|
| datastoreType | Gets or sets the type of the datastore. | StorageSetting_DatastoreType_STATUS Optional |
| type | Gets or sets the type. | StorageSetting_Type_STATUS Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: DppIdentityDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: DppIdentityDetails.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserFacingError_STATUS
Error object used by layers that have access to localized content, and propagate that to user
Used by: BackupInstance_STATUS, and ProtectionStatusDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| code | Unique code for this error | string Optional |
| details | Additional related Errors | UserFacingError_STATUS_Unrolled[] Optional |
| innerError | Inner Error | InnerError_STATUS Optional |
| isRetryable | Whether the operation will be retryable or not | bool Optional |
| isUserError | Whether the operation is due to a user error or service error | bool Optional |
| message | string Optional |
|
| properties | Any key value pairs that can be injected inside error object | map[string]string Optional |
| recommendedAction | RecommendedAction � localized. | string[] Optional |
| target | Target of the error. | string Optional |
AzureMonitorAlertSettings
Settings for Azure Monitor based alerts
Used by: MonitoringSettings.
| Property | Description | Type |
|---|---|---|
| alertsForAllJobFailures | AzureMonitorAlertSettings_AlertsForAllJobFailures Optional |
AzureMonitorAlertSettings_STATUS
Settings for Azure Monitor based alerts
Used by: MonitoringSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| alertsForAllJobFailures | AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS Optional |
BackupPolicy_ObjectType
Used by: BackupPolicy.
| Value | Description |
|---|---|
| “BackupPolicy” |
BackupPolicy_ObjectType_STATUS
Used by: BackupPolicy_STATUS.
| Value | Description |
|---|---|
| “BackupPolicy” |
BasePolicyRule
Used by: BackupPolicy.
| Property | Description | Type |
|---|---|---|
| azureBackupRule | Mutually exclusive with all other properties | AzureBackupRule Optional |
| azureRetentionRule | Mutually exclusive with all other properties | AzureRetentionRule Optional |
BasePolicyRule_STATUS
Used by: BackupPolicy_STATUS.
| Property | Description | Type |
|---|---|---|
| azureBackupRule | Mutually exclusive with all other properties | AzureBackupRule_STATUS Optional |
| azureRetentionRule | Mutually exclusive with all other properties | AzureRetentionRule_STATUS Optional |
BaseResourceProperties
Used by: Datasource, and DatasourceSet.
| Property | Description | Type |
|---|---|---|
| defaultResourceProperties | Mutually exclusive with all other properties | DefaultResourceProperties Optional |
BaseResourceProperties_STATUS
Used by: Datasource_STATUS, and DatasourceSet_STATUS.
| Property | Description | Type |
|---|---|---|
| defaultResourceProperties | Mutually exclusive with all other properties | DefaultResourceProperties_STATUS Optional |
CrossRegionRestoreSettings
Used by: FeatureSettings.
| Property | Description | Type |
|---|---|---|
| state | CrossRegionRestore state | CrossRegionRestoreSettings_State Optional |
CrossRegionRestoreSettings_STATUS
Used by: FeatureSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| state | CrossRegionRestore state | CrossRegionRestoreSettings_State_STATUS Optional |
CrossSubscriptionRestoreSettings
CrossSubscriptionRestore Settings
Used by: FeatureSettings.
| Property | Description | Type |
|---|---|---|
| state | CrossSubscriptionRestore state | CrossSubscriptionRestoreSettings_State Optional |
CrossSubscriptionRestoreSettings_STATUS
CrossSubscriptionRestore Settings
Used by: FeatureSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| state | CrossSubscriptionRestore state | CrossSubscriptionRestoreSettings_State_STATUS Optional |
ImmutabilitySettings
Immutability Settings at vault level
Used by: SecuritySettings.
| Property | Description | Type |
|---|---|---|
| state | Immutability state | ImmutabilitySettings_State Optional |
ImmutabilitySettings_STATUS
Immutability Settings at vault level
Used by: SecuritySettings_STATUS.
| Property | Description | Type |
|---|---|---|
| state | Immutability state | ImmutabilitySettings_State_STATUS Optional |
InnerError_STATUS
Inner Error
Used by: UserFacingError_STATUS, and UserFacingError_STATUS_Unrolled.
| Property | Description | Type |
|---|---|---|
| additionalInfo | Any Key value pairs that can be provided to the client for additional verbose information. | map[string]string Optional |
| code | Unique code for this error | string Optional |
| embeddedInnerError | Child Inner Error, to allow Nesting. | InnerError_STATUS_Unrolled Optional |
PolicyParameters
Parameters in Policy
Used by: PolicyInfo.
| Property | Description | Type |
|---|---|---|
| backupDatasourceParametersList | Gets or sets the Backup Data Source Parameters | BackupDatasourceParameters[] Optional |
| dataStoreParametersList | Gets or sets the DataStore Parameters | DataStoreParameters[] Optional |
PolicyParameters_STATUS
Parameters in Policy
Used by: PolicyInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| backupDatasourceParametersList | Gets or sets the Backup Data Source Parameters | BackupDatasourceParameters_STATUS[] Optional |
| dataStoreParametersList | Gets or sets the DataStore Parameters | DataStoreParameters_STATUS[] Optional |
ProtectionStatusDetails_Status_STATUS
Used by: ProtectionStatusDetails_STATUS.
| Value | Description |
|---|---|
| “ConfiguringProtection” | |
| “ConfiguringProtectionFailed” | |
| “ProtectionConfigured” | |
| “ProtectionStopped” | |
| “SoftDeleted” | |
| “SoftDeleting” |
SecretStoreBasedAuthCredentials
Used by: AuthCredentials.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | SecretStoreBasedAuthCredentials_ObjectType Required |
| secretStoreResource | Secret store resource | SecretStoreResource Optional |
SecretStoreBasedAuthCredentials_STATUS
Used by: AuthCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | SecretStoreBasedAuthCredentials_ObjectType_STATUS Optional |
| secretStoreResource | Secret store resource | SecretStoreResource_STATUS Optional |
SoftDeleteSettings
Soft delete related settings
Used by: SecuritySettings.
| Property | Description | Type |
|---|---|---|
| retentionDurationInDays | Soft delete retention duration | float64 Optional |
| state | State of soft delete | SoftDeleteSettings_State Optional |
SoftDeleteSettings_STATUS
Soft delete related settings
Used by: SecuritySettings_STATUS.
| Property | Description | Type |
|---|---|---|
| retentionDurationInDays | Soft delete retention duration | float64 Optional |
| state | State of soft delete | SoftDeleteSettings_State_STATUS Optional |
StorageSetting_DatastoreType
Used by: StorageSetting.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
StorageSetting_DatastoreType_STATUS
Used by: StorageSetting_STATUS.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
StorageSetting_Type
Used by: StorageSetting.
| Value | Description |
|---|---|
| “GeoRedundant” | |
| “LocallyRedundant” | |
| “ZoneRedundant” |
StorageSetting_Type_STATUS
Used by: StorageSetting_STATUS.
| Value | Description |
|---|---|
| “GeoRedundant” | |
| “LocallyRedundant” | |
| “ZoneRedundant” |
UserFacingError_STATUS_Unrolled
Used by: UserFacingError_STATUS.
| Property | Description | Type |
|---|---|---|
| code | Unique code for this error | string Optional |
| innerError | Inner Error | InnerError_STATUS Optional |
| isRetryable | Whether the operation will be retryable or not | bool Optional |
| isUserError | Whether the operation is due to a user error or service error | bool Optional |
| message | string Optional |
|
| properties | Any key value pairs that can be injected inside error object | map[string]string Optional |
| recommendedAction | RecommendedAction � localized. | string[] Optional |
| target | Target of the error. | string Optional |
AzureBackupRule
Used by: BasePolicyRule.
| Property | Description | Type |
|---|---|---|
| backupParameters | BackupParameters Optional |
|
| dataStore | DataStoreInfo base | DataStoreInfoBase Required |
| name | string Required |
|
| objectType | AzureBackupRule_ObjectType Required |
|
| trigger | TriggerContext Required |
AzureBackupRule_STATUS
Used by: BasePolicyRule_STATUS.
| Property | Description | Type |
|---|---|---|
| backupParameters | BackupParameters_STATUS Optional |
|
| dataStore | DataStoreInfo base | DataStoreInfoBase_STATUS Optional |
| name | string Optional |
|
| objectType | AzureBackupRule_ObjectType_STATUS Optional |
|
| trigger | TriggerContext_STATUS Optional |
AzureMonitorAlertSettings_AlertsForAllJobFailures
Used by: AzureMonitorAlertSettings.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AzureMonitorAlertSettings_AlertsForAllJobFailures_STATUS
Used by: AzureMonitorAlertSettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
AzureRetentionRule
Used by: BasePolicyRule.
| Property | Description | Type |
|---|---|---|
| isDefault | bool Optional |
|
| lifecycles | SourceLifeCycle[] Required |
|
| name | string Required |
|
| objectType | AzureRetentionRule_ObjectType Required |
AzureRetentionRule_STATUS
Used by: BasePolicyRule_STATUS.
| Property | Description | Type |
|---|---|---|
| isDefault | bool Optional |
|
| lifecycles | SourceLifeCycle_STATUS[] Optional |
|
| name | string Optional |
|
| objectType | AzureRetentionRule_ObjectType_STATUS Optional |
BackupDatasourceParameters
Used by: PolicyParameters.
| Property | Description | Type |
|---|---|---|
| blobBackupDatasourceParameters | Mutually exclusive with all other properties | BlobBackupDatasourceParameters Optional |
| kubernetesClusterBackupDatasourceParameters | Mutually exclusive with all other properties | KubernetesClusterBackupDatasourceParameters Optional |
BackupDatasourceParameters_STATUS
Used by: PolicyParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| blobBackupDatasourceParameters | Mutually exclusive with all other properties | BlobBackupDatasourceParameters_STATUS Optional |
| kubernetesClusterBackupDatasourceParameters | Mutually exclusive with all other properties | KubernetesClusterBackupDatasourceParameters_STATUS Optional |
CrossRegionRestoreSettings_State
Used by: CrossRegionRestoreSettings.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
CrossRegionRestoreSettings_State_STATUS
Used by: CrossRegionRestoreSettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
CrossSubscriptionRestoreSettings_State
Used by: CrossSubscriptionRestoreSettings.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “PermanentlyDisabled” |
CrossSubscriptionRestoreSettings_State_STATUS
Used by: CrossSubscriptionRestoreSettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “PermanentlyDisabled” |
DataStoreParameters
Used by: PolicyParameters.
| Property | Description | Type |
|---|---|---|
| azureOperationalStoreParameters | Mutually exclusive with all other properties | AzureOperationalStoreParameters Optional |
DataStoreParameters_STATUS
Used by: PolicyParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| azureOperationalStoreParameters | Mutually exclusive with all other properties | AzureOperationalStoreParameters_STATUS Optional |
DefaultResourceProperties
Used by: BaseResourceProperties.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | DefaultResourceProperties_ObjectType Required |
DefaultResourceProperties_STATUS
Used by: BaseResourceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | DefaultResourceProperties_ObjectType_STATUS Optional |
ImmutabilitySettings_State
Used by: ImmutabilitySettings.
| Value | Description |
|---|---|
| “Disabled” | |
| “Locked” | |
| “Unlocked” |
ImmutabilitySettings_State_STATUS
Used by: ImmutabilitySettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Locked” | |
| “Unlocked” |
InnerError_STATUS_Unrolled
Used by: InnerError_STATUS.
| Property | Description | Type |
|---|---|---|
| additionalInfo | Any Key value pairs that can be provided to the client for additional verbose information. | map[string]string Optional |
| code | Unique code for this error | string Optional |
SecretStoreBasedAuthCredentials_ObjectType
Used by: SecretStoreBasedAuthCredentials.
| Value | Description |
|---|---|
| “SecretStoreBasedAuthCredentials” |
SecretStoreBasedAuthCredentials_ObjectType_STATUS
Used by: SecretStoreBasedAuthCredentials_STATUS.
| Value | Description |
|---|---|
| “SecretStoreBasedAuthCredentials” |
SecretStoreResource
Class representing a secret store resource.
Used by: SecretStoreBasedAuthCredentials.
| Property | Description | Type |
|---|---|---|
| secretStoreType | Gets or sets the type of secret store | SecretStoreResource_SecretStoreType Required |
| uri | Uri to get to the resource | string Optional |
| value | Gets or sets value stored in secret store resource | string Optional |
SecretStoreResource_STATUS
Class representing a secret store resource.
Used by: SecretStoreBasedAuthCredentials_STATUS.
| Property | Description | Type |
|---|---|---|
| secretStoreType | Gets or sets the type of secret store | SecretStoreResource_SecretStoreType_STATUS Optional |
| uri | Uri to get to the resource | string Optional |
| value | Gets or sets value stored in secret store resource | string Optional |
SoftDeleteSettings_State
Used by: SoftDeleteSettings.
| Value | Description |
|---|---|
| “AlwaysOn” | |
| “Off” | |
| “On” |
SoftDeleteSettings_State_STATUS
Used by: SoftDeleteSettings_STATUS.
| Value | Description |
|---|---|
| “AlwaysOn” | |
| “Off” | |
| “On” |
AzureBackupRule_ObjectType
Used by: AzureBackupRule.
| Value | Description |
|---|---|
| “AzureBackupRule” |
AzureBackupRule_ObjectType_STATUS
Used by: AzureBackupRule_STATUS.
| Value | Description |
|---|---|
| “AzureBackupRule” |
AzureOperationalStoreParameters
Used by: DataStoreParameters.
| Property | Description | Type |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | AzureOperationalStoreParameters_DataStoreType Required |
| objectType | Type of the specific object - used for deserializing | AzureOperationalStoreParameters_ObjectType Required |
| resourceGroupReference | Gets or sets the Snapshot Resource Group Uri. | genruntime.ResourceReference Optional |
AzureOperationalStoreParameters_STATUS
Used by: DataStoreParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | AzureOperationalStoreParameters_DataStoreType_STATUS Optional |
| objectType | Type of the specific object - used for deserializing | AzureOperationalStoreParameters_ObjectType_STATUS Optional |
| resourceGroupId | Gets or sets the Snapshot Resource Group Uri. | string Optional |
AzureRetentionRule_ObjectType
Used by: AzureRetentionRule.
| Value | Description |
|---|---|
| “AzureRetentionRule” |
AzureRetentionRule_ObjectType_STATUS
Used by: AzureRetentionRule_STATUS.
| Value | Description |
|---|---|
| “AzureRetentionRule” |
BackupParameters
Used by: AzureBackupRule.
| Property | Description | Type |
|---|---|---|
| azureBackupParams | Mutually exclusive with all other properties | AzureBackupParams Optional |
BackupParameters_STATUS
Used by: AzureBackupRule_STATUS.
| Property | Description | Type |
|---|---|---|
| azureBackupParams | Mutually exclusive with all other properties | AzureBackupParams_STATUS Optional |
BlobBackupDatasourceParameters
Used by: BackupDatasourceParameters.
| Property | Description | Type |
|---|---|---|
| containersList | List of containers to be backed up during configuration of backup of blobs | string[] Required |
| objectType | Type of the specific object - used for deserializing | BlobBackupDatasourceParameters_ObjectType Required |
BlobBackupDatasourceParameters_STATUS
Used by: BackupDatasourceParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| containersList | List of containers to be backed up during configuration of backup of blobs | string[] Optional |
| objectType | Type of the specific object - used for deserializing | BlobBackupDatasourceParameters_ObjectType_STATUS Optional |
DataStoreInfoBase
DataStoreInfo base
Used by: AzureBackupRule, SourceLifeCycle, and TargetCopySetting.
| Property | Description | Type |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | DataStoreInfoBase_DataStoreType Required |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Required |
DataStoreInfoBase_STATUS
DataStoreInfo base
Used by: AzureBackupRule_STATUS, SourceLifeCycle_STATUS, and TargetCopySetting_STATUS.
| Property | Description | Type |
|---|---|---|
| dataStoreType | type of datastore; Operational/Vault/Archive | DataStoreInfoBase_DataStoreType_STATUS Optional |
| objectType | Type of Datasource object, used to initialize the right inherited type | string Optional |
DefaultResourceProperties_ObjectType
Used by: DefaultResourceProperties.
| Value | Description |
|---|---|
| “DefaultResourceProperties” |
DefaultResourceProperties_ObjectType_STATUS
Used by: DefaultResourceProperties_STATUS.
| Value | Description |
|---|---|
| “DefaultResourceProperties” |
KubernetesClusterBackupDatasourceParameters
Used by: BackupDatasourceParameters.
| Property | Description | Type |
|---|---|---|
| backupHookReferences | Gets or sets the backup hook references. This property sets the hook reference to be executed during backup. | NamespacedNameResource[] Optional |
| excludedNamespaces | Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup. | string[] Optional |
| excludedResourceTypes | Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup. | string[] Optional |
| includeClusterScopeResources | Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup. | bool Required |
| includedNamespaces | Gets or sets the include namespaces property. This property sets the namespaces to be included during backup. | string[] Optional |
| includedResourceTypes | Gets or sets the include resource types property. This property sets the resource types to be included during backup. | string[] Optional |
| labelSelectors | Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup. | string[] Optional |
| objectType | Type of the specific object - used for deserializing | KubernetesClusterBackupDatasourceParameters_ObjectType Required |
| snapshotVolumes | Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup. | bool Required |
KubernetesClusterBackupDatasourceParameters_STATUS
Used by: BackupDatasourceParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| backupHookReferences | Gets or sets the backup hook references. This property sets the hook reference to be executed during backup. | NamespacedNameResource_STATUS[] Optional |
| excludedNamespaces | Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup. | string[] Optional |
| excludedResourceTypes | Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup. | string[] Optional |
| includeClusterScopeResources | Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup. | bool Optional |
| includedNamespaces | Gets or sets the include namespaces property. This property sets the namespaces to be included during backup. | string[] Optional |
| includedResourceTypes | Gets or sets the include resource types property. This property sets the resource types to be included during backup. | string[] Optional |
| labelSelectors | Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup. | string[] Optional |
| objectType | Type of the specific object - used for deserializing | KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS Optional |
| snapshotVolumes | Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup. | bool Optional |
SecretStoreResource_SecretStoreType
Used by: SecretStoreResource.
| Value | Description |
|---|---|
| “AzureKeyVault” | |
| “Invalid” |
SecretStoreResource_SecretStoreType_STATUS
Used by: SecretStoreResource_STATUS.
| Value | Description |
|---|---|
| “AzureKeyVault” | |
| “Invalid” |
SourceLifeCycle
Source LifeCycle
Used by: AzureRetentionRule.
| Property | Description | Type |
|---|---|---|
| deleteAfter | DeleteOption Required |
|
| sourceDataStore | DataStoreInfo base | DataStoreInfoBase Required |
| targetDataStoreCopySettings | TargetCopySetting[] Optional |
SourceLifeCycle_STATUS
Source LifeCycle
Used by: AzureRetentionRule_STATUS.
| Property | Description | Type |
|---|---|---|
| deleteAfter | DeleteOption_STATUS Optional |
|
| sourceDataStore | DataStoreInfo base | DataStoreInfoBase_STATUS Optional |
| targetDataStoreCopySettings | TargetCopySetting_STATUS[] Optional |
TriggerContext
Used by: AzureBackupRule.
| Property | Description | Type |
|---|---|---|
| adhocBasedTriggerContext | Mutually exclusive with all other properties | AdhocBasedTriggerContext Optional |
| scheduleBasedTriggerContext | Mutually exclusive with all other properties | ScheduleBasedTriggerContext Optional |
TriggerContext_STATUS
Used by: AzureBackupRule_STATUS.
| Property | Description | Type |
|---|---|---|
| adhocBasedTriggerContext | Mutually exclusive with all other properties | AdhocBasedTriggerContext_STATUS Optional |
| scheduleBasedTriggerContext | Mutually exclusive with all other properties | ScheduleBasedTriggerContext_STATUS Optional |
AdhocBasedTriggerContext
Used by: TriggerContext.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | AdhocBasedTriggerContext_ObjectType Required |
| taggingCriteria | Tagging Criteria containing retention tag for adhoc backup. | AdhocBasedTaggingCriteria Required |
AdhocBasedTriggerContext_STATUS
Used by: TriggerContext_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | AdhocBasedTriggerContext_ObjectType_STATUS Optional |
| taggingCriteria | Tagging Criteria containing retention tag for adhoc backup. | AdhocBasedTaggingCriteria_STATUS Optional |
AzureBackupParams
Used by: BackupParameters.
| Property | Description | Type |
|---|---|---|
| backupType | BackupType ; Full/Incremental etc | string Required |
| objectType | Type of the specific object - used for deserializing | AzureBackupParams_ObjectType Required |
AzureBackupParams_STATUS
Used by: BackupParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| backupType | BackupType ; Full/Incremental etc | string Optional |
| objectType | Type of the specific object - used for deserializing | AzureBackupParams_ObjectType_STATUS Optional |
AzureOperationalStoreParameters_DataStoreType
Used by: AzureOperationalStoreParameters.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
AzureOperationalStoreParameters_DataStoreType_STATUS
Used by: AzureOperationalStoreParameters_STATUS.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
AzureOperationalStoreParameters_ObjectType
Used by: AzureOperationalStoreParameters.
| Value | Description |
|---|---|
| “AzureOperationalStoreParameters” |
AzureOperationalStoreParameters_ObjectType_STATUS
Used by: AzureOperationalStoreParameters_STATUS.
| Value | Description |
|---|---|
| “AzureOperationalStoreParameters” |
BlobBackupDatasourceParameters_ObjectType
Used by: BlobBackupDatasourceParameters.
| Value | Description |
|---|---|
| “BlobBackupDatasourceParameters” |
BlobBackupDatasourceParameters_ObjectType_STATUS
Used by: BlobBackupDatasourceParameters_STATUS.
| Value | Description |
|---|---|
| “BlobBackupDatasourceParameters” |
DataStoreInfoBase_DataStoreType
Used by: DataStoreInfoBase.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
DataStoreInfoBase_DataStoreType_STATUS
Used by: DataStoreInfoBase_STATUS.
| Value | Description |
|---|---|
| “ArchiveStore” | |
| “OperationalStore” | |
| “VaultStore” |
DeleteOption
Used by: SourceLifeCycle.
| Property | Description | Type |
|---|---|---|
| absoluteDeleteOption | Mutually exclusive with all other properties | AbsoluteDeleteOption Optional |
DeleteOption_STATUS
Used by: SourceLifeCycle_STATUS.
| Property | Description | Type |
|---|---|---|
| absoluteDeleteOption | Mutually exclusive with all other properties | AbsoluteDeleteOption_STATUS Optional |
KubernetesClusterBackupDatasourceParameters_ObjectType
Used by: KubernetesClusterBackupDatasourceParameters.
| Value | Description |
|---|---|
| “KubernetesClusterBackupDatasourceParameters” |
KubernetesClusterBackupDatasourceParameters_ObjectType_STATUS
Used by: KubernetesClusterBackupDatasourceParameters_STATUS.
| Value | Description |
|---|---|
| “KubernetesClusterBackupDatasourceParameters” |
NamespacedNameResource
Class to refer resources which contains namespace and name
Used by: KubernetesClusterBackupDatasourceParameters.
| Property | Description | Type |
|---|---|---|
| name | Name of the resource | string Optional |
| namespace | Namespace in which the resource exists | string Optional |
NamespacedNameResource_STATUS
Class to refer resources which contains namespace and name
Used by: KubernetesClusterBackupDatasourceParameters_STATUS.
| Property | Description | Type |
|---|---|---|
| name | Name of the resource | string Optional |
| namespace | Namespace in which the resource exists | string Optional |
ScheduleBasedTriggerContext
Used by: TriggerContext.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | ScheduleBasedTriggerContext_ObjectType Required |
| schedule | Schedule for this backup | BackupSchedule Required |
| taggingCriteria | List of tags that can be applicable for given schedule. | TaggingCriteria[] Required |
ScheduleBasedTriggerContext_STATUS
Used by: TriggerContext_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | ScheduleBasedTriggerContext_ObjectType_STATUS Optional |
| schedule | Schedule for this backup | BackupSchedule_STATUS Optional |
| taggingCriteria | List of tags that can be applicable for given schedule. | TaggingCriteria_STATUS[] Optional |
TargetCopySetting
Target copy settings
Used by: SourceLifeCycle.
| Property | Description | Type |
|---|---|---|
| copyAfter | It can be CustomCopyOption or ImmediateCopyOption. | CopyOption Required |
| dataStore | Info of target datastore | DataStoreInfoBase Required |
TargetCopySetting_STATUS
Target copy settings
Used by: SourceLifeCycle_STATUS.
| Property | Description | Type |
|---|---|---|
| copyAfter | It can be CustomCopyOption or ImmediateCopyOption. | CopyOption_STATUS Optional |
| dataStore | Info of target datastore | DataStoreInfoBase_STATUS Optional |
AbsoluteDeleteOption
Used by: DeleteOption.
| Property | Description | Type |
|---|---|---|
| duration | Duration of deletion after given timespan | string Required |
| objectType | Type of the specific object - used for deserializing | AbsoluteDeleteOption_ObjectType Required |
AbsoluteDeleteOption_STATUS
Used by: DeleteOption_STATUS.
| Property | Description | Type |
|---|---|---|
| duration | Duration of deletion after given timespan | string Optional |
| objectType | Type of the specific object - used for deserializing | AbsoluteDeleteOption_ObjectType_STATUS Optional |
AdhocBasedTaggingCriteria
Adhoc backup tagging criteria
Used by: AdhocBasedTriggerContext.
| Property | Description | Type |
|---|---|---|
| tagInfo | Retention tag information | RetentionTag Optional |
AdhocBasedTaggingCriteria_STATUS
Adhoc backup tagging criteria
Used by: AdhocBasedTriggerContext_STATUS.
| Property | Description | Type |
|---|---|---|
| tagInfo | Retention tag information | RetentionTag_STATUS Optional |
AdhocBasedTriggerContext_ObjectType
Used by: AdhocBasedTriggerContext.
| Value | Description |
|---|---|
| “AdhocBasedTriggerContext” |
AdhocBasedTriggerContext_ObjectType_STATUS
Used by: AdhocBasedTriggerContext_STATUS.
| Value | Description |
|---|---|
| “AdhocBasedTriggerContext” |
AzureBackupParams_ObjectType
Used by: AzureBackupParams.
| Value | Description |
|---|---|
| “AzureBackupParams” |
AzureBackupParams_ObjectType_STATUS
Used by: AzureBackupParams_STATUS.
| Value | Description |
|---|---|
| “AzureBackupParams” |
BackupSchedule
Schedule for backup
Used by: ScheduleBasedTriggerContext.
| Property | Description | Type |
|---|---|---|
| repeatingTimeIntervals | ISO 8601 repeating time interval format | string[] Required |
| timeZone | Time zone for a schedule. Example: Pacific Standard Time | string Optional |
BackupSchedule_STATUS
Schedule for backup
Used by: ScheduleBasedTriggerContext_STATUS.
| Property | Description | Type |
|---|---|---|
| repeatingTimeIntervals | ISO 8601 repeating time interval format | string[] Optional |
| timeZone | Time zone for a schedule. Example: Pacific Standard Time | string Optional |
CopyOption
Used by: TargetCopySetting.
| Property | Description | Type |
|---|---|---|
| copyOnExpiryOption | Mutually exclusive with all other properties | CopyOnExpiryOption Optional |
| customCopyOption | Mutually exclusive with all other properties | CustomCopyOption Optional |
| immediateCopyOption | Mutually exclusive with all other properties | ImmediateCopyOption Optional |
CopyOption_STATUS
Used by: TargetCopySetting_STATUS.
| Property | Description | Type |
|---|---|---|
| copyOnExpiryOption | Mutually exclusive with all other properties | CopyOnExpiryOption_STATUS Optional |
| customCopyOption | Mutually exclusive with all other properties | CustomCopyOption_STATUS Optional |
| immediateCopyOption | Mutually exclusive with all other properties | ImmediateCopyOption_STATUS Optional |
ScheduleBasedTriggerContext_ObjectType
Used by: ScheduleBasedTriggerContext.
| Value | Description |
|---|---|
| “ScheduleBasedTriggerContext” |
ScheduleBasedTriggerContext_ObjectType_STATUS
Used by: ScheduleBasedTriggerContext_STATUS.
| Value | Description |
|---|---|
| “ScheduleBasedTriggerContext” |
TaggingCriteria
Tagging criteria
Used by: ScheduleBasedTriggerContext.
| Property | Description | Type |
|---|---|---|
| criteria | Criteria which decides whether the tag can be applied to a triggered backup. | BackupCriteria[] Optional |
| isDefault | Specifies if tag is default. | bool Required |
| taggingPriority | Retention Tag priority. | int Required |
| tagInfo | Retention tag information | RetentionTag Required |
TaggingCriteria_STATUS
Tagging criteria
Used by: ScheduleBasedTriggerContext_STATUS.
| Property | Description | Type |
|---|---|---|
| criteria | Criteria which decides whether the tag can be applied to a triggered backup. | BackupCriteria_STATUS[] Optional |
| isDefault | Specifies if tag is default. | bool Optional |
| taggingPriority | Retention Tag priority. | int Optional |
| tagInfo | Retention tag information | RetentionTag_STATUS Optional |
AbsoluteDeleteOption_ObjectType
Used by: AbsoluteDeleteOption.
| Value | Description |
|---|---|
| “AbsoluteDeleteOption” |
AbsoluteDeleteOption_ObjectType_STATUS
Used by: AbsoluteDeleteOption_STATUS.
| Value | Description |
|---|---|
| “AbsoluteDeleteOption” |
BackupCriteria
Used by: TaggingCriteria.
| Property | Description | Type |
|---|---|---|
| scheduleBasedBackupCriteria | Mutually exclusive with all other properties | ScheduleBasedBackupCriteria Optional |
BackupCriteria_STATUS
Used by: TaggingCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| scheduleBasedBackupCriteria | Mutually exclusive with all other properties | ScheduleBasedBackupCriteria_STATUS Optional |
CopyOnExpiryOption
Used by: CopyOption.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | CopyOnExpiryOption_ObjectType Required |
CopyOnExpiryOption_STATUS
Used by: CopyOption_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | CopyOnExpiryOption_ObjectType_STATUS Optional |
CustomCopyOption
Used by: CopyOption.
| Property | Description | Type |
|---|---|---|
| duration | Data copied after given timespan | string Optional |
| objectType | Type of the specific object - used for deserializing | CustomCopyOption_ObjectType Required |
CustomCopyOption_STATUS
Used by: CopyOption_STATUS.
| Property | Description | Type |
|---|---|---|
| duration | Data copied after given timespan | string Optional |
| objectType | Type of the specific object - used for deserializing | CustomCopyOption_ObjectType_STATUS Optional |
ImmediateCopyOption
Used by: CopyOption.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | ImmediateCopyOption_ObjectType Required |
ImmediateCopyOption_STATUS
Used by: CopyOption_STATUS.
| Property | Description | Type |
|---|---|---|
| objectType | Type of the specific object - used for deserializing | ImmediateCopyOption_ObjectType_STATUS Optional |
RetentionTag
Retention tag
Used by: AdhocBasedTaggingCriteria, and TaggingCriteria.
| Property | Description | Type |
|---|---|---|
| tagName | Retention Tag Name to relate it to retention rule. | string Required |
RetentionTag_STATUS
Retention tag
Used by: AdhocBasedTaggingCriteria_STATUS, and TaggingCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| eTag | Retention Tag version. | string Optional |
| id | Retention Tag version. | string Optional |
| tagName | Retention Tag Name to relate it to retention rule. | string Optional |
CopyOnExpiryOption_ObjectType
Used by: CopyOnExpiryOption.
| Value | Description |
|---|---|
| “CopyOnExpiryOption” |
CopyOnExpiryOption_ObjectType_STATUS
Used by: CopyOnExpiryOption_STATUS.
| Value | Description |
|---|---|
| “CopyOnExpiryOption” |
CustomCopyOption_ObjectType
Used by: CustomCopyOption.
| Value | Description |
|---|---|
| “CustomCopyOption” |
CustomCopyOption_ObjectType_STATUS
Used by: CustomCopyOption_STATUS.
| Value | Description |
|---|---|
| “CustomCopyOption” |
ImmediateCopyOption_ObjectType
Used by: ImmediateCopyOption.
| Value | Description |
|---|---|
| “ImmediateCopyOption” |
ImmediateCopyOption_ObjectType_STATUS
Used by: ImmediateCopyOption_STATUS.
| Value | Description |
|---|---|
| “ImmediateCopyOption” |
ScheduleBasedBackupCriteria
Used by: BackupCriteria.
| Property | Description | Type |
|---|---|---|
| absoluteCriteria | it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum | ScheduleBasedBackupCriteria_AbsoluteCriteria[] Optional |
| daysOfMonth | This is day of the month from 1 to 28 other wise last of month | Day[] Optional |
| daysOfTheWeek | It should be Sunday/Monday/T…./Saturday | ScheduleBasedBackupCriteria_DaysOfTheWeek[] Optional |
| monthsOfYear | It should be January/February/……/December | ScheduleBasedBackupCriteria_MonthsOfYear[] Optional |
| objectType | Type of the specific object - used for deserializing | ScheduleBasedBackupCriteria_ObjectType Required |
| scheduleTimes | List of schedule times for backup | string[] Optional |
| weeksOfTheMonth | It should be First/Second/Third/Fourth/Last | ScheduleBasedBackupCriteria_WeeksOfTheMonth[] Optional |
ScheduleBasedBackupCriteria_STATUS
Used by: BackupCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| absoluteCriteria | it contains absolute values like “AllBackup” / “FirstOfDay” / “FirstOfWeek” / “FirstOfMonth” and should be part of AbsoluteMarker enum | ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS[] Optional |
| daysOfMonth | This is day of the month from 1 to 28 other wise last of month | Day_STATUS[] Optional |
| daysOfTheWeek | It should be Sunday/Monday/T…./Saturday | ScheduleBasedBackupCriteria_DaysOfTheWeek_STATUS[] Optional |
| monthsOfYear | It should be January/February/……/December | ScheduleBasedBackupCriteria_MonthsOfYear_STATUS[] Optional |
| objectType | Type of the specific object - used for deserializing | ScheduleBasedBackupCriteria_ObjectType_STATUS Optional |
| scheduleTimes | List of schedule times for backup | string[] Optional |
| weeksOfTheMonth | It should be First/Second/Third/Fourth/Last | ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS[] Optional |
Day
Day of the week
Used by: ScheduleBasedBackupCriteria.
| Property | Description | Type |
|---|---|---|
| date | Date of the month | int Optional |
| isLast | Whether Date is last date of month | bool Optional |
Day_STATUS
Day of the week
Used by: ScheduleBasedBackupCriteria_STATUS.
| Property | Description | Type |
|---|---|---|
| date | Date of the month | int Optional |
| isLast | Whether Date is last date of month | bool Optional |
ScheduleBasedBackupCriteria_AbsoluteCriteria
Used by: ScheduleBasedBackupCriteria.
| Value | Description |
|---|---|
| “AllBackup” | |
| “FirstOfDay” | |
| “FirstOfMonth” | |
| “FirstOfWeek” | |
| “FirstOfYear” |
ScheduleBasedBackupCriteria_AbsoluteCriteria_STATUS
Used by: ScheduleBasedBackupCriteria_STATUS.
| Value | Description |
|---|---|
| “AllBackup” | |
| “FirstOfDay” | |
| “FirstOfMonth” | |
| “FirstOfWeek” | |
| “FirstOfYear” |
ScheduleBasedBackupCriteria_DaysOfTheWeek
Used by: ScheduleBasedBackupCriteria.
| Value | Description |
|---|---|
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” |
ScheduleBasedBackupCriteria_DaysOfTheWeek_STATUS
Used by: ScheduleBasedBackupCriteria_STATUS.
| Value | Description |
|---|---|
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” |
ScheduleBasedBackupCriteria_MonthsOfYear
Used by: ScheduleBasedBackupCriteria.
| Value | Description |
|---|---|
| “April” | |
| “August” | |
| “December” | |
| “February” | |
| “January” | |
| “July” | |
| “June” | |
| “March” | |
| “May” | |
| “November” | |
| “October” | |
| “September” |
ScheduleBasedBackupCriteria_MonthsOfYear_STATUS
Used by: ScheduleBasedBackupCriteria_STATUS.
| Value | Description |
|---|---|
| “April” | |
| “August” | |
| “December” | |
| “February” | |
| “January” | |
| “July” | |
| “June” | |
| “March” | |
| “May” | |
| “November” | |
| “October” | |
| “September” |
ScheduleBasedBackupCriteria_ObjectType
Used by: ScheduleBasedBackupCriteria.
| Value | Description |
|---|---|
| “ScheduleBasedBackupCriteria” |
ScheduleBasedBackupCriteria_ObjectType_STATUS
Used by: ScheduleBasedBackupCriteria_STATUS.
| Value | Description |
|---|---|
| “ScheduleBasedBackupCriteria” |
ScheduleBasedBackupCriteria_WeeksOfTheMonth
Used by: ScheduleBasedBackupCriteria.
| Value | Description |
|---|---|
| “First” | |
| “Fourth” | |
| “Last” | |
| “Second” | |
| “Third” |
ScheduleBasedBackupCriteria_WeeksOfTheMonth_STATUS
Used by: ScheduleBasedBackupCriteria_STATUS.
| Value | Description |
|---|---|
| “First” | |
| “Fourth” | |
| “Last” | |
| “Second” | |
| “Third” |