Package-level declarations

Types

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

Gets or sets the application server configuration.

Link copied to clipboard
data class BackupProfileResponse(val backupEnabled: String, val vaultResourceId: String)

Backup profile

Link copied to clipboard
data class CacheProfileResponse(val cacheResourceId: String, val capacity: Double, val family: String, val name: String? = null, val skuName: String)

Cache profile

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 CentralServerVmDetailsResponse(val storageDetails: List<StorageInformationResponse>, val type: String, val virtualMachineId: String)

The SAP Central Services Instance VM details.

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.

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 DatabaseProfileResponse(val backupRetentionDays: Int? = null, val haEnabled: String? = null, val serverName: String? = null, val serverResourceId: String, val sku: String, val sslEnforcementEnabled: String? = null, val storageInGB: Double? = null, val storageIops: Double? = null, val storageSku: String? = null, val tier: String, val type: String, val version: String? = null)

Workload database profile

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 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 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)

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 DiskInfoResponse(val sizeInGB: Double? = null, val storageType: String)

Disk resource creation details

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

The disk sku.

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 ErrorDefinitionResponse(val code: String, val details: List<ErrorDefinitionResponse>, val message: String)

Error definition.

Link copied to clipboard
data class ErrorResponse(val code: String, val details: List<ErrorResponse>, val innerError: ErrorResponseInnerError, val message: String, val target: String)

Standard error object.

Link copied to clipboard
data class ErrorResponseInnerError(val innerError: ErrorResponse? = null)

Object containing more specific information than the current object about the error.

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 FileshareProfileResponse(val shareName: String, val shareSizeInGB: Double? = null, val shareType: String, val storageResourceId: String, val storageType: String)

File share profile

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 GetmonitorResult(val appLocation: String? = null, val errors: MonitorPropertiesResponseErrors, val id: String, val identity: UserAssignedServiceIdentityResponse? = null, val location: String, val logAnalyticsWorkspaceArmId: String? = null, val managedResourceGroupConfiguration: ManagedRGConfigurationResponse? = 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 GetPhpWorkloadResult(val adminUserProfile: UserProfileResponse, val appLocation: String, val backupProfile: BackupProfileResponse? = null, val cacheProfile: CacheProfileResponse? = null, val controllerProfile: NodeProfileResponse, val databaseProfile: DatabaseProfileResponse, val fileshareProfile: FileshareProfileResponse? = null, val id: String, val identity: PhpWorkloadResourceResponseIdentity? = null, val kind: String, val location: String, val managedResourceGroupConfiguration: ManagedRGConfigurationResponse? = null, val name: String, val networkProfile: NetworkProfileResponse? = null, val phpProfile: PhpProfileResponse? = null, val provisioningState: String, val searchProfile: SearchProfileResponse? = null, val siteProfile: SiteProfileResponse? = null, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val webNodesProfile: VmssNodesProfileResponse)

Php workload resource

Link copied to clipboard
data class GetProviderInstanceResult(val errors: ProviderInstancePropertiesResponseErrors, val id: String, val identity: UserAssignedServiceIdentityResponse? = null, 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 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 location: String, val name: String, val provisioningState: String, val status: String, val storageDetails: List<StorageInformationResponse>, val subnet: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualMachineId: String)

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 GetSAPCentralInstanceResult(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 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 GetSAPDiskConfigurationsResult(val diskConfigurations: List<SAPDiskConfigurationResponse>? = null)

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

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.

Link copied to clipboard
data class GetSAPVirtualInstanceResult(val configuration: Any, val environment: String, val errors: SAPVirtualInstanceErrorResponse, val health: String, val id: String, val identity: UserAssignedServiceIdentityResponse? = null, val location: String, val managedResourceGroupConfiguration: ManagedRGConfigurationResponse? = 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 GetWordpressInstanceResult(val databaseName: String? = null, val databaseUser: String? = null, val id: String, val name: String, val provisioningState: String, val siteUrl: String, val systemData: SystemDataResponse, val type: String, val version: String)

WordPress instance resource

Link copied to clipboard
data class HanaDbProviderInstancePropertiesResponse(val dbName: String? = null, val dbPassword: String? = null, val dbPasswordUri: String? = null, val dbSslCertificateUri: String? = null, val dbUsername: String? = null, val hostname: String? = null, val instanceNumber: String? = null, val providerType: String, 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 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 ImageReferenceResponse(val exactVersion: String, val offer: String? = null, val publisher: String? = null, val sharedGalleryImageId: 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 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 ManagedRGConfigurationResponse(val name: String? = null)

Managed resource group configuration

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 MonitorPropertiesResponseErrors(val code: String, val details: List<ErrorResponse>, val innerError: ErrorResponseInnerError, val message: String, val target: String)

Defines the SAP monitor errors.

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 NetworkConfigurationResponse(val isSecondaryIpEnabled: Boolean? = null)

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

Link copied to clipboard
data class NetworkProfileResponse(val azureFrontDoorEnabled: String? = null, val azureFrontDoorResourceId: String, val capacity: Int? = null, val frontEndPublicIpResourceId: String, val loadBalancerResourceId: String, val loadBalancerSku: String? = null, val loadBalancerTier: String? = null, val loadBalancerType: String, val outboundPublicIpResourceIds: List<String>, val vNetResourceId: String)

Network profile

Link copied to clipboard
data class NodeProfileResponse(val dataDisks: List<DiskInfoResponse>? = null, val name: String? = null, val nodeResourceIds: List<String>, val nodeSku: String, val osDisk: DiskInfoResponse, val osImage: OsImageProfileResponse)

VM or VMSS node profile

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

OS image profile

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

Link copied to clipboard
data class PhpProfileResponse(val version: String)

PHP profile

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

Identity for the resource. Currently not supported

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 sslCertificateUri: String? = null, val sslPreference: String? = null)

Gets or sets the PrometheusOS provider properties.

Link copied to clipboard
data class ProviderInstancePropertiesResponseErrors(val code: String, val details: List<ErrorResponse>, val innerError: ErrorResponseInnerError, val message: String, val target: String)

Defines the provider instance errors.

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 diskCount: Double? = null, val diskIopsReadWrite: Double? = null, val diskMBpsReadWrite: Double? = null, val diskSizeGB: Double? = null, val diskStorageType: String? = null, val diskType: String? = null, val volume: String? = null)

The SAP Disk Configuration.

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 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 sapSslCertificateUri: 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 SearchProfileResponse(val dataDisks: List<DiskInfoResponse>? = null, val name: String? = null, val nodeResourceIds: List<String>, val nodeSku: String, val osDisk: DiskInfoResponse, val osImage: OsImageProfileResponse, val searchType: String)

Search profile

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 SingleServerConfigurationResponse(val appResourceGroup: String, 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.

Link copied to clipboard
data class SiteProfileResponse(val domainName: String? = null)

Workload website profile

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 SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

The resource model definition representing SKU

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

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

User assigned identity properties

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 UserProfileResponse(val sshPublicKey: String, val userName: String)

User profile to configure on a compute resources such as VM, VMSS

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 VmssNodesProfileResponse(val autoScaleMaxCount: Int? = null, val autoScaleMinCount: Int? = null, val dataDisks: List<DiskInfoResponse>? = null, val name: String? = null, val nodeResourceIds: List<String>, val nodeSku: String, val osDisk: DiskInfoResponse, val osImage: OsImageProfileResponse)

VMSS profile

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

Specifies Windows operating system settings on the virtual machine.