Package-level declarations

Types

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

Defines the Alert Query Parameter.

Link copied to clipboard
data class AlertRulePropertiesResponse(val actionGroups: List<String>? = null, val alertQueryParameters: List<AlertQueryParameterResponse>? = null, val autoMitigate: String? = null, val dimension: String? = null, val evaluationFrequency: Int? = null, val failingPeriodsOperator: String? = null, val failingPeriodsToAlert: Int? = null, val muteActionsDuration: Int? = null, val severity: Int? = null, val status: String? = null, val threshold: Int? = null, val thresholdOperator: String? = null, val windowSize: Int? = null)

Describes the properties of an alert.

Link copied to clipboard
data class ApplicationServerConfigurationResponse(val instanceCount: Double, val subnetId: String, val virtualMachineConfiguration: VirtualMachineConfigurationResponse)

Gets or sets the application server configuration.

data class ApplicationServerFullResourceNamesResponse(val availabilitySetName: String? = null, val virtualMachines: List<VirtualMachineResourceNamesResponse>? = null)

The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer.

Link copied to clipboard
data class ApplicationServerVmDetailsResponse(val storageDetails: List<StorageInformationResponse>, val type: String, val virtualMachineId: String)

The Application Server VM Details.

Link copied to clipboard
data class AppServicePlanConfigurationResponse(val capacity: Int? = null, val tier: String? = null)

Configuration details of app service plan

Link copied to clipboard
data class CentralServerConfigurationResponse(val instanceCount: Double, val subnetId: String, val virtualMachineConfiguration: VirtualMachineConfigurationResponse)

Gets or sets the central server configuration.

Link copied to clipboard
data class CentralServerFullResourceNamesResponse(val availabilitySetName: String? = null, val loadBalancer: LoadBalancerResourceNamesResponse? = null, val virtualMachines: List<VirtualMachineResourceNamesResponse>? = null)

The full resource names object for central server layer resources.

Link copied to clipboard
data class CentralServerVmDetailsResponse(val storageDetails: List<StorageInformationResponse>, val type: String, val virtualMachineId: String)

The SAP Central Services Instance VM details.

Link copied to clipboard
data class ConfigurationDataResponse(val cpu: Int, val cpuInMhz: Int, val cpuType: String, val databaseType: String, val hardwareManufacturer: String, val model: String, val ram: Int, val saps: Int, val targetHanaRamSizeGB: Int, val totalDiskIops: Int, val totalDiskSizeGB: Int)

The SAP instance specific configuration data.

Link copied to clipboard
data class ConnectorErrorDefinitionResponse(val code: String, val details: List<ConnectorErrorDefinitionResponse>, val message: String)

Error definition.

data class CreateAndMountFileShareConfigurationResponse(val configurationType: String, val resourceGroup: String? = null, val storageAccountName: String? = null)

Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow. Please pre-create the resource group you intend to place the transport directory in. The storage account and fileshare will be auto-created by the ACSS and doesn't need to be pre-created.

Link copied to clipboard
data class DailyRetentionFormatResponse(val daysOfTheMonth: List<DayResponse>? = null)

Daily retention format.

Link copied to clipboard
data class DailyRetentionScheduleResponse(val retentionDuration: RetentionDurationResponse? = null, val retentionTimes: List<String>? = null)

Daily retention schedule.

Link copied to clipboard
data class DailyScheduleResponse(val scheduleRunTimes: List<String>? = null)

Daily schedule.

Link copied to clipboard
data class DatabaseConfigurationResponse(val databaseType: String? = null, val diskConfiguration: DiskConfigurationResponse? = null, val instanceCount: Double, val subnetId: String, val virtualMachineConfiguration: VirtualMachineConfigurationResponse)

Gets or sets the database configuration.

Link copied to clipboard
data class DatabaseServerFullResourceNamesResponse(val availabilitySetName: String? = null, val loadBalancer: LoadBalancerResourceNamesResponse? = null, val virtualMachines: List<VirtualMachineResourceNamesResponse>? = null)

The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer.

Link copied to clipboard
data class DatabaseVmDetailsResponse(val status: String, val storageDetails: List<StorageInformationResponse>, val virtualMachineId: String)

Database VM details.

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 Db2ProviderInstancePropertiesResponse(val dbName: String? = null, val dbPassword: String? = null, val dbPasswordUri: String? = null, val dbPort: String? = null, val dbUsername: String? = null, val hostname: String? = null, val providerType: String, val sapSid: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the DB2 provider properties.

Link copied to clipboard
data class DBBackupPolicyPropertiesResponse(val backupManagementType: String, val makePolicyConsistent: Boolean? = null, val name: String, val protectedItemsCount: Int? = null, val resourceGuardOperationRequests: List<String>? = null, val settings: SettingsResponse? = null, val subProtectionPolicy: List<SubProtectionPolicyResponse>? = null, val workLoadType: String? = null)

Defines the policy properties for database backup.

Link copied to clipboard
data class DeployerVmPackagesResponse(val storageAccountId: String? = null, val url: String? = null)

Defines the url and storage account ID where deployer VM packages are uploaded

Link copied to clipboard
data class DeploymentConfigurationResponse(val appLocation: String? = null, val configurationType: String, val infrastructureConfiguration: Either<SingleServerConfigurationResponse, ThreeTierConfigurationResponse>? = null, val softwareConfiguration: Any? = null)

Deployment Configuration.

Link copied to clipboard
data class DeploymentWithOSConfigurationResponse(val appLocation: String? = null, val configurationType: String, val infrastructureConfiguration: Either<SingleServerConfigurationResponse, ThreeTierConfigurationResponse>? = null, val osSapConfiguration: OsSapConfigurationResponse? = null, val softwareConfiguration: Any? = null)

Deployment along with OS Configuration.

Link copied to clipboard
data class DiscoveryConfigurationResponse(val appLocation: String, val centralServerVmId: String? = null, val configurationType: String, val managedRgStorageAccountName: String? = null)

Discovery Details.

Link copied to clipboard
data class DiskConfigurationResponse(val diskVolumeConfigurations: Map<String, DiskVolumeConfigurationResponse>? = null)

The Disk Configuration Details.

Link copied to clipboard
data class DiskDetailsResponse(val diskTier: String? = null, val iopsReadWrite: Double? = null, val maximumSupportedDiskCount: Double? = null, val mbpsReadWrite: Double? = null, val minimumSupportedDiskCount: Double? = null, val sizeGB: Double? = null, val sku: DiskSkuResponse? = null)

The supported disk size details for a disk type.

Link copied to clipboard
data class DiskExclusionPropertiesResponse(val diskLunList: List<Int>, val isInclusionList: Boolean)

Defines the disk exclusion properties for virtual machine backup.

Link copied to clipboard
data class DiskSkuResponse(val name: String? = null)

The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS.

Link copied to clipboard
data class DiskVolumeConfigurationResponse(val count: Double? = null, val sizeGB: Double? = null, val sku: DiskSkuResponse? = null)

The disk configuration required for the selected volume.

data class EnqueueReplicationServerPropertiesResponse(val ersVersion: String, val health: String, val hostname: String, val instanceNo: String, val ipAddress: String, val kernelPatch: String, val kernelVersion: String)

Defines the SAP Enqueue Replication Server (ERS) properties.

Link copied to clipboard
data class EnqueueServerPropertiesResponse(val health: String, val hostname: String, val ipAddress: String, val port: Double)

Defines the SAP Enqueue Server properties.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDefinitionResponse(val code: String, val details: List<ErrorDefinitionResponse>, val message: String, val recommendation: String)

Error definition.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

Link copied to clipboard
data class ExcelPerformanceDataResponse(val dataSource: String, val maxCpuLoad: Int, val totalSourceDbSizeGB: Int)

The SAP instance specific performance data for Excel import.

Link copied to clipboard
data class ExistingRecoveryServicesVaultResponse(val id: String, val vaultType: String)

Existing recovery services vault.

Link copied to clipboard
data class ExtendedLocationResponse(val name: String, val type: String)

The extended location definition.

data class ExternalInstallationSoftwareConfigurationResponse(val centralServerVmId: String? = null, val softwareInstallationType: String)

The SAP Software configuration Input when the software is installed externally outside the service.

Link copied to clipboard
data class GatewayServerPropertiesResponse(val health: String, val port: Double)

Defines the SAP Gateway Server properties.

Link copied to clipboard
data class GetACSSBackupConnectionResult(val azureApiVersion: String, val backupData: Any? = null, val errors: ConnectorErrorDefinitionResponse, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Define the backup connection resource of virtual instance for SAP..

Link copied to clipboard
data class GetAlertResult(val alertRuleProperties: AlertRulePropertiesResponse? = null, val alertRuleResourceId: String, val azureApiVersion: String, val errors: ErrorDetailResponse, val id: String, val name: String, val providerNames: List<String>? = null, val providerType: String? = null, val provisioningState: String, val systemData: SystemDataResponse, val templateName: String? = null, val type: String)

A alert associated with SAP monitor.

Link copied to clipboard
data class GetConnectorResult(val azureApiVersion: String, val errors: ConnectorErrorDefinitionResponse, val id: String, val identity: UserAssignedServiceIdentityResponse? = null, val location: String, val managedResourceGroupConfiguration: ManagedRGConfigurationResponse? = null, val name: String, val provisioningState: String, val sourceResourceId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Define the connector resource.

Link copied to clipboard
data class GetMonitorResult(val appLocation: String? = null, val appServicePlanConfiguration: AppServicePlanConfigurationResponse? = null, val azureApiVersion: String, val errors: ErrorDetailResponse, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val logAnalyticsWorkspaceArmId: String? = null, val managedResourceGroupConfiguration: ManagedResourceGroupConfigurationResponse? = null, val monitorSubnet: String? = null, val msiArmId: String, val name: String, val provisioningState: String, val routingPreference: String? = null, val storageAccountArmId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val zoneRedundancyPreference: String? = null)

SAP monitor info on Azure (ARM properties and SAP monitor properties)

Link copied to clipboard
data class GetProviderInstanceResult(val azureApiVersion: String, val errors: ErrorDetailResponse, val health: HealthResponse, val id: String, val name: String, val providerSettings: Any? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A provider instance associated with SAP monitor.

Link copied to clipboard
data class GetSapApplicationServerInstanceResult(val azureApiVersion: String, val dispatcherStatus: String, val errors: SAPVirtualInstanceErrorResponse, val gatewayPort: Double, val health: String, val hostname: String, val icmHttpPort: Double, val icmHttpsPort: Double, val id: String, val instanceNo: String, val ipAddress: String, val kernelPatch: String, val kernelVersion: String, val loadBalancerDetails: LoadBalancerDetailsResponse, val location: String, val name: String, val provisioningState: String, val status: String, val subnet: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmDetails: List<ApplicationServerVmDetailsResponse>)

Define the SAP Application Server Instance resource.

Link copied to clipboard
data class GetSAPAvailabilityZoneDetailsResult(val availabilityZonePairs: List<SAPAvailabilityZonePairResponse>? = null)

The list of supported availability zone pairs which are part of SAP HA deployment.

Link copied to clipboard
data class GetSapCentralServerInstanceResult(val azureApiVersion: String, val enqueueReplicationServerProperties: EnqueueReplicationServerPropertiesResponse? = null, val enqueueServerProperties: EnqueueServerPropertiesResponse? = null, val errors: SAPVirtualInstanceErrorResponse, val gatewayServerProperties: GatewayServerPropertiesResponse? = null, val health: String, val id: String, val instanceNo: String, val kernelPatch: String, val kernelVersion: String, val loadBalancerDetails: LoadBalancerDetailsResponse, val location: String, val messageServerProperties: MessageServerPropertiesResponse? = null, val name: String, val provisioningState: String, val status: String, val subnet: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmDetails: List<CentralServerVmDetailsResponse>)

Define the SAP Central Services Instance resource.

Link copied to clipboard
data class GetSapDatabaseInstanceResult(val azureApiVersion: String, val databaseSid: String, val databaseType: String, val errors: SAPVirtualInstanceErrorResponse, val id: String, val ipAddress: String, val loadBalancerDetails: LoadBalancerDetailsResponse, val location: String, val name: String, val provisioningState: String, val status: String, val subnet: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vmDetails: List<DatabaseVmDetailsResponse>)

Define the Database resource.

Link copied to clipboard
data class GetSapDiscoverySiteResult(val azureApiVersion: String, val errors: SAPMigrateErrorResponse, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val masterSiteId: String? = null, val migrateProjectId: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Define the SAP Migration discovery site resource.

Link copied to clipboard
data class GetSAPDiskConfigurationsResult(val volumeConfigurations: Map<String, SAPDiskConfigurationResponse>? = null)

The list of disk configuration for vmSku which are part of SAP deployment.

Link copied to clipboard
data class GetSapInstanceResult(val application: String, val azureApiVersion: String, val environment: String, val errors: SAPMigrateErrorResponse, val id: String, val landscapeSid: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val systemSid: String, val tags: Map<String, String>? = null, val type: String)

Define the SAP Instance resource.

Link copied to clipboard
data class GetSapLandscapeMonitorResult(val azureApiVersion: String, val grouping: SapLandscapeMonitorPropertiesGroupingResponse? = null, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val topMetricsThresholds: List<SapLandscapeMonitorMetricThresholdsResponse>? = null, val type: String)

configuration associated with SAP Landscape Monitor Dashboard.

Link copied to clipboard
data class GetSAPSizingRecommendationsResult(val deploymentType: String)

The SAP sizing recommendation result.

Link copied to clipboard
data class GetSAPSupportedSkuResult(val supportedSkus: List<SAPSupportedSkuResponse>? = null)

The list of supported SKUs for different resources which are part of SAP deployment.

The list of supported availability zone pairs which are part of SAP HA deployment.

The list of disk configuration for vmSku which are part of SAP deployment.

The list of supported SKUs for different resources which are part of SAP deployment.

The SAP sizing recommendation result.

Link copied to clipboard
data class GetSapVirtualInstanceResult(val azureApiVersion: String, val configuration: Any, val environment: String, val errors: SAPVirtualInstanceErrorResponse, val health: String, val id: String, val identity: SAPVirtualInstanceIdentityResponse? = null, val location: String, val managedResourceGroupConfiguration: ManagedRGConfigurationResponse? = null, val managedResourcesNetworkAccessType: String? = null, val name: String, val provisioningState: String, val sapProduct: String, val state: String, val status: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Define the Virtual Instance for SAP solutions resource.

Link copied to clipboard
data class GetServerInstanceResult(val azureApiVersion: String, val configurationData: ConfigurationDataResponse, val errors: SAPMigrateErrorResponse, val id: String, val instanceSid: String, val name: String, val operatingSystem: String, val performanceData: Either<ExcelPerformanceDataResponse, NativePerformanceDataResponse>, val provisioningState: String, val sapInstanceType: String, val sapProduct: String, val sapProductVersion: String, val serverName: String, val systemData: SystemDataResponse, val type: String)

Define the Server Instance resource.

Link copied to clipboard
data class HanaBackupDataResponse(val backupPolicy: DBBackupPolicyPropertiesResponse, val backupType: String, val dbInstanceSnapshotBackupPolicy: DBBackupPolicyPropertiesResponse? = null, val hdbuserstoreKeyName: String, val instanceNumber: String? = null, val recoveryServicesVault: Either<ExistingRecoveryServicesVaultResponse, NewRecoveryServicesVaultResponse>, val sslConfiguration: SSLConfigurationResponse? = null)

Defines the HANA Backup data for a virtual instance for SAP.

Link copied to clipboard
data class HanaDbProviderInstancePropertiesResponse(val dbName: String? = null, val dbPassword: String? = null, val dbPasswordUri: String? = null, val dbUsername: String? = null, val hostname: String? = null, val instanceNumber: String? = null, val providerType: String, val sapSid: String? = null, val sqlPort: String? = null, val sslCertificateUri: String? = null, val sslHostNameInCertificate: String? = null, val sslPreference: String? = null)

Gets or sets the provider properties.

Link copied to clipboard
data class HealthResponse(val healthState: String, val impactingReasons: String)

Resource health details

Link copied to clipboard
data class HighAvailabilityConfigurationResponse(val highAvailabilityType: String)

Gets or sets the high availability configuration.

data class HighAvailabilitySoftwareConfigurationResponse(val fencingClientId: String, val fencingClientPassword: String)

Gets or sets the HA software configuration.

Link copied to clipboard
data class HourlyScheduleResponse(val interval: Int? = null, val scheduleWindowDuration: Int? = null, val scheduleWindowStartTime: String? = null)

Hourly schedule.

Link copied to clipboard
data class ImageReferenceResponse(val id: String? = null, val offer: String? = null, val publisher: String? = null, val sku: String? = null, val version: String? = null)

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Link copied to clipboard
data class InstantRPAdditionalDetailsResponse(val azureBackupRGNamePrefix: String? = null, val azureBackupRGNameSuffix: String? = null)

Instant recovery point additional details.

Link copied to clipboard
data class LinuxConfigurationResponse(val disablePasswordAuthentication: Boolean? = null, val osType: String, val ssh: SshConfigurationResponse? = null, val sshKeyPair: SshKeyPairResponse? = null)

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Link copied to clipboard

The Load Balancer details such as Load Balancer ID.

Link copied to clipboard
data class LoadBalancerResourceNamesResponse(val backendPoolNames: List<String>? = null, val frontendIpConfigurationNames: List<String>? = null, val healthProbeNames: List<String>? = null, val loadBalancerName: String? = null)

The resource names object for load balancer and related resources.

Link copied to clipboard
data class LogSchedulePolicyResponse(val scheduleFrequencyInMins: Int? = null, val schedulePolicyType: String)

Log policy schedule.

Link copied to clipboard
data class LongTermRetentionPolicyResponse(val dailySchedule: DailyRetentionScheduleResponse? = null, val monthlySchedule: MonthlyRetentionScheduleResponse? = null, val retentionPolicyType: String, val weeklySchedule: WeeklyRetentionScheduleResponse? = null, val yearlySchedule: YearlyRetentionScheduleResponse? = null)

Long term retention policy.

Link copied to clipboard
data class LongTermSchedulePolicyResponse(val schedulePolicyType: String)

Long term policy schedule.

Managed resource group configuration

Link copied to clipboard
data class ManagedRGConfigurationResponse(val name: String? = null)

Managed resource group configuration

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

Managed service identity (system assigned and/or user assigned identities)

Link copied to clipboard
data class MessageServerPropertiesResponse(val health: String, val hostname: String, val httpPort: Double, val httpsPort: Double, val internalMsPort: Double, val ipAddress: String, val msPort: Double)

Defines the SAP message server properties.

Link copied to clipboard
data class MonthlyRetentionScheduleResponse(val retentionDuration: RetentionDurationResponse? = null, val retentionScheduleDaily: DailyRetentionFormatResponse? = null, val retentionScheduleFormatType: String? = null, val retentionScheduleWeekly: WeeklyRetentionFormatResponse? = null, val retentionTimes: List<String>? = null)

Monthly retention schedule.

Link copied to clipboard
data class MountFileShareConfigurationResponse(val configurationType: String, val id: String, val privateEndpointId: String)

Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow.

data class MsSqlServerProviderInstancePropertiesResponse(val dbPassword: String? = null, val dbPasswordUri: String? = null, val dbPort: String? = null, val dbUsername: String? = null, val hostname: String? = null, val providerType: String, val sapSid: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the SQL server provider properties.

Link copied to clipboard
data class NativePerformanceDataResponse(val dataSource: String)

The SAP instance specific performance data for native discovery.

Link copied to clipboard
data class NetworkConfigurationResponse(val isSecondaryIpEnabled: Boolean? = null)

Defines the network configuration type for SAP system infrastructure that is being deployed

Link copied to clipboard
data class NetworkInterfaceResourceNamesResponse(val networkInterfaceName: String? = null)

The resource names object for network interface and related resources.

Link copied to clipboard
data class NewRecoveryServicesVaultResponse(val name: String, val resourceGroup: String, val vaultType: String)

New recovery services vault.

Link copied to clipboard
data class OracleProviderInstancePropertiesResponse(val dbName: String? = null, val dbPassword: String? = null, val dbPasswordUri: String? = null, val dbPort: String? = null, val dbUsername: String? = null, val hostname: String? = null, val providerType: String, val sapSid: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the Oracle provider properties.

Link copied to clipboard
data class OSProfileResponse(val adminPassword: String? = null, val adminUsername: String? = null, val osConfiguration: Either<LinuxConfigurationResponse, WindowsConfigurationResponse>? = null)

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Link copied to clipboard
data class OsSapConfigurationResponse(val deployerVmPackages: DeployerVmPackagesResponse? = null, val sapFqdn: String? = null)

Defines the OS and SAP Configurations for Deployment

data class PrometheusHaClusterProviderInstancePropertiesResponse(val clusterName: String? = null, val hostname: String? = null, val prometheusUrl: String? = null, val providerType: String, val sid: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the PrometheusHaCluster provider properties.

data class PrometheusOsProviderInstancePropertiesResponse(val prometheusUrl: String? = null, val providerType: String, val sapSid: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the PrometheusOS provider properties.

Link copied to clipboard
data class RetentionDurationResponse(val count: Int? = null, val durationType: String? = null)

Retention duration.

Link copied to clipboard
data class SAPAvailabilityZonePairResponse(val zoneA: Double? = null, val zoneB: Double? = null)

The SAP Availability Zone Pair.

Link copied to clipboard
data class SAPDiskConfigurationResponse(val recommendedConfiguration: DiskVolumeConfigurationResponse? = null, val supportedConfigurations: List<DiskDetailsResponse>? = null)

The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type.

data class SAPInstallWithoutOSConfigSoftwareConfigurationResponse(val bomUrl: String, val highAvailabilitySoftwareConfiguration: HighAvailabilitySoftwareConfigurationResponse? = null, val sapBitsStorageAccountId: String, val softwareInstallationType: String, val softwareVersion: String)

The SAP Software configuration Input when the software is to be installed by service without OS Configurations

data class SapLandscapeMonitorMetricThresholdsResponse(val green: Double? = null, val name: String? = null, val red: Double? = null, val yellow: Double? = null)

Gets or sets the Threshold Values for Top Metrics Health.

Gets or sets the SID groupings by landscape and Environment.

Link copied to clipboard
data class SapLandscapeMonitorSidMappingResponse(val name: String? = null, val topSid: List<String>? = null)

Gets or sets the mapping for SID to Environment/Applications.

Link copied to clipboard
data class SAPMigrateErrorResponse(val code: String, val details: List<ErrorDefinitionResponse>, val message: String, val recommendation: String)

An error response from the SAP migrate resources.

data class SapNetWeaverProviderInstancePropertiesResponse(val providerType: String, val sapClientId: String? = null, val sapHostFileEntries: List<String>? = null, val sapHostname: String? = null, val sapInstanceNr: String? = null, val sapPassword: String? = null, val sapPasswordUri: String? = null, val sapPortNumber: String? = null, val sapSid: String? = null, val sapUsername: String? = null, val sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the provider properties.

Link copied to clipboard
data class SAPSupportedSkuResponse(val isAppServerCertified: Boolean? = null, val isDatabaseCertified: Boolean? = null, val vmSku: String? = null)

The SAP supported SKU.

Link copied to clipboard
data class SAPVirtualInstanceErrorResponse(val properties: ErrorDefinitionResponse? = null)

An error response from the Virtual Instance for SAP Workload service.

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

Managed service identity (user assigned identities)

data class ServiceInitiatedSoftwareConfigurationResponse(val bomUrl: String, val highAvailabilitySoftwareConfiguration: HighAvailabilitySoftwareConfigurationResponse? = null, val sapBitsStorageAccountId: String, val sapFqdn: String, val softwareInstallationType: String, val softwareVersion: String, val sshPrivateKey: String)

The SAP Software configuration Input when the software is to be installed by service.

Link copied to clipboard
data class SettingsResponse(val isCompression: Boolean? = null, val issqlcompression: Boolean? = null, val timeZone: String? = null)

Common settings field for backup management

Link copied to clipboard
data class SharedStorageResourceNamesResponse(val sharedStorageAccountName: String? = null, val sharedStorageAccountPrivateEndPointName: String? = null)

The resource names object for shared storage.

Link copied to clipboard
data class SimpleRetentionPolicyResponse(val retentionDuration: RetentionDurationResponse? = null, val retentionPolicyType: String)

Simple policy retention.

Link copied to clipboard
data class SimpleSchedulePolicyResponse(val hourlySchedule: HourlyScheduleResponse? = null, val schedulePolicyType: String, val scheduleRunDays: List<String>? = null, val scheduleRunFrequency: String? = null, val scheduleRunTimes: List<String>? = null, val scheduleWeeklyFrequency: Int? = null)

Simple policy schedule.

Link copied to clipboard
data class SimpleSchedulePolicyV2Response(val dailySchedule: DailyScheduleResponse? = null, val hourlySchedule: HourlyScheduleResponse? = null, val schedulePolicyType: String, val scheduleRunFrequency: String? = null, val weeklySchedule: WeeklyScheduleResponse? = null)

The V2 policy schedule for IaaS that supports hourly backups.

Link copied to clipboard
data class SingleServerConfigurationResponse(val appResourceGroup: String, val customResourceNames: SingleServerFullResourceNamesResponse? = null, val databaseType: String? = null, val dbDiskConfiguration: DiskConfigurationResponse? = null, val deploymentType: String, val networkConfiguration: NetworkConfigurationResponse? = null, val subnetId: String, val virtualMachineConfiguration: VirtualMachineConfigurationResponse)

Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see here

Link copied to clipboard
data class SingleServerFullResourceNamesResponse(val namingPatternType: String, val virtualMachine: VirtualMachineResourceNamesResponse? = null)

The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system.

Link copied to clipboard
data class SkipFileShareConfigurationResponse(val configurationType: String)

Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required.

Link copied to clipboard
data class SnapshotBackupAdditionalDetailsResponse(val instantRPDetails: String? = null, val instantRpRetentionRangeInDays: Int? = null, val userAssignedManagedIdentityDetails: UserAssignedManagedIdentityDetailsResponse? = null)

Snapshot Backup related fields for WorkloadType SAP Hana system

Link copied to clipboard
data class SqlBackupDataResponse(val backupPolicy: DBBackupPolicyPropertiesResponse, val backupType: String, val recoveryServicesVault: Either<ExistingRecoveryServicesVaultResponse, NewRecoveryServicesVaultResponse>)

Defines the SQL Backup data for a virtual instance for SAP.

Link copied to clipboard
data class SshConfigurationResponse(val publicKeys: List<SshPublicKeyResponse>? = null)

SSH configuration for Linux based VMs running on Azure

Link copied to clipboard
data class SshKeyPairResponse(val privateKey: String? = null, val publicKey: String? = null)

The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

Link copied to clipboard
data class SshPublicKeyResponse(val keyData: String? = null)

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Link copied to clipboard
data class SSLConfigurationResponse(val sslCryptoProvider: String? = null, val sslHostNameInCertificate: String? = null, val sslKeyStore: String? = null, val sslTrustStore: String? = null)

Specify the HANA database TLS/SSL properties which will be used for enabling Azure Backup for this database. You need to specify these details if you have enabled secure communication for your HANA database.

Link copied to clipboard
data class StorageConfigurationResponse(val transportFileShareConfiguration: Any? = null)

Gets or sets the storage configuration.

Link copied to clipboard

Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage.

Link copied to clipboard
data class SubProtectionPolicyResponse(val policyType: String? = null, val retentionPolicy: Either<LongTermRetentionPolicyResponse, SimpleRetentionPolicyResponse>? = null, val schedulePolicy: Any? = null, val snapshotBackupAdditionalDetails: SnapshotBackupAdditionalDetailsResponse? = null, val tieringPolicy: Map<String, TieringPolicyResponse>? = null)

Sub-protection policy which includes schedule and retention

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 ThreeTierConfigurationResponse(val appResourceGroup: String, val applicationServer: ApplicationServerConfigurationResponse, val centralServer: CentralServerConfigurationResponse, val customResourceNames: ThreeTierFullResourceNamesResponse? = null, val databaseServer: DatabaseConfigurationResponse, val deploymentType: String, val highAvailabilityConfig: HighAvailabilityConfigurationResponse? = null, val networkConfiguration: NetworkConfigurationResponse? = null, val storageConfiguration: StorageConfigurationResponse? = null)

Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see here

Link copied to clipboard
data class ThreeTierFullResourceNamesResponse(val applicationServer: ApplicationServerFullResourceNamesResponse? = null, val centralServer: CentralServerFullResourceNamesResponse? = null, val databaseServer: DatabaseServerFullResourceNamesResponse? = null, val namingPatternType: String, val sharedStorage: SharedStorageResourceNamesResponse? = null)

The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system.

Link copied to clipboard
data class TieringPolicyResponse(val duration: Int? = null, val durationType: String? = null, val tieringMode: String? = null)

Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier

Link copied to clipboard
data class UserAssignedIdentityPropertiesResponse(val clientId: String? = null, val principalId: String? = null)

User assigned managed identity properties.

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

User assigned identity properties

data class UserAssignedManagedIdentityDetailsResponse(val identityArmId: String? = null, val identityName: String? = null, val userAssignedIdentityProperties: UserAssignedIdentityPropertiesResponse? = null)

User assigned managed identity details.

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

Managed service identity (user assigned identities)

Link copied to clipboard
data class VirtualMachineConfigurationResponse(val imageReference: ImageReferenceResponse, val osProfile: OSProfileResponse, val vmSize: String)

Defines the virtual machine configuration.

Link copied to clipboard
data class VirtualMachineResourceNamesResponse(val dataDiskNames: Map<String, List<String>>? = null, val hostName: String? = null, val networkInterfaces: List<NetworkInterfaceResourceNamesResponse>? = null, val osDiskName: String? = null, val vmName: String? = null)

The resource names object for virtual machine and related resources.

Link copied to clipboard
data class VMBackupDataResponse(val backupPolicy: VMBackupPolicyPropertiesResponse, val backupType: String, val diskExclusionProperties: DiskExclusionPropertiesResponse? = null, val recoveryServicesVault: Either<ExistingRecoveryServicesVaultResponse, NewRecoveryServicesVaultResponse>)

Defines the VM Backup data for a virtual instance for SAP.

Link copied to clipboard
data class VMBackupPolicyPropertiesResponse(val backupManagementType: String, val instantRPDetails: InstantRPAdditionalDetailsResponse? = null, val instantRpRetentionRangeInDays: Int? = null, val name: String, val policyType: String? = null, val protectedItemsCount: Int? = null, val resourceGuardOperationRequests: List<String>? = null, val retentionPolicy: Either<LongTermRetentionPolicyResponse, SimpleRetentionPolicyResponse>? = null, val schedulePolicy: Any? = null, val tieringPolicy: Map<String, TieringPolicyResponse>? = null, val timeZone: String? = null)

Defines the policy properties for virtual machine backup.

Link copied to clipboard
data class WeeklyRetentionFormatResponse(val daysOfTheWeek: List<String>? = null, val weeksOfTheMonth: List<String>? = null)

Weekly retention format.

Link copied to clipboard
data class WeeklyRetentionScheduleResponse(val daysOfTheWeek: List<String>? = null, val retentionDuration: RetentionDurationResponse? = null, val retentionTimes: List<String>? = null)

Weekly retention schedule.

Link copied to clipboard
data class WeeklyScheduleResponse(val scheduleRunDays: List<String>? = null, val scheduleRunTimes: List<String>? = null)

Weekly schedule.

Link copied to clipboard
data class WindowsConfigurationResponse(val osType: String)

Specifies Windows operating system settings on the virtual machine.

Link copied to clipboard
data class YearlyRetentionScheduleResponse(val monthsOfYear: List<String>? = null, val retentionDuration: RetentionDurationResponse? = null, val retentionScheduleDaily: DailyRetentionFormatResponse? = null, val retentionScheduleFormatType: String? = null, val retentionScheduleWeekly: WeeklyRetentionFormatResponse? = null, val retentionTimes: List<String>? = null)

Yearly retention schedule.