Package-level declarations

Types

Link copied to clipboard
data class AbsoluteDeleteOptionResponse(val duration: String, val objectType: String)

Delete option with duration

Link copied to clipboard

Adhoc backup tagging criteria

Link copied to clipboard
data class AdhocBasedTriggerContextResponse(val objectType: String, val taggingCriteria: AdhocBasedTaggingCriteriaResponse)

Adhoc trigger context

Link copied to clipboard
data class AzureBackupParamsResponse(val backupType: String, val objectType: String)

Azure backup parameters

Link copied to clipboard
data class AzureBackupRuleResponse(val backupParameters: AzureBackupParamsResponse? = null, val dataStore: DataStoreInfoBaseResponse, val name: String, val objectType: String, val trigger: Either<AdhocBasedTriggerContextResponse, ScheduleBasedTriggerContextResponse>)

Azure backup rule

Link copied to clipboard
data class AzureMonitorAlertSettingsResponse(val alertsForAllJobFailures: String? = null)

Settings for Azure Monitor based alerts

Link copied to clipboard
data class AzureOperationalStoreParametersResponse(val dataStoreType: String, val objectType: String, val resourceGroupId: String? = null)

Parameters for Operational-Tier DataStore

Link copied to clipboard
data class AzureRetentionRuleResponse(val isDefault: Boolean? = null, val lifecycles: List<SourceLifeCycleResponse>, val name: String, val objectType: String)

Azure retention rule

Link copied to clipboard
data class BackupInstanceResponse(val currentProtectionState: String, val dataSourceInfo: DatasourceResponse, val dataSourceSetInfo: DatasourceSetResponse? = null, val datasourceAuthCredentials: SecretStoreBasedAuthCredentialsResponse? = null, val friendlyName: String? = null, val identityDetails: IdentityDetailsResponse? = null, val objectType: String, val policyInfo: PolicyInfoResponse, val protectionErrorDetails: UserFacingErrorResponse, val protectionStatus: ProtectionStatusDetailsResponse, val provisioningState: String, val resourceGuardOperationRequests: List<String>? = null, val validationType: String? = null)

Backup Instance

Link copied to clipboard
data class BackupPolicyResponse(val datasourceTypes: List<String>, val objectType: String, val policyRules: List<Either<AzureBackupRuleResponse, AzureRetentionRuleResponse>>)

Rule based backup policy

Link copied to clipboard
data class BackupScheduleResponse(val repeatingTimeIntervals: List<String>, val timeZone: String? = null)

Schedule for backup

Link copied to clipboard
data class BackupVaultResponse(val bcdrSecurityLevel: String, val featureSettings: FeatureSettingsResponse? = null, val isVaultProtectedByResourceGuard: Boolean, val monitoringSettings: MonitoringSettingsResponse? = null, val provisioningState: String, val replicatedRegions: List<String>? = null, val resourceGuardOperationRequests: List<String>? = null, val resourceMoveDetails: ResourceMoveDetailsResponse, val resourceMoveState: String, val secureScore: String, val securitySettings: SecuritySettingsResponse? = null, val storageSettings: List<StorageSettingResponse>)

Backup Vault

Link copied to clipboard
data class BlobBackupDatasourceParametersResponse(val containersList: List<String>, val objectType: String)

Parameters to be used during configuration of backup of blobs

Link copied to clipboard
data class CmkKekIdentityResponse(val identityId: String? = null, val identityType: String? = null)

The details of the managed identity used for CMK

Link copied to clipboard
data class CmkKeyVaultPropertiesResponse(val keyUri: String? = null)

The properties of the Key Vault which hosts CMK

Link copied to clipboard
data class CopyOnExpiryOptionResponse(val objectType: String)

Copy on Expiry Option

Link copied to clipboard
data class CrossRegionRestoreSettingsResponse(val state: String? = null)
Link copied to clipboard
data class CrossSubscriptionRestoreSettingsResponse(val state: String? = null)

CrossSubscriptionRestore Settings

Link copied to clipboard
data class CustomCopyOptionResponse(val duration: String? = null, val objectType: String)

Duration based custom options to copy

Link copied to clipboard
data class DatasourceResponse(val datasourceType: String? = null, val objectType: String? = null, val resourceID: String, val resourceLocation: String? = null, val resourceName: String? = null, val resourceProperties: DefaultResourcePropertiesResponse? = null, val resourceType: String? = null, val resourceUri: String? = null)

Datasource to be backed up

Link copied to clipboard
data class DatasourceSetResponse(val datasourceType: String? = null, val objectType: String? = null, val resourceID: String, val resourceLocation: String? = null, val resourceName: String? = null, val resourceProperties: DefaultResourcePropertiesResponse? = null, val resourceType: String? = null, val resourceUri: String? = null)

DatasourceSet details of datasource to be backed up

Link copied to clipboard
data class DataStoreInfoBaseResponse(val dataStoreType: String, val objectType: String)

DataStoreInfo base

Link copied to clipboard
data class DayResponse(val date: Int? = null, val isLast: Boolean? = null)

Day of the week

Link copied to clipboard
data class DefaultResourcePropertiesResponse(val objectType: String)

Default source properties

Link copied to clipboard
data class DppIdentityDetailsResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Identity details

Link copied to clipboard
data class EncryptionSettingsResponse(val infrastructureEncryption: String? = null, val kekIdentity: CmkKekIdentityResponse? = null, val keyVaultProperties: CmkKeyVaultPropertiesResponse? = null, val state: String? = null)

Customer Managed Key details of the resource.

Link copied to clipboard
data class FeatureSettingsResponse(val crossRegionRestoreSettings: CrossRegionRestoreSettingsResponse? = null, val crossSubscriptionRestoreSettings: CrossSubscriptionRestoreSettingsResponse? = null)

Class containing feature settings of vault

Link copied to clipboard
data class GetBackupInstanceResult(val azureApiVersion: String, val id: String, val name: String, val properties: BackupInstanceResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

BackupInstance Resource

Link copied to clipboard
data class GetBackupPolicyResult(val azureApiVersion: String, val id: String, val name: String, val properties: BackupPolicyResponse, val systemData: SystemDataResponse, val type: String)

BaseBackupPolicy resource

Link copied to clipboard
data class GetBackupVaultResult(val azureApiVersion: String, val eTag: String? = null, val id: String, val identity: DppIdentityDetailsResponse? = null, val location: String, val name: String, val properties: BackupVaultResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Backup Vault Resource

Link copied to clipboard
data class GetDppResourceGuardProxyResult(val azureApiVersion: String, val id: String, val name: String, val properties: ResourceGuardProxyBaseResponse, val systemData: SystemDataResponse, val type: String)

ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs

Link copied to clipboard
data class GetResourceGuardResult(val azureApiVersion: String, val eTag: String? = null, val id: String, val location: String? = null, val name: String, val properties: ResourceGuardResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)
Link copied to clipboard
data class IdentityDetailsResponse(val useSystemAssignedIdentity: Boolean? = null, val userAssignedIdentityArmUrl: String? = null)
Link copied to clipboard
data class ImmediateCopyOptionResponse(val objectType: String)

Immediate copy Option

Link copied to clipboard
data class ImmutabilitySettingsResponse(val state: String? = null)

Immutability Settings at vault level

Link copied to clipboard
data class InnerErrorResponse(val additionalInfo: Map<String, String>? = null, val code: String? = null, val embeddedInnerError: InnerErrorResponse? = null)

Inner Error

data class KubernetesClusterBackupDatasourceParametersResponse(val backupHookReferences: List<NamespacedNameResourceResponse>? = null, val excludedNamespaces: List<String>? = null, val excludedResourceTypes: List<String>? = null, val includeClusterScopeResources: Boolean, val includedNamespaces: List<String>? = null, val includedResourceTypes: List<String>? = null, val includedVolumeTypes: List<String>? = null, val labelSelectors: List<String>? = null, val objectType: String, val snapshotVolumes: Boolean)

Parameters for Kubernetes Cluster Backup Datasource

Link copied to clipboard
data class MonitoringSettingsResponse(val azureMonitorAlertSettings: AzureMonitorAlertSettingsResponse? = null)

Monitoring Settings

Link copied to clipboard
data class NamespacedNameResourceResponse(val name: String? = null, val namespace: String? = null)

Class to refer resources which contains namespace and name

Link copied to clipboard
data class PolicyInfoResponse(val policyId: String, val policyParameters: PolicyParametersResponse? = null, val policyVersion: String)

Policy Info in backupInstance

Link copied to clipboard
data class PolicyParametersResponse(val backupDatasourceParametersList: List<Either<BlobBackupDatasourceParametersResponse, KubernetesClusterBackupDatasourceParametersResponse>>? = null, val dataStoreParametersList: List<AzureOperationalStoreParametersResponse>? = null)

Parameters in Policy

Link copied to clipboard
data class ProtectionStatusDetailsResponse(val errorDetails: UserFacingErrorResponse? = null, val status: String? = null)

Protection status details

Link copied to clipboard
data class ResourceGuardOperationDetailResponse(val defaultResourceRequest: String? = null, val vaultCriticalOperation: String? = null)

VaultCritical Operation protected by a resource guard

Link copied to clipboard
data class ResourceGuardOperationResponse(val requestResourceType: String, val vaultCriticalOperation: String)

This class contains all the details about a critical operation.

Link copied to clipboard
data class ResourceGuardProxyBaseResponse(val description: String? = null, val lastUpdatedTime: String? = null, val resourceGuardOperationDetails: List<ResourceGuardOperationDetailResponse>? = null, val resourceGuardResourceId: String? = null)

ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource

Link copied to clipboard
data class ResourceGuardResponse(val allowAutoApprovals: Boolean, val description: String, val provisioningState: String, val resourceGuardOperations: List<ResourceGuardOperationResponse>, val vaultCriticalOperationExclusionList: List<String>? = null)
Link copied to clipboard
data class ResourceMoveDetailsResponse(val completionTimeUtc: String? = null, val operationId: String? = null, val sourceResourcePath: String? = null, val startTimeUtc: String? = null, val targetResourcePath: String? = null)

ResourceMoveDetails will be returned in response to GetResource call from ARM

Link copied to clipboard
data class RetentionTagResponse(val eTag: String, val id: String, val tagName: String)

Retention tag

Link copied to clipboard
data class ScheduleBasedBackupCriteriaResponse(val absoluteCriteria: List<String>? = null, val daysOfMonth: List<DayResponse>? = null, val daysOfTheWeek: List<String>? = null, val monthsOfYear: List<String>? = null, val objectType: String, val scheduleTimes: List<String>? = null, val weeksOfTheMonth: List<String>? = null)

Schedule based backup criteria

Link copied to clipboard
data class ScheduleBasedTriggerContextResponse(val objectType: String, val schedule: BackupScheduleResponse, val taggingCriteria: List<TaggingCriteriaResponse>)

Schedule based trigger context

Link copied to clipboard
data class SecretStoreBasedAuthCredentialsResponse(val objectType: String, val secretStoreResource: SecretStoreResourceResponse? = null)

Secret store based authentication credentials.

Link copied to clipboard
data class SecretStoreResourceResponse(val secretStoreType: String, val uri: String? = null, val value: String? = null)

Class representing a secret store resource.

Link copied to clipboard
data class SecuritySettingsResponse(val encryptionSettings: EncryptionSettingsResponse? = null, val immutabilitySettings: ImmutabilitySettingsResponse? = null, val softDeleteSettings: SoftDeleteSettingsResponse? = null)

Class containing security settings of vault

Link copied to clipboard
data class SoftDeleteSettingsResponse(val retentionDurationInDays: Double? = null, val state: String? = null)

Soft delete related settings

Link copied to clipboard
data class SourceLifeCycleResponse(val deleteAfter: AbsoluteDeleteOptionResponse, val sourceDataStore: DataStoreInfoBaseResponse, val targetDataStoreCopySettings: List<TargetCopySettingResponse>? = null)

Source LifeCycle

Link copied to clipboard
data class StorageSettingResponse(val datastoreType: String? = null, val type: String? = null)

Storage setting

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TaggingCriteriaResponse(val criteria: List<ScheduleBasedBackupCriteriaResponse>? = null, val isDefault: Boolean, val tagInfo: RetentionTagResponse, val taggingPriority: Double)

Tagging criteria

Link copied to clipboard
data class TargetCopySettingResponse(val copyAfter: Any, val dataStore: DataStoreInfoBaseResponse)

Target copy settings

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class UserFacingErrorResponse(val code: String? = null, val details: List<UserFacingErrorResponse>? = null, val innerError: InnerErrorResponse? = null, val isRetryable: Boolean? = null, val isUserError: Boolean? = null, val message: String? = null, val properties: Map<String, String>? = null, val recommendedAction: List<String>? = null, val target: String? = null)

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