{
"swagger": "2.0",
"info": {
"version": "2023-10-01-preview",
"title": "Workloads Client",
"description": "Workloads client provides access to various workload operations."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSizingRecommendations": {
"post": {
"tags": [
"SAPRecommendations"
],
"description": "Get SAP sizing recommendations by providing input SAPS for application tier and memory required for database tier",
"operationId": "SAPSizingRecommendations",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "SAPSizingRecommendation",
"description": "SAP Sizing Recommendation Request body",
"in": "body",
"schema": {
"$ref": "#/definitions/SAPSizingRecommendationRequest"
}
}
],
"responses": {
"200": {
"description": "SAP Sizing Recommendation Result.",
"schema": {
"$ref": "#/definitions/SAPSizingRecommendationResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"SAPSizingRecommendations_S4HANA_Distributed": {
"$ref": "./examples/sapvirtualinstances/SAPSizingRecommendations_S4HANA_Distributed.json"
},
"SAPSizingRecommendations_S4HANA_SingleServer": {
"$ref": "./examples/sapvirtualinstances/SAPSizingRecommendations_S4HANA_SingleServer.json"
},
"SAPSizingRecommendations_S4HANA_DistributedHA_AvSet": {
"$ref": "./examples/sapvirtualinstances/SAPSizingRecommendations_S4HANA_HA_AvSet.json"
},
"SAPSizingRecommendations_S4HANA_DistributedHA_AvZone": {
"$ref": "./examples/sapvirtualinstances/SAPSizingRecommendations_S4HANA_HA_AvZone.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getSapSupportedSku": {
"post": {
"tags": [
"SAPSupportedSku"
],
"description": "Get a list of SAP supported SKUs for ASCS, Application and Database tier.",
"operationId": "SAPSupportedSku",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "SAPSupportedSku",
"description": "SAP Supported SKU Request body",
"in": "body",
"schema": {
"$ref": "#/definitions/SAPSupportedSkusRequest"
}
}
],
"responses": {
"200": {
"description": "SAP Supported SKU Result.",
"schema": {
"$ref": "#/definitions/SAPSupportedResourceSkusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"SAPSupportedSkus_Distributed": {
"$ref": "./examples/sapvirtualinstances/SAPSupportedSkus_Distributed.json"
},
"SAPSupportedSkus_SingleServer": {
"$ref": "./examples/sapvirtualinstances/SAPSupportedSkus_SingleServer.json"
},
"SAPSupportedSkus_DistributedHA_AvSet": {
"$ref": "./examples/sapvirtualinstances/SAPSupportedSkus_DistributedHA_AvSet.json"
},
"SAPSupportedSkus_DistributedHA_AvZone": {
"$ref": "./examples/sapvirtualinstances/SAPSupportedSkus_DistributedHA_AvZone.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getDiskConfigurations": {
"post": {
"tags": [
"SAPDiskConfigurations"
],
"description": "Get the SAP Disk Configuration Layout prod/non-prod SAP System.",
"operationId": "SAPDiskConfigurations",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "SAPDiskConfigurations",
"description": "SAP Disk Configurations Request body",
"in": "body",
"schema": {
"$ref": "#/definitions/SAPDiskConfigurationsRequest"
}
}
],
"responses": {
"200": {
"description": "SAP Disk Configurations Result.",
"schema": {
"$ref": "#/definitions/SAPDiskConfigurationsResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"SAPDiskConfigurations_Prod": {
"$ref": "./examples/sapvirtualinstances/SAPDiskConfigurations_Prod.json"
},
"SAPDiskConfigurations_NonProd": {
"$ref": "./examples/sapvirtualinstances/SAPDiskConfigurations_NonProd.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/locations/{location}/sapVirtualInstanceMetadata/default/getAvailabilityZoneDetails": {
"post": {
"tags": [
"SAPAvailabilityZoneDetails"
],
"description": "Get the recommended SAP Availability Zone Pair Details for your region.",
"operationId": "SAPAvailabilityZoneDetails",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "SAPAvailabilityZoneDetails",
"description": "SAP Availability Zone Details Request body",
"in": "body",
"schema": {
"$ref": "#/definitions/SAPAvailabilityZoneDetailsRequest"
}
}
],
"responses": {
"200": {
"description": "SAP Availability Zone Details Result.",
"schema": {
"$ref": "#/definitions/SAPAvailabilityZoneDetailsResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"SAPAvailabilityZoneDetails_eastus": {
"$ref": "./examples/sapvirtualinstances/SAPAvailabilityZoneDetails_eastus.json"
},
"SAPAvailabilityZoneDetails_northeurope": {
"$ref": "./examples/sapvirtualinstances/SAPAvailabilityZoneDetails_northeurope.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}": {
"put": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Register existing SAP system as Virtual Instance for SAP solutions.": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Discover.json"
},
"Register existing SAP system as Virtual Instance for SAP solutions with optional customizations.": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Discover_CustomMrgStorageAccountName.json"
},
"Create Infrastructure with OS configuration for Single Server System (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_WithOSConfig_SingleServer.json"
},
"Create Infrastructure with OS configuration for Distributed System (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_WithOSConfig_Distributed.json"
},
"Create Infrastructure with OS configuration for HA System with Availability Set (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_WithOSConfig_HA_AvSet.json"
},
"Create Infrastructure with OS configuration for HA System with Availability Zone (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_WithOSConfig_HA_AvZone.json"
},
"Create Infrastructure only for Distributed System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Distributed.json"
},
"Create Infrastructure only for HA System with Availability Set": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_HA_AvSet.json"
},
"Create Infrastructure only for HA System with Availability Zone": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_HA_AvZone.json"
},
"Create Infrastructure only for Single Server System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_SingleServer.json"
},
"Create Infrastructure without a SAP Transport Directory Fileshare": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Distributed_SkipTransport.json"
},
"Create Infrastructure with a new SAP Transport Directory Fileshare": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Distributed_CreateTransport.json"
},
"Create Infrastructure with an existing SAP Transport Directory Fileshare": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Distributed_MountTransport.json"
},
"Detect SAP Software Installation on a Single Server System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_DetectInstallation_SingleServer.json"
},
"Detect SAP Software Installation on a Distributed System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_DetectInstallation_Distributed.json"
},
"Detect SAP Software Installation on an HA System with Availability Set": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_DetectInstallation_HA_AvSet.json"
},
"Detect SAP Software Installation on an HA System with Availability Zone": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_DetectInstallation_HA_AvZone.json"
},
"Install SAP Software on Single Server System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Install_SingleServer.json"
},
"Install SAP Software on Distributed System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Install_Distributed.json"
},
"Create Infrastructure with Disk and OS configurations for Single Server System (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_DiskDetails_SingleServer.json"
},
"Create Infrastructure with Disk and OS configuration for Distributed System (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_DiskDetails_Distributed.json"
},
"Create Infrastructure with Disk and OS configuration for HA System with Availability Set (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_DiskDetails_HA_AvSet.json"
},
"Create Infrastructure with Disk and OS configuration for HA System with Availability Zone (Recommended)": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_DiskDetails_HA_AvZone.json"
},
"Create Infrastructure (with OS configuration) with custom resource names for Single Server System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_CustomFullResourceNames_SingleServer.json"
},
"Create Infrastructure (with OS configuration) with custom resource names for Distributed System": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_CustomFullResourceNames_Distributed.json"
},
"Create Infrastructure (with OS configuration) with custom resource names for HA System with Availability Set": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_CustomFullResourceNames_HA_AvSet.json"
},
"Create Infrastructure (with OS configuration) with custom resource names for HA system with Availability Zone": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_CustomFullResourceNames_HA_AvZone.json"
},
"Create Infrastructure (with OS configuration) with Azure Compute Gallery Image": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Custom_Image.json"
},
"Create Infrastructure (with OS configuration) with trusted access enabled": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_WithOSConfig_WithTrustedAccess.json"
},
"Register with trusted access enabled": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Create_Discover_TrustedAccessEnable.json"
}
},
"description": "Creates a Virtual Instance for SAP solutions (VIS) resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"description": "Virtual Instance for SAP solutions resource request body.",
"name": "body",
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
}
],
"responses": {
"201": {
"description": "Describes the Virtual Instance for SAP solutions resource created.",
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
},
"200": {
"description": "Describes the Virtual Instance for SAP solutions resource which is updated successfully.",
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"get": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Get",
"x-ms-examples": {
"SAPVirtualInstances_Get": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Get.json"
},
"SAPVirtualInstances Get With ACSS Installation Blocked": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Get_ACSSInstallationBlocked.json"
}
},
"description": "Gets a Virtual Instance for SAP solutions resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the Virtual Instance for SAP solutions resource",
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Update",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"SAPVirtualInstances_Update": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Update.json"
},
"SAPVirtualInstances_TrustedAccessEnable_Update": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_TrustedAccessEnable_Update.json"
}
},
"description": "Updates a Virtual Instance for SAP solutions resource",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Request body to update a Virtual Instance for SAP solutions resource.",
"schema": {
"$ref": "#/definitions/UpdateSAPVirtualInstanceRequest"
}
}
],
"responses": {
"202": {
"description": "Describes the Virtual Instance for SAP solutions resource which is successfully updated.",
"headers": {
"Location": {
"type": "string",
"description": "URL to poll for status updates."
}
},
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
},
"200": {
"description": "Describes the Virtual Instance for SAP solutions resource which is successfully updated.",
"schema": {
"$ref": "#/definitions/SAPVirtualInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Delete",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPVirtualInstances_Delete": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Delete.json"
}
},
"description": "Deletes a Virtual Instance for SAP solutions resource and its child resources, that is the associated Central Services Instance, Application Server Instances and Database Instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "URL to poll for status updates."
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances": {
"get": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_ListByResourceGroup",
"x-ms-examples": {
"SAPVirtualInstances_ListByResourceGroup": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"description": "Gets all Virtual Instances for SAP solutions resources in a Resource Group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The list of all Virtual Instances for SAP solutions resources.",
"schema": {
"$ref": "#/definitions/SAPVirtualInstanceList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Workloads/sapVirtualInstances": {
"get": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_ListBySubscription",
"x-ms-examples": {
"SAPVirtualInstances_ListBySubscription": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"description": "Gets all Virtual Instances for SAP solutions resources in a Subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The list of all Virtual Instances for SAP solutions resources in the Subscription.",
"schema": {
"$ref": "#/definitions/SAPVirtualInstanceList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}": {
"get": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_Get",
"x-ms-examples": {
"SAPCentralInstances_Get": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_Get.json"
}
},
"description": "Gets the SAP Central Services Instance resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the SAP Central Services Instance resource.",
"schema": {
"$ref": "#/definitions/SAPCentralServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPCentralInstances_Create": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_Create.json"
},
"Create SAP Central Instances for HA System with Availability Set": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_Create_HA_AvSet.json"
}
},
"description": "Creates the SAP Central Services Instance resource.
This will be used by service only. PUT operation on this resource by end user will return a Bad Request error.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The SAP Central Services Instance request body.",
"schema": {
"$ref": "#/definitions/SAPCentralServerInstance"
}
}
],
"responses": {
"201": {
"description": "Describes the SAP Central Services Instance resource created.",
"schema": {
"$ref": "#/definitions/SAPCentralServerInstance"
}
},
"200": {
"description": "Describes the SAP Central Services Instance resource updated.",
"schema": {
"$ref": "#/definitions/SAPCentralServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_Update",
"x-ms-examples": {
"SAPCentralInstances_Update": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_Update.json"
}
},
"description": "Updates the SAP Central Services Instance resource.
This can be used to update tags on the resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The SAP Central Services Instance resource request body.",
"schema": {
"$ref": "#/definitions/UpdateSAPCentralInstanceRequest"
}
}
],
"responses": {
"200": {
"description": "Describes the SAP Central Services Instance resource created.",
"schema": {
"$ref": "#/definitions/SAPCentralServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_Delete",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPCentralInstances_Delete": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_Delete.json"
}
},
"description": "Deletes the SAP Central Services Instance resource.
This will be used by service only. Delete operation on this resource by end user will return a Bad Request error. You can delete the parent resource, which is the Virtual Instance for SAP solutions resource, using the delete operation on it.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated SAP Central Services Instance resource."
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances": {
"get": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_List",
"x-ms-examples": {
"SAPCentralInstances_List": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"description": "Lists the SAP Central Services Instance resource for the given Virtual Instance for SAP solutions resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the SAP Central Services Instance resource.",
"schema": {
"$ref": "#/definitions/SAPCentralInstanceList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}": {
"get": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_Get",
"x-ms-examples": {
"SAPDatabaseInstances_Get": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_Get.json"
}
},
"description": "Gets the SAP Database Instance resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the Database resource associated with the SAP system.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPDatabaseInstances_Create": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_Create.json"
},
"Create SAP Database Instances for HA System with Availability Set": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_Create_HA_AvSet.json"
}
},
"description": "Creates the Database resource corresponding to the Virtual Instance for SAP solutions resource.
This will be used by service only. PUT by end user will return a Bad Request error.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Request body of Database resource of a SAP system.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstance"
}
}
],
"responses": {
"201": {
"description": "Describes the created Database resource of the SAP system.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstance"
}
},
"200": {
"description": "Describes the updated Database resource of the SAP system.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_Update",
"x-ms-examples": {
"SAPDatabaseInstances_Update": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_Update.json"
}
},
"description": "Updates the Database instance resource. This can be used to update tags on the resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Database resource update request body.",
"schema": {
"$ref": "#/definitions/UpdateSAPDatabaseInstanceRequest"
}
}
],
"responses": {
"200": {
"description": "Describes the Database resource of the SAP system.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_Delete",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPDatabaseInstances_Delete": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_Delete.json"
}
},
"description": "Deletes the Database resource corresponding to a Virtual Instance for SAP solutions resource.
This will be used by service only. Delete by end user will return a Bad Request error.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated SAP Database Instance resource."
}
}
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances": {
"get": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_List",
"x-ms-examples": {
"SAPDatabaseInstances_List": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"description": "Lists the Database resources associated with a Virtual Instance for SAP solutions resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the Database resource corresponding to a Virtual Instance for SAP solutions resource.",
"schema": {
"$ref": "#/definitions/SAPDatabaseInstanceList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}": {
"get": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_Get",
"x-ms-examples": {
"SAPApplicationServerInstances_Get": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_Get.json"
}
},
"description": "Gets the SAP Application Server Instance corresponding to the Virtual Instance for SAP solutions resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Describes the SAP Application Server Instance.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"put": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPApplicationServerInstances_Create": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_Create.json"
},
"Create SAP Application Server Instances for HA System with Availability Set": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_Create_HA_AvSet.json"
}
},
"description": "Puts the SAP Application Server Instance resource.
This will be used by service only. PUT by end user will return a Bad Request error.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The SAP Application Server Instance resource request body.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstance"
}
}
],
"responses": {
"201": {
"description": "Describes the created SAP Application Server Instance resource.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstance"
}
},
"200": {
"description": "Describes the updated SAP Application Server Instance resource.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_Update",
"x-ms-examples": {
"SAPApplicationServerInstances_Update": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_Update.json"
}
},
"description": "Updates the SAP Application server instance resource. This can be used to update tags on the resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The SAP Application Server Instance resource request body.",
"schema": {
"$ref": "#/definitions/UpdateSAPApplicationInstanceRequest"
}
}
],
"responses": {
"200": {
"description": "Describes the SAP Application Server Instance resource.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstance"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_Delete",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPApplicationServerInstances_Delete": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_Delete.json"
}
},
"description": "Deletes the SAP Application Server Instance resource.
This operation will be used by service only. Delete by end user will return a Bad Request error.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"202": {
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated SAP Application Server Instance resource."
}
},
"description": "Accepted"
},
"204": {
"description": "NoContent"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances": {
"get": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_List",
"x-ms-examples": {
"SAPApplicationServerInstances_List": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"description": "Lists the SAP Application Server Instance resources for a given Virtual Instance for SAP solutions resource.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "List of SAP Application Server Instance resources.",
"schema": {
"$ref": "#/definitions/SAPApplicationServerInstanceList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/start": {
"post": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Start",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Start the SAP system": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Start.json"
},
"Start the virtual machines and the SAP system": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Start_WithInfraOperations.json"
}
},
"description": "Starts the SAP application, that is the Central Services instance and Application server instances.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The Virtual Instance for SAP solutions resource start request body.",
"schema": {
"$ref": "#/definitions/StartRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/stop": {
"post": {
"tags": [
"SAPVirtualInstances"
],
"operationId": "SAPVirtualInstances_Stop",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"SAPVirtualInstances_Stop": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Stop.json"
},
"Stop the virtual machine(s) and the SAP system on it.": {
"$ref": "./examples/sapvirtualinstances/SAPVirtualInstances_Stop_WithInfraOperations.json"
}
},
"description": "Stops the SAP Application, that is the Application server instances and Central Services instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "The Virtual Instance for SAP solutions resource stop request body.",
"schema": {
"$ref": "#/definitions/StopRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}/start": {
"post": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_StartInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Start the SAP Central Services Instance": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_StartInstance.json"
},
"Start the virtual machine(s) and the SAP central services instance on it.": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_StartInstance_WithInfraOperations.json"
}
},
"description": "Starts the SAP Central Services Instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "SAP Central Services instance start request body.",
"schema": {
"$ref": "#/definitions/StartRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated central instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/centralInstances/{centralInstanceName}/stop": {
"post": {
"tags": [
"SAPCentralInstances"
],
"operationId": "SAPCentralInstances_StopInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Stop the SAP Central Services Instance.": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_StopInstance.json"
},
"Stop the SAP Central Services Instance and its underlying Virtual Machine(s)": {
"$ref": "./examples/sapcentralinstances/SAPCentralInstances_StopInstance_WithInfraOperations.json"
}
},
"description": "Stops the SAP Central Services Instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/CentralInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "SAP Central Services instance stop request body.",
"schema": {
"$ref": "#/definitions/StopRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}/start": {
"post": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_StartInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Start the SAP Application Server Instance.": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_StartInstance.json"
},
"Start Virtual Machine and the SAP Application Server Instance on it.": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_StartInstance_WithInfraOperations.json"
}
},
"description": "Starts the SAP Application Server Instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "SAP Application server instance start request body.",
"schema": {
"$ref": "#/definitions/StartRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/applicationInstances/{applicationInstanceName}/stop": {
"post": {
"tags": [
"SAPApplicationServerInstances"
],
"operationId": "SAPApplicationServerInstances_StopInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Stop the SAP Application Server Instance": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_StopInstance.json"
},
"Stop the SAP Application Server Instance and the Virtual machine": {
"$ref": "./examples/sapapplicationinstances/SAPApplicationServerInstances_StopInstance_WithInfraOperations.json"
}
},
"description": "Stops the SAP Application Server Instance.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/SAPApplicationInstanceNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "SAP Application server instance stop request body.",
"schema": {
"$ref": "#/definitions/StopRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}/start": {
"post": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_StartInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Start the database instance of the SAP system.": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_StartInstance.json"
},
"Start Virtual Machine and the database instance of the SAP system on it.": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_StartInstance_WithInfraOperations.json"
}
},
"description": "Starts the database instance of the SAP system.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "SAP Database server instance start request body.",
"schema": {
"$ref": "#/definitions/StartRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}/databaseInstances/{databaseInstanceName}/stop": {
"post": {
"tags": [
"SAPDatabaseInstances"
],
"operationId": "SAPDatabaseInstances_StopInstance",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"produces": [
"application/json"
],
"x-ms-examples": {
"Stop the database instance of the SAP system.": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_StopInstance.json"
},
"Stop the database instance of the SAP system and the underlying Virtual Machine(s).": {
"$ref": "./examples/sapdatabaseinstances/SAPDatabaseInstances_StopInstance_WithInfraOperations.json"
}
},
"description": "Stops the database instance of the SAP system.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/SAPVirtualInstanceNameParameter"
},
{
"$ref": "#/parameters/DatabaseNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "Stop request for the database instance of the SAP system.",
"schema": {
"$ref": "#/definitions/StopRequest"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"headers": {
"Location": {
"type": "string",
"description": "The URI to fetch the updated Virtual Instance for SAP resource."
}
}
},
"200": {
"description": "OK",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"HealthState": {
"description": "Defines the health of SAP Instances.",
"enum": [
"Unknown",
"Healthy",
"Unhealthy",
"Degraded"
],
"type": "string",
"x-ms-enum": {
"name": "SAPHealthState",
"modelAsString": true
}
},
"DeploymentType": {
"description": "The type of SAP deployment, single server or Three tier.",
"enum": [
"SingleServer",
"ThreeTier"
],
"type": "string",
"x-ms-enum": {
"name": "SAPDeploymentType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"NamingPatternType": {
"description": "The pattern type to be used for resource naming.",
"enum": [
"FullResourceName"
],
"type": "string",
"x-ms-enum": {
"name": "NamingPatternType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"SAPSoftwareInstallationType": {
"description": "The SAP software installation Type.",
"enum": [
"ServiceInitiated",
"SAPInstallWithoutOSConfig",
"External"
],
"type": "string",
"x-ms-enum": {
"name": "SAPSoftwareInstallationType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"HighAvailabilityType": {
"description": "The high availability type (AvailabilitySet or AvailabilityZone).",
"enum": [
"AvailabilitySet",
"AvailabilityZone"
],
"type": "string",
"x-ms-enum": {
"name": "SAPHighAvailabilityType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"DatabaseScaleMethod": {
"description": "The database scale method.",
"enum": [
"ScaleUp"
],
"type": "string",
"x-ms-enum": {
"name": "SAPDatabaseScaleMethod",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"ConfigurationType": {
"description": "The configuration Type.",
"enum": [
"Deployment",
"Discovery",
"DeploymentWithOSConfig"
],
"type": "string",
"x-ms-enum": {
"name": "SAPConfigurationType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"SAPVirtualInstanceStatus": {
"description": "Defines the SAP Instance status.",
"enum": [
"Starting",
"Running",
"Stopping",
"Offline",
"PartiallyRunning",
"Unavailable",
"SoftShutdown"
],
"type": "string",
"x-ms-enum": {
"name": "SAPVirtualInstanceStatus",
"modelAsString": true
}
},
"SAPVirtualInstanceState": {
"description": "Defines the Virtual Instance for SAP state.",
"enum": [
"InfrastructureDeploymentPending",
"InfrastructureDeploymentInProgress",
"InfrastructureDeploymentFailed",
"SoftwareInstallationPending",
"SoftwareInstallationInProgress",
"SoftwareInstallationFailed",
"SoftwareDetectionInProgress",
"SoftwareDetectionFailed",
"DiscoveryPending",
"DiscoveryInProgress",
"DiscoveryFailed",
"RegistrationComplete",
"ACSSInstallationBlocked"
],
"type": "string",
"x-ms-enum": {
"name": "SAPVirtualInstanceState",
"modelAsString": true
}
},
"EnvironmentType": {
"description": "Defines the environment type - Production/Non Production.",
"enum": [
"NonProd",
"Prod"
],
"type": "string",
"x-ms-enum": {
"name": "SAPEnvironmentType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"CentralServerVirtualMachineType": {
"description": "Defines the type of central server VM.",
"enum": [
"Primary",
"Secondary",
"Unknown",
"ASCS",
"ERSInactive",
"ERS",
"Standby"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "CentralServerVirtualMachineType",
"modelAsString": true
},
"x-ms-mutability": [
"read"
]
},
"ApplicationServerVirtualMachineType": {
"description": "Defines the type of application server VM.",
"enum": [
"Active",
"Standby",
"Unknown"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "ApplicationServerVirtualMachineType",
"modelAsString": true
},
"x-ms-mutability": [
"read"
]
},
"SAPDatabaseType": {
"description": "Defines the supported SAP Database types.",
"enum": [
"HANA",
"DB2"
],
"type": "string",
"x-ms-enum": {
"name": "SAPDatabaseType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"SAPProductType": {
"description": "Defines the SAP Product type.",
"enum": [
"ECC",
"S4HANA",
"Other"
],
"type": "string",
"x-ms-enum": {
"name": "SAPProductType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"EnqueueReplicationServerType": {
"description": "Defines the type of Enqueue Replication Server.",
"enum": [
"EnqueueReplicator1",
"EnqueueReplicator2"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "EnqueueReplicationServerType",
"modelAsString": true
},
"x-ms-mutability": [
"read"
]
},
"ProvisioningState": {
"description": "Defines the provisioning states.",
"enum": [
"Succeeded",
"Updating",
"Creating",
"Failed",
"Deleting",
"Canceled"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "SapVirtualInstanceProvisioningState",
"modelAsString": true
}
},
"DiskSkuName": {
"description": "Defines the disk sku name.",
"enum": [
"Standard_LRS",
"Premium_LRS",
"StandardSSD_LRS",
"UltraSSD_LRS",
"Premium_ZRS",
"StandardSSD_ZRS",
"PremiumV2_LRS"
],
"type": "string",
"x-ms-enum": {
"name": "DiskSkuName",
"modelAsString": true
}
},
"ManagedResourcesNetworkAccessType": {
"description": "Defines the network access type for managed resources.",
"enum": [
"Public",
"Private"
],
"type": "string",
"x-ms-enum": {
"name": "ManagedResourcesNetworkAccessType",
"modelAsString": true
}
},
"SAPVirtualInstanceError": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"description": "The Virtual Instance for SAP error body.",
"$ref": "#/definitions/ErrorDefinition"
}
},
"description": "An error response from the Virtual Instance for SAP Workload service."
},
"UpdateSAPVirtualInstanceProperties": {
"description": "Defines the properties to be updated for Virtual Instance for SAP.",
"type": "object",
"properties": {
"managedResourcesNetworkAccessType": {
"$ref": "#/definitions/ManagedResourcesNetworkAccessType",
"description": "Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228",
"default": "Public"
}
}
},
"UpdateSAPVirtualInstanceRequest": {
"description": "Defines the request body for updating Virtual Instance for SAP.",
"type": "object",
"properties": {
"tags": {
"description": "Gets or sets the Resource tags.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"identity": {
"$ref": "../../../common-types/v1/commonTypes.json#/definitions/UserAssignedServiceIdentity"
},
"properties": {
"$ref": "#/definitions/UpdateSAPVirtualInstanceProperties"
}
}
},
"UpdateSAPApplicationInstanceRequest": {
"description": "Defines the request body for updating SAP Application Instance.",
"type": "object",
"properties": {
"tags": {
"description": "Gets or sets the Resource tags.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateSAPDatabaseInstanceRequest": {
"description": "Defines the request body for updating SAP Database Instance.",
"type": "object",
"properties": {
"tags": {
"description": "Gets or sets the Resource tags.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"UpdateSAPCentralInstanceRequest": {
"description": "Defines the request body for updating SAP Central Instance.",
"type": "object",
"properties": {
"tags": {
"description": "Gets or sets the Resource tags.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ImageReference": {
"type": "object",
"properties": {
"publisher": {
"type": "string",
"description": "The image publisher."
},
"offer": {
"type": "string",
"description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine."
},
"sku": {
"type": "string",
"description": "The image SKU."
},
"version": {
"type": "string",
"description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available."
},
"id": {
"type": "string",
"format": "arm-id",
"description": "Specifies the ARM resource ID of the Azure Compute Gallery image version used for creating ACSS VMs. You will need to provide this input when you choose to deploy virtual machines in ACSS with OS image from the Azure Compute gallery."
}
},
"description": "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."
},
"WindowsConfiguration": {
"type": "object",
"x-ms-discriminator-value": "Windows",
"allOf": [
{
"$ref": "#/definitions/OSConfiguration"
}
],
"properties": {},
"description": "Specifies Windows operating system settings on the virtual machine."
},
"SshPublicKey": {
"type": "object",
"properties": {
"keyData": {
"type": "string",
"description": "SSH public key certificate used to authenticate with the VM through ssh. 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](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)."
}
},
"description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed."
},
"SshConfiguration": {
"type": "object",
"properties": {
"publicKeys": {
"type": "array",
"items": {
"$ref": "#/definitions/SshPublicKey"
},
"description": "The list of SSH public keys used to authenticate with linux based VMs.",
"x-ms-identifiers": []
}
},
"description": "SSH configuration for Linux based VMs running on Azure"
},
"LinuxConfiguration": {
"type": "object",
"x-ms-discriminator-value": "Linux",
"allOf": [
{
"$ref": "#/definitions/OSConfiguration"
}
],
"properties": {
"disablePasswordAuthentication": {
"type": "boolean",
"description": "Specifies whether password authentication should be disabled."
},
"ssh": {
"$ref": "#/definitions/SshConfiguration",
"description": "Specifies the ssh key configuration for a Linux OS. (This property is deprecated, please use 'sshKeyPair' instead)"
},
"sshKeyPair": {
"$ref": "#/definitions/SshKeyPair",
"description": "The SSH Key-pair used to authenticate with the VM's."
}
},
"description": "Specifies the Linux operating system settings on the virtual machine.
For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)."
},
"OSConfiguration": {
"description": "Defines the OS configuration.",
"type": "object",
"required": [
"osType"
],
"properties": {
"osType": {
"description": "The OS Type",
"enum": [
"Linux",
"Windows"
],
"type": "string",
"x-ms-enum": {
"name": "OSType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
}
},
"discriminator": "osType"
},
"OSProfile": {
"type": "object",
"properties": {
"adminUsername": {
"type": "string",
"description": "Specifies the name of the administrator account.
This property cannot be updated after the VM is created.
**Windows-only restriction:** Cannot end in \".\"
**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".
**Minimum-length (Linux):** 1 character
**Max-length (Linux):** 64 characters
**Max-length (Windows):** 20 characters."
},
"adminPassword": {
"type": "string",
"x-ms-secret": true,
"description": "Specifies the password of the administrator account.
**Minimum-length (Windows):** 8 characters
**Minimum-length (Linux):** 6 characters
**Max-length (Windows):** 123 characters
**Max-length (Linux):** 72 characters
**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\\W_])
**Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"
For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)
For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)"
},
"osConfiguration": {
"$ref": "#/definitions/OSConfiguration",
"description": "Specifies Windows operating system settings on the virtual machine."
}
},
"description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned."
},
"SingleServerRecommendationResult": {
"x-ms-discriminator-value": "SingleServer",
"description": "The recommended configuration for a single server SAP system.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SAPSizingRecommendationResult"
}
],
"properties": {
"vmSku": {
"description": "The recommended VM SKU for single server.",
"type": "string"
}
}
},
"ThreeTierRecommendationResult": {
"x-ms-discriminator-value": "ThreeTier",
"description": "The recommended configuration for a three tier SAP system.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SAPSizingRecommendationResult"
}
],
"properties": {
"dbVmSku": {
"description": "The database VM SKU.",
"type": "string"
},
"databaseInstanceCount": {
"description": "The database server instance count.",
"type": "integer",
"format": "int64"
},
"centralServerVmSku": {
"description": "The central server VM SKU.",
"type": "string"
},
"centralServerInstanceCount": {
"description": "The central server instance count.",
"type": "integer",
"format": "int64"
},
"applicationServerVmSku": {
"description": "The application server VM SKU.",
"type": "string"
},
"applicationServerInstanceCount": {
"description": "The application server instance count.",
"type": "integer",
"format": "int64"
}
}
},
"SAPSizingRecommendationRequest": {
"description": "The SAP Sizing Recommendation request.",
"type": "object",
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the resource is to be created."
},
"environment": {
"$ref": "#/definitions/EnvironmentType"
},
"sapProduct": {
"$ref": "#/definitions/SAPProductType"
},
"deploymentType": {
"description": "The deployment type. Eg: SingleServer/ThreeTier",
"$ref": "#/definitions/DeploymentType"
},
"saps": {
"description": "The SAP Application Performance Standard measurement.",
"type": "integer",
"format": "int64"
},
"dbMemory": {
"description": "The database memory configuration.",
"type": "integer",
"format": "int64"
},
"databaseType": {
"description": "The database type.",
"$ref": "#/definitions/SAPDatabaseType"
},
"dbScaleMethod": {
"description": "The DB scale method.",
"$ref": "#/definitions/DatabaseScaleMethod"
},
"highAvailabilityType": {
"description": "The high availability type.",
"$ref": "#/definitions/HighAvailabilityType"
}
},
"required": [
"appLocation",
"environment",
"sapProduct",
"deploymentType",
"saps",
"dbMemory",
"databaseType"
]
},
"SAPSizingRecommendationResult": {
"description": "The SAP sizing recommendation result.",
"type": "object",
"required": [
"deploymentType"
],
"properties": {
"deploymentType": {
"$ref": "#/definitions/DeploymentType"
}
},
"discriminator": "deploymentType"
},
"SAPSupportedSkusRequest": {
"description": "The SAP request to get list of supported SKUs.",
"type": "object",
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the resource is to be created."
},
"environment": {
"$ref": "#/definitions/EnvironmentType"
},
"sapProduct": {
"$ref": "#/definitions/SAPProductType"
},
"deploymentType": {
"description": "The deployment type. Eg: SingleServer/ThreeTier",
"$ref": "#/definitions/DeploymentType"
},
"databaseType": {
"description": "The database type. Eg: HANA, DB2, etc",
"$ref": "#/definitions/SAPDatabaseType"
},
"highAvailabilityType": {
"description": "The high availability type.",
"$ref": "#/definitions/HighAvailabilityType"
}
},
"required": [
"appLocation",
"environment",
"sapProduct",
"databaseType",
"deploymentType"
]
},
"SAPSupportedSku": {
"description": "The SAP supported SKU.",
"type": "object",
"properties": {
"vmSku": {
"type": "string",
"description": "The VM Sku."
},
"isAppServerCertified": {
"description": "True if the Sku is certified for App server in the SAP system.",
"type": "boolean"
},
"isDatabaseCertified": {
"description": "True if the Sku is certified for Database server in the SAP system.",
"type": "boolean"
}
}
},
"SAPSupportedResourceSkusResult": {
"description": "The list of supported SKUs for different resources which are part of SAP deployment.",
"type": "object",
"properties": {
"supportedSkus": {
"description": "Gets the list of SAP supported SKUs.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPSupportedSku"
},
"x-ms-identifiers": []
}
}
},
"SAPDiskConfigurationsRequest": {
"description": "The SAP request to get list of disk configurations.",
"type": "object",
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the SAP resources will be created."
},
"environment": {
"$ref": "#/definitions/EnvironmentType"
},
"sapProduct": {
"$ref": "#/definitions/SAPProductType"
},
"databaseType": {
"description": "The database type. Eg: HANA, DB2, etc",
"$ref": "#/definitions/SAPDatabaseType"
},
"deploymentType": {
"description": "The deployment type. Eg: SingleServer/ThreeTier",
"$ref": "#/definitions/DeploymentType"
},
"dbVmSku": {
"description": "The VM SKU for database instance.",
"type": "string"
}
},
"required": [
"appLocation",
"environment",
"sapProduct",
"databaseType",
"deploymentType",
"dbVmSku"
]
},
"DiskDetails": {
"description": "The supported disk size details for a disk type.",
"type": "object",
"properties": {
"sku": {
"$ref": "#/definitions/DiskSku"
},
"sizeGB": {
"description": "The disk size in GB.",
"type": "integer",
"format": "int64"
},
"minimumSupportedDiskCount": {
"description": "The minimum supported disk count.",
"type": "integer",
"format": "int64"
},
"maximumSupportedDiskCount": {
"description": "The maximum supported disk count.",
"type": "integer",
"format": "int64"
},
"iopsReadWrite": {
"description": "The disk Iops.",
"type": "integer",
"format": "int64"
},
"mbpsReadWrite": {
"description": "The disk provisioned throughput in MBps.",
"type": "integer",
"format": "int64"
},
"diskTier": {
"description": "The disk tier, e.g. P10, E10.",
"type": "string"
}
}
},
"SAPDiskConfiguration": {
"description": "The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type.",
"type": "object",
"properties": {
"recommendedConfiguration": {
"$ref": "#/definitions/DiskVolumeConfiguration",
"description": "The recommended disk details for a given VM Sku."
},
"supportedConfigurations": {
"description": "The list of supported disks for a given VM Sku.",
"type": "array",
"items": {
"$ref": "#/definitions/DiskDetails"
},
"x-ms-identifiers": []
}
}
},
"SAPDiskConfigurationsResult": {
"description": "The list of disk configuration for vmSku which are part of SAP deployment.",
"type": "object",
"properties": {
"volumeConfigurations": {
"description": "The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup'].",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SAPDiskConfiguration"
}
}
}
},
"SAPAvailabilityZoneDetailsRequest": {
"description": "The SAP request to get list of availability zones.",
"type": "object",
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the SAP resources will be created."
},
"sapProduct": {
"$ref": "#/definitions/SAPProductType"
},
"databaseType": {
"description": "The database type. Eg: HANA, DB2, etc",
"$ref": "#/definitions/SAPDatabaseType"
}
},
"required": [
"appLocation",
"sapProduct",
"databaseType"
]
},
"SAPAvailabilityZonePair": {
"description": "The SAP Availability Zone Pair.",
"type": "object",
"properties": {
"zoneA": {
"description": "The zone A.",
"type": "integer",
"format": "int64"
},
"zoneB": {
"description": "The zone B.",
"type": "integer",
"format": "int64"
}
}
},
"SAPAvailabilityZoneDetailsResult": {
"description": "The list of supported availability zone pairs which are part of SAP HA deployment.",
"type": "object",
"properties": {
"availabilityZonePairs": {
"description": "Gets the list of availability zone pairs.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPAvailabilityZonePair"
},
"x-ms-identifiers": []
}
}
},
"DiskSku": {
"description": "The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS.",
"type": "object",
"properties": {
"name": {
"$ref": "#/definitions/DiskSkuName"
}
}
},
"DiskVolumeConfiguration": {
"description": "The disk configuration required for the selected volume.",
"type": "object",
"properties": {
"count": {
"description": "The total number of disks required for the concerned volume.",
"type": "integer",
"format": "int64"
},
"sizeGB": {
"description": "The disk size in GB.",
"type": "integer",
"format": "int64"
},
"sku": {
"description": "The disk SKU details.",
"$ref": "#/definitions/DiskSku"
}
}
},
"DiskConfiguration": {
"description": "The Disk Configuration Details.",
"type": "object",
"properties": {
"diskVolumeConfigurations": {
"description": "The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup'].",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/DiskVolumeConfiguration"
}
}
}
},
"VirtualMachineConfiguration": {
"description": "Defines the virtual machine configuration.",
"type": "object",
"properties": {
"vmSize": {
"type": "string",
"description": "The virtual machine size."
},
"imageReference": {
"description": "The image reference.",
"$ref": "#/definitions/ImageReference"
},
"osProfile": {
"description": "The OS profile.",
"$ref": "#/definitions/OSProfile"
}
},
"required": [
"vmSize",
"imageReference",
"osProfile"
]
},
"SingleServerConfiguration": {
"x-ms-discriminator-value": "SingleServer",
"description": "Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409)",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/InfrastructureConfiguration"
}
],
"properties": {
"networkConfiguration": {
"description": "Network configuration for the server",
"$ref": "#/definitions/NetworkConfiguration"
},
"databaseType": {
"description": "The database type.",
"$ref": "#/definitions/SAPDatabaseType"
},
"subnetId": {
"description": "The subnet id.",
"type": "string"
},
"virtualMachineConfiguration": {
"description": "Gets or sets the virtual machine configuration.",
"$ref": "#/definitions/VirtualMachineConfiguration"
},
"dbDiskConfiguration": {
"description": "Gets or sets the disk configuration.",
"$ref": "#/definitions/DiskConfiguration"
},
"customResourceNames": {
"description": "The set of custom names to be used for underlying azure resources that are part of the SAP system.",
"$ref": "#/definitions/SingleServerCustomResourceNames"
}
},
"required": [
"subnetId",
"virtualMachineConfiguration"
]
},
"CentralServerConfiguration": {
"description": "Gets or sets the central server configuration.",
"type": "object",
"properties": {
"subnetId": {
"description": "The subnet id.",
"type": "string"
},
"virtualMachineConfiguration": {
"description": "Gets or sets the virtual machine configuration.",
"$ref": "#/definitions/VirtualMachineConfiguration"
},
"instanceCount": {
"description": "The number of central server VMs.",
"type": "integer",
"format": "int64"
}
},
"required": [
"subnetId",
"virtualMachineConfiguration",
"instanceCount"
]
},
"DatabaseConfiguration": {
"description": "Gets or sets the database configuration.",
"type": "object",
"properties": {
"databaseType": {
"description": "The database type.",
"$ref": "#/definitions/SAPDatabaseType"
},
"subnetId": {
"description": "The subnet id.",
"type": "string"
},
"virtualMachineConfiguration": {
"description": "Gets or sets the virtual machine configuration.",
"$ref": "#/definitions/VirtualMachineConfiguration"
},
"instanceCount": {
"description": "The number of database VMs.",
"type": "integer",
"format": "int64"
},
"diskConfiguration": {
"description": "Gets or sets the disk configuration.",
"$ref": "#/definitions/DiskConfiguration"
}
},
"required": [
"subnetId",
"virtualMachineConfiguration",
"instanceCount"
]
},
"ApplicationServerConfiguration": {
"description": "Gets or sets the application server configuration.",
"type": "object",
"properties": {
"subnetId": {
"description": "The subnet id.",
"type": "string"
},
"virtualMachineConfiguration": {
"description": "Gets or sets the virtual machine configuration.",
"$ref": "#/definitions/VirtualMachineConfiguration"
},
"instanceCount": {
"description": "The number of app server instances.",
"type": "integer",
"format": "int64"
}
},
"required": [
"subnetId",
"virtualMachineConfiguration",
"instanceCount"
]
},
"HighAvailabilityConfiguration": {
"description": "Gets or sets the high availability configuration.",
"type": "object",
"properties": {
"highAvailabilityType": {
"description": "The high availability type.",
"$ref": "#/definitions/HighAvailabilityType"
}
},
"required": [
"highAvailabilityType"
]
},
"FileShareConfigurationType": {
"description": "The type of file share config.",
"enum": [
"Skip",
"CreateAndMount",
"Mount"
],
"type": "string",
"x-ms-enum": {
"name": "configurationType",
"modelAsString": true
},
"x-ms-mutability": [
"create",
"read"
]
},
"SkipFileShareConfiguration": {
"x-ms-discriminator-value": "Skip",
"description": "Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FileShareConfiguration"
}
]
},
"CreateAndMountFileShareConfiguration": {
"x-ms-discriminator-value": "CreateAndMount",
"description": "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.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FileShareConfiguration"
}
],
"properties": {
"resourceGroup": {
"type": "string",
"description": "The name of transport file share resource group. This should be pre created by the customer. The app rg is used in case of missing input."
},
"storageAccountName": {
"type": "string",
"description": "The name of file share storage account name . A custom name is used in case of missing input."
}
}
},
"MountFileShareConfiguration": {
"x-ms-discriminator-value": "Mount",
"description": "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.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/FileShareConfiguration"
}
],
"properties": {
"id": {
"type": "string",
"description": "The fileshare resource ID"
},
"privateEndpointId": {
"type": "string",
"description": "The private endpoint resource ID"
}
},
"required": [
"id",
"privateEndpointId"
]
},
"FileShareConfiguration": {
"description": "File Share configuration details, populated with information on storage configuration mounted on the VIS. The createAndMount option is selected in case of missing input.",
"type": "object",
"properties": {
"configurationType": {
"$ref": "#/definitions/FileShareConfigurationType"
}
},
"discriminator": "configurationType",
"required": [
"configurationType"
]
},
"StorageConfiguration": {
"description": "Gets or sets the storage configuration.",
"type": "object",
"properties": {
"transportFileShareConfiguration": {
"description": "The properties of the transport directory attached to the VIS. The default for transportFileShareConfiguration is the createAndMount flow if storage configuration is missing.",
"$ref": "#/definitions/FileShareConfiguration"
}
}
},
"ThreeTierConfiguration": {
"x-ms-discriminator-value": "ThreeTier",
"x-ms-client-flatten": true,
"description": "Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409)",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/InfrastructureConfiguration"
}
],
"properties": {
"networkConfiguration": {
"description": "Network configuration common to all servers",
"$ref": "#/definitions/NetworkConfiguration"
},
"centralServer": {
"description": "The central server configuration.",
"$ref": "#/definitions/CentralServerConfiguration"
},
"applicationServer": {
"description": "The application server configuration.",
"$ref": "#/definitions/ApplicationServerConfiguration"
},
"databaseServer": {
"description": "The database configuration.",
"$ref": "#/definitions/DatabaseConfiguration"
},
"highAvailabilityConfig": {
"description": "The high availability configuration.",
"$ref": "#/definitions/HighAvailabilityConfiguration"
},
"storageConfiguration": {
"description": "The storage configuration.",
"$ref": "#/definitions/StorageConfiguration"
},
"customResourceNames": {
"description": "The set of custom names to be used for underlying azure resources that are part of the SAP system.",
"$ref": "#/definitions/ThreeTierCustomResourceNames"
}
},
"required": [
"centralServer",
"applicationServer",
"databaseServer"
]
},
"InfrastructureConfiguration": {
"description": "Deploy SAP Infrastructure Details.",
"type": "object",
"required": [
"deploymentType",
"appResourceGroup"
],
"properties": {
"deploymentType": {
"$ref": "#/definitions/DeploymentType"
},
"appResourceGroup": {
"type": "string",
"description": "The application resource group where SAP system resources will be deployed."
}
},
"discriminator": "deploymentType"
},
"SingleServerCustomResourceNames": {
"description": "The resource-names input to specify custom names for underlying azure resources that are part of a single server SAP system.",
"type": "object",
"properties": {
"namingPatternType": {
"$ref": "#/definitions/NamingPatternType"
}
},
"required": [
"namingPatternType"
],
"discriminator": "namingPatternType"
},
"SingleServerFullResourceNames": {
"description": "The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system.",
"type": "object",
"x-ms-discriminator-value": "FullResourceName",
"x-ms-client-flatten": true,
"allOf": [
{
"$ref": "#/definitions/SingleServerCustomResourceNames"
}
],
"properties": {
"virtualMachine": {
"$ref": "#/definitions/VirtualMachineResourceNames"
}
}
},
"ThreeTierCustomResourceNames": {
"description": "The resource-names input to specify custom names for underlying azure resources that are part of a three tier SAP system.",
"type": "object",
"properties": {
"namingPatternType": {
"$ref": "#/definitions/NamingPatternType"
}
},
"required": [
"namingPatternType"
],
"discriminator": "namingPatternType"
},
"ThreeTierFullResourceNames": {
"description": "The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system.",
"type": "object",
"x-ms-discriminator-value": "FullResourceName",
"x-ms-client-flatten": true,
"allOf": [
{
"$ref": "#/definitions/ThreeTierCustomResourceNames"
}
],
"properties": {
"centralServer": {
"$ref": "#/definitions/CentralServerFullResourceNames"
},
"applicationServer": {
"$ref": "#/definitions/ApplicationServerFullResourceNames"
},
"databaseServer": {
"$ref": "#/definitions/DatabaseServerFullResourceNames"
},
"sharedStorage": {
"$ref": "#/definitions/sharedStorageResourceNames"
}
}
},
"CentralServerFullResourceNames": {
"description": "The full resource names object for central server layer resources.",
"type": "object",
"properties": {
"virtualMachines": {
"description": "The list of names for all ASCS virtual machines to be deployed. The number of entries in this list should be equal to the number VMs to be created for ASCS layer. At maximum, there can be two virtual machines at this layer: ASCS and ERS.",
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineResourceNames"
},
"x-ms-identifiers": [],
"maxItems": 2
},
"availabilitySetName": {
"description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-ASCS-AvSet.",
"type": "string"
},
"loadBalancer": {
"$ref": "#/definitions/LoadBalancerResourceNames"
}
}
},
"VirtualMachineResourceNames": {
"description": "The resource names object for virtual machine and related resources.",
"type": "object",
"properties": {
"vmName": {
"description": "The full name for virtual machine. The length of this field can be upto 64 characters. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}vm. In case of HA-AvZone systems, default name will be {SID}{app/ascs/db}z{a/b}vm with an incrementor at the end in case of more than 1 vm per layer. For distributed and HA-AvSet systems, default name will be {SID}{app/ascs/db}vm with an incrementor at the end in case of more than 1 vm per layer.",
"type": "string"
},
"hostName": {
"description": "The full name for virtual-machine's host (computer name). Currently, ACSS only supports host names which are less than or equal to 13 characters long. If this value is not provided, vmName will be used as host name.",
"type": "string"
},
"networkInterfaces": {
"description": "The list of network interface name objects for the selected virtual machine. Currently, only one network interface is supported per virtual machine.",
"type": "array",
"items": {
"$ref": "#/definitions/NetworkInterfaceResourceNames"
},
"x-ms-identifiers": [],
"maxItems": 1
},
"osDiskName": {
"description": "The full name for OS disk attached to the VM. If this value is not provided, it will be named by ARM as per its default naming standards (prefixed with vm name). There is only one OS disk attached per Virtual Machine.",
"type": "string"
},
"dataDiskNames": {
"description": "The full resource names for virtual machine data disks. This is a dictionary containing list of names of data disks per volume. Currently supported volumes for database layer are ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os', 'backup']. For application and cs layers, only 'default' volume is supported",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"description": "The full names for data disks belonging to the specific volume. If names for a volume are not provided, hana disks will be named based the volume. Application and CS layer data disks ('default' volume) will be named as {vmname}-datadisk.",
"type": "string"
}
}
}
}
},
"NetworkInterfaceResourceNames": {
"description": "The resource names object for network interface and related resources.",
"type": "object",
"properties": {
"networkInterfaceName": {
"description": "The full name for network interface. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}-Nic. In case of HA-AvZone systems, default name will be {SID}-{App/ASCS/DB}-Zone{A/B}-Nic with an incrementor at the end in case of more than 1 instance per layer. For distributed and HA-AvSet systems, default name will be {SID}-{App/ASCS/DB}-Nic with an incrementor at the end in case of more than 1 instance per layer.",
"type": "string"
}
}
},
"LoadBalancerResourceNames": {
"description": "The resource names object for load balancer and related resources.",
"type": "object",
"properties": {
"loadBalancerName": {
"description": "The full resource name for load balancer. If this value is not provided, load balancer will be name as {ASCS/DB}-loadBalancer.",
"type": "string"
},
"frontendIpConfigurationNames": {
"description": "The list of frontend IP configuration names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer.",
"type": "array",
"items": {
"description": "The full name for frontend IP configuration. If it is not provided, it will be defaulted to frontend.{ASCS/ERS/DB}.",
"type": "string"
},
"maxItems": 2
},
"backendPoolNames": {
"description": "The list of backend pool names. Currently, ACSS deploys only one backend pool and hence, size of this list should be 1",
"type": "array",
"items": {
"description": "The full name for backend pool. If it is not provided, it will be defaulted to 'backend'.",
"type": "string"
},
"maxItems": 1
},
"healthProbeNames": {
"description": "The list of health probe names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer.",
"type": "array",
"items": {
"description": "The full name for health probe. If it is not provided, it will be defaulted to health.{ASCS/ERS/DB}.",
"type": "string"
},
"maxItems": 2
}
}
},
"sharedStorageResourceNames": {
"description": "The resource names object for shared storage.",
"type": "object",
"properties": {
"sharedStorageAccountName": {
"description": "The full name of the shared storage account. If it is not provided, it will be defaulted to {SID}nfs{guid of 15 chars}.",
"type": "string"
},
"sharedStorageAccountPrivateEndPointName": {
"description": "The full name of private end point for the shared storage account. If it is not provided, it will be defaulted to {storageAccountName}_pe",
"type": "string"
}
}
},
"ApplicationServerFullResourceNames": {
"description": "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.",
"type": "object",
"properties": {
"virtualMachines": {
"description": "The list of virtual machine naming details.",
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineResourceNames"
},
"x-ms-identifiers": []
},
"availabilitySetName": {
"description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-App-AvSet.",
"type": "string"
}
}
},
"DatabaseServerFullResourceNames": {
"description": "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.",
"type": "object",
"properties": {
"virtualMachines": {
"description": "The list of virtual machine naming details.",
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineResourceNames"
},
"x-ms-identifiers": [],
"maxItems": 2
},
"availabilitySetName": {
"description": "The full name for availability set. In case name is not provided, it will be defaulted to {SID}-DB-AvSet.",
"type": "string"
},
"loadBalancer": {
"$ref": "#/definitions/LoadBalancerResourceNames"
}
}
},
"SoftwareConfiguration": {
"description": "The SAP Software configuration Input.",
"type": "object",
"properties": {
"softwareInstallationType": {
"$ref": "#/definitions/SAPSoftwareInstallationType"
}
},
"required": [
"softwareInstallationType"
],
"discriminator": "softwareInstallationType"
},
"ServiceInitiatedSoftwareConfiguration": {
"description": "The SAP Software configuration Input when the software is to be installed by service.",
"type": "object",
"x-ms-discriminator-value": "ServiceInitiated",
"x-ms-client-flatten": true,
"allOf": [
{
"$ref": "#/definitions/SoftwareConfiguration"
}
],
"properties": {
"bomUrl": {
"type": "string",
"description": "The URL to the SAP Build of Materials(BOM) file."
},
"softwareVersion": {
"type": "string",
"description": "The software version to install."
},
"sapBitsStorageAccountId": {
"type": "string",
"description": "The SAP bits storage account id."
},
"sapFqdn": {
"type": "string",
"description": "The FQDN to set for the SAP system during install."
},
"sshPrivateKey": {
"type": "string",
"x-ms-secret": true,
"description": "The SSH private key."
},
"highAvailabilitySoftwareConfiguration": {
"$ref": "#/definitions/HighAvailabilitySoftwareConfiguration"
}
},
"required": [
"bomUrl",
"softwareVersion",
"sapBitsStorageAccountId",
"sapFqdn",
"sshPrivateKey"
]
},
"SAPInstallWithoutOSConfigSoftwareConfiguration": {
"description": "The SAP Software configuration Input when the software is to be installed by service without OS Configurations",
"type": "object",
"x-ms-discriminator-value": "SAPInstallWithoutOSConfig",
"x-ms-client-flatten": true,
"allOf": [
{
"$ref": "#/definitions/SoftwareConfiguration"
}
],
"properties": {
"bomUrl": {
"type": "string",
"description": "The URL to the SAP Build of Materials(BOM) file."
},
"sapBitsStorageAccountId": {
"type": "string",
"description": "The SAP bits storage account id."
},
"softwareVersion": {
"type": "string",
"description": "The software version to install."
},
"highAvailabilitySoftwareConfiguration": {
"$ref": "#/definitions/HighAvailabilitySoftwareConfiguration"
}
},
"required": [
"bomUrl",
"sapBitsStorageAccountId",
"softwareVersion"
]
},
"ExternalInstallationSoftwareConfiguration": {
"description": "The SAP Software configuration Input when the software is installed externally outside the service.",
"type": "object",
"x-ms-discriminator-value": "External",
"x-ms-client-flatten": true,
"allOf": [
{
"$ref": "#/definitions/SoftwareConfiguration"
}
],
"properties": {
"centralServerVmId": {
"type": "string",
"description": "The resource ID of the virtual machine containing the central server instance."
}
}
},
"HighAvailabilitySoftwareConfiguration": {
"description": "Gets or sets the HA software configuration.",
"type": "object",
"properties": {
"fencingClientId": {
"description": "The fencing client id.",
"type": "string"
},
"fencingClientPassword": {
"description": "The fencing client id secret/password. The secret should never expire. This will be used pacemaker to start/stop the cluster VMs.",
"x-ms-secret": true,
"type": "string"
}
},
"required": [
"fencingClientId",
"fencingClientPassword"
]
},
"StopRequest": {
"description": "Stop SAP instance(s) request body.",
"type": "object",
"properties": {
"softStopTimeoutSeconds": {
"type": "integer",
"format": "int64",
"default": 0,
"description": "This parameter defines how long (in seconds) the soft shutdown waits until the RFC/HTTP clients no longer consider the server for calls with load balancing. Value 0 means that the kernel does not wait, but goes directly into the next shutdown state, i.e. hard stop."
},
"deallocateVm": {
"type": "boolean",
"default": false,
"description": "The boolean value indicates whether to Stop and deallocate the virtual machines along with the SAP instances."
}
}
},
"StartRequest": {
"description": "Start SAP instance(s) request body.",
"type": "object",
"properties": {
"startVm": {
"type": "boolean",
"default": false,
"description": "The boolean value indicates whether to start the virtual machines before starting the SAP instances."
}
}
},
"DiscoveryConfiguration": {
"x-ms-discriminator-value": "Discovery",
"description": "Discovery Details.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SAPConfiguration"
}
],
"properties": {
"centralServerVmId": {
"type": "string",
"description": "The virtual machine ID of the Central Server."
},
"managedRgStorageAccountName": {
"type": "string",
"description": "The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment.
Refer to the storage account naming rules [here](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage).
If not provided, the service will create the storage account with a random name.",
"minLength": 3,
"maxLength": 24
},
"appLocation": {
"type": "string",
"readOnly": true,
"description": "The geo-location where the SAP system exists."
}
}
},
"DeploymentConfiguration": {
"x-ms-discriminator-value": "Deployment",
"description": "Deployment Configuration.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SAPConfiguration"
}
],
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the SAP system is to be created."
},
"infrastructureConfiguration": {
"$ref": "#/definitions/InfrastructureConfiguration",
"description": "The infrastructure configuration."
},
"softwareConfiguration": {
"$ref": "#/definitions/SoftwareConfiguration",
"description": "The software configuration."
}
}
},
"DeploymentWithOSConfiguration": {
"x-ms-discriminator-value": "DeploymentWithOSConfig",
"description": "Deployment along with OS Configuration.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/SAPConfiguration"
}
],
"properties": {
"appLocation": {
"type": "string",
"description": "The geo-location where the SAP system is to be created."
},
"infrastructureConfiguration": {
"$ref": "#/definitions/InfrastructureConfiguration",
"description": "The infrastructure configuration."
},
"softwareConfiguration": {
"$ref": "#/definitions/SoftwareConfiguration",
"description": "The software configuration."
},
"osSapConfiguration": {
"$ref": "#/definitions/OsSapConfiguration",
"description": "The OS and SAP configuration."
}
}
},
"OsSapConfiguration": {
"description": "Defines the OS and SAP Configurations for Deployment",
"type": "object",
"properties": {
"deployerVmPackages": {
"$ref": "#/definitions/DeployerVmPackages",
"description": "The url and storage account ID where deployer VM packages are uploaded"
},
"sapFqdn": {
"type": "string",
"description": "The FQDN to set for the SAP system"
}
}
},
"DeployerVmPackages": {
"description": "Defines the url and storage account ID where deployer VM packages are uploaded",
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to the deployer VM packages file."
},
"storageAccountId": {
"type": "string",
"description": "The deployer VM packages storage account id"
}
}
},
"SshKeyPair": {
"description": "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](https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).",
"type": "object",
"properties": {
"publicKey": {
"type": "string",
"description": "SSH public key"
},
"privateKey": {
"type": "string",
"x-ms-secret": true,
"description": "SSH private key."
}
}
},
"SAPConfiguration": {
"description": "The SAP Configuration.",
"type": "object",
"required": [
"configurationType"
],
"properties": {
"configurationType": {
"$ref": "#/definitions/ConfigurationType"
}
},
"discriminator": "configurationType"
},
"LoadBalancerDetails": {
"description": "The Load Balancer details such as Load Balancer ID.",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
}
}
},
"StorageInformation": {
"description": "Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage. ",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
}
}
},
"CentralServerVmDetails": {
"description": "The SAP Central Services Instance VM details.",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/CentralServerVirtualMachineType",
"readOnly": true
},
"virtualMachineId": {
"type": "string",
"readOnly": true
},
"storageDetails": {
"description": "Storage details of all the Storage Accounts attached to the ASCS Virtual Machine. For e.g. NFS on AFS Shared Storage.",
"type": "array",
"items": {
"$ref": "#/definitions/StorageInformation"
},
"x-ms-identifiers": [],
"readOnly": true
}
}
},
"ApplicationServerVmDetails": {
"description": "The Application Server VM Details.",
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/ApplicationServerVirtualMachineType",
"readOnly": true
},
"virtualMachineId": {
"type": "string",
"readOnly": true
},
"storageDetails": {
"description": "Storage details of all the Storage Accounts attached to the App Virtual Machine. For e.g. NFS on AFS Shared Storage.",
"type": "array",
"items": {
"$ref": "#/definitions/StorageInformation"
},
"x-ms-identifiers": [],
"readOnly": true
}
}
},
"DatabaseVmDetails": {
"description": "Database VM details.",
"type": "object",
"properties": {
"virtualMachineId": {
"type": "string",
"readOnly": true
},
"status": {
"$ref": "#/definitions/SAPVirtualInstanceStatus",
"readOnly": true
},
"storageDetails": {
"description": "Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage.",
"type": "array",
"items": {
"$ref": "#/definitions/StorageInformation"
},
"x-ms-identifiers": [],
"readOnly": true
}
}
},
"ManagedRGConfiguration": {
"description": "Managed resource group configuration",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Managed resource group name"
}
}
},
"SAPVirtualInstanceProperties": {
"description": "Defines the Virtual Instance for SAP solutions resource properties.",
"type": "object",
"required": [
"environment",
"sapProduct",
"configuration"
],
"properties": {
"environment": {
"$ref": "#/definitions/EnvironmentType",
"x-ms-mutability": [
"create",
"read"
]
},
"sapProduct": {
"$ref": "#/definitions/SAPProductType",
"x-ms-mutability": [
"create",
"read"
]
},
"managedResourcesNetworkAccessType": {
"$ref": "#/definitions/ManagedResourcesNetworkAccessType",
"description": "Specifies the network access configuration for the resources that will be deployed in the Managed Resource Group. The options to choose from are Public and Private. If 'Private' is chosen, the Storage Account service tag should be enabled on the subnets in which the SAP VMs exist. This is required for establishing connectivity between VM extensions and the managed resource group storage account. This setting is currently applicable only to Storage Account. Learn more here https://go.microsoft.com/fwlink/?linkid=2247228",
"default": "Public"
},
"configuration": {
"description": "Defines if the SAP system is being created using Azure Center for SAP solutions (ACSS) or if an existing SAP system is being registered with ACSS",
"$ref": "#/definitions/SAPConfiguration"
},
"managedResourceGroupConfiguration": {
"description": "Managed resource group configuration",
"$ref": "#/definitions/ManagedRGConfiguration"
},
"status": {
"$ref": "#/definitions/SAPVirtualInstanceStatus",
"readOnly": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
},
"state": {
"$ref": "#/definitions/SAPVirtualInstanceState",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"readOnly": true
},
"errors": {
"description": "Indicates any errors on the Virtual Instance for SAP solutions resource.",
"$ref": "#/definitions/SAPVirtualInstanceError",
"readOnly": true
}
}
},
"SAPVirtualInstance": {
"description": "Define the Virtual Instance for SAP solutions resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
],
"properties": {
"identity": {
"$ref": "../../../common-types/v1/commonTypes.json#/definitions/UserAssignedServiceIdentity"
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SAPVirtualInstanceProperties"
}
},
"required": [
"properties"
]
},
"SAPVirtualInstanceList": {
"description": "Defines the collection of Virtual Instance for SAP solutions resources.",
"type": "object",
"properties": {
"value": {
"description": "Gets the list of Virtual Instances for SAP solutions resources.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPVirtualInstance"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "Gets the value of next link.",
"type": "string"
}
}
},
"SAPCentralInstanceList": {
"description": "Defines the collection of SAP Central Services Instance resources.",
"type": "object",
"properties": {
"value": {
"description": "Gets the list of SAP central services instance resources.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPCentralServerInstance"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "Gets the value of next link.",
"type": "string"
}
}
},
"SAPDatabaseInstanceList": {
"description": "Defines the collection of SAP Database Instances.",
"type": "object",
"properties": {
"value": {
"description": "Gets the list of SAP Database instances.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPDatabaseInstance"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "Gets the value of next link.",
"type": "string"
}
}
},
"SAPApplicationServerInstanceList": {
"description": "Defines the collection of SAP Application Server Instance resources.",
"type": "object",
"properties": {
"value": {
"description": "Gets the list of SAP Application Server instance resources.",
"type": "array",
"items": {
"$ref": "#/definitions/SAPApplicationServerInstance"
},
"x-ms-identifiers": []
},
"nextLink": {
"description": "Gets the value of next link.",
"type": "string"
}
}
},
"SAPApplicationServerProperties": {
"description": "Defines the SAP Application Server instance properties.",
"type": "object",
"properties": {
"instanceNo": {
"type": "string",
"description": "Application server Instance Number.",
"readOnly": true
},
"subnet": {
"type": "string",
"description": "Application server Subnet.",
"readOnly": true
},
"hostname": {
"type": "string",
"description": "Application server instance SAP hostname.",
"readOnly": true
},
"kernelVersion": {
"type": "string",
"description": " Application server instance SAP Kernel Version.",
"readOnly": true
},
"kernelPatch": {
"type": "string",
"description": "Application server instance SAP Kernel Patch level.",
"readOnly": true
},
"ipAddress": {
"type": "string",
"description": " Application server instance SAP IP Address.",
"readOnly": true
},
"gatewayPort": {
"type": "integer",
"format": "int64",
"description": "Application server instance gateway Port.",
"readOnly": true,
"x-nullable": true
},
"icmHttpPort": {
"type": "integer",
"format": "int64",
"description": "Application server instance ICM HTTP Port.",
"readOnly": true,
"x-nullable": true
},
"icmHttpsPort": {
"type": "integer",
"format": "int64",
"description": "Application server instance ICM HTTPS Port.",
"readOnly": true,
"x-nullable": true
},
"dispatcherStatus": {
"type": "string",
"description": "Application server instance dispatcher status.",
"readOnly": true
},
"loadBalancerDetails": {
"description": "The Load Balancer details such as LoadBalancer ID attached to Application Server Virtual Machines",
"$ref": "#/definitions/LoadBalancerDetails",
"readOnly": true
},
"vmDetails": {
"description": "The list of virtual machines.",
"type": "array",
"items": {
"$ref": "#/definitions/ApplicationServerVmDetails"
},
"x-ms-identifiers": [],
"readOnly": true
},
"status": {
"$ref": "#/definitions/SAPVirtualInstanceStatus",
"readOnly": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"readOnly": true
},
"errors": {
"description": "Defines the Application Instance errors.",
"readOnly": true,
"$ref": "#/definitions/SAPVirtualInstanceError"
}
}
},
"SAPApplicationServerInstance": {
"description": "Define the SAP Application Server Instance resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SAPApplicationServerProperties"
}
}
},
"MessageServerProperties": {
"description": "Defines the SAP message server properties.",
"type": "object",
"properties": {
"msPort": {
"type": "integer",
"format": "int64",
"description": "message server port.",
"readOnly": true,
"x-nullable": true
},
"internalMsPort": {
"type": "integer",
"format": "int64",
"description": "message server internal MS port.",
"readOnly": true,
"x-nullable": true
},
"httpPort": {
"type": "integer",
"format": "int64",
"description": "message server HTTP Port.",
"readOnly": true,
"x-nullable": true
},
"httpsPort": {
"type": "integer",
"format": "int64",
"description": "message server HTTPS Port.",
"readOnly": true,
"x-nullable": true
},
"hostname": {
"type": "string",
"description": "message server SAP Hostname.",
"readOnly": true
},
"ipAddress": {
"type": "string",
"description": "message server IP Address.",
"readOnly": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
}
}
},
"EnqueueServerProperties": {
"description": "Defines the SAP Enqueue Server properties.",
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "Enqueue Server SAP Hostname.",
"readOnly": true
},
"ipAddress": {
"type": "string",
"description": "Enqueue Server SAP IP Address.",
"readOnly": true
},
"port": {
"type": "integer",
"format": "int64",
"description": "Enqueue Server Port.",
"readOnly": true,
"x-nullable": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
}
}
},
"GatewayServerProperties": {
"description": "Defines the SAP Gateway Server properties.",
"type": "object",
"properties": {
"port": {
"type": "integer",
"format": "int64",
"description": "Gateway Port.",
"readOnly": true,
"x-nullable": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
}
}
},
"EnqueueReplicationServerProperties": {
"description": "Defines the SAP Enqueue Replication Server (ERS) properties.",
"type": "object",
"properties": {
"ersVersion": {
"$ref": "#/definitions/EnqueueReplicationServerType",
"readOnly": true
},
"instanceNo": {
"type": "string",
"description": "ERS Instance Number.",
"readOnly": true
},
"hostname": {
"type": "string",
"description": "ERS SAP Hostname.",
"readOnly": true
},
"kernelVersion": {
"type": "string",
"description": "ERS SAP Kernel Version.",
"readOnly": true
},
"kernelPatch": {
"type": "string",
"description": "ERS SAP Kernel Patch level.",
"readOnly": true
},
"ipAddress": {
"type": "string",
"description": "ERS SAP IP Address.",
"readOnly": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
}
}
},
"SAPCentralServerProperties": {
"description": "Defines the SAP Central Services Instance properties.",
"type": "object",
"properties": {
"instanceNo": {
"type": "string",
"description": "The central services instance number.",
"readOnly": true
},
"subnet": {
"type": "string",
"description": "The central services instance subnet.",
"readOnly": true
},
"messageServerProperties": {
"$ref": "#/definitions/MessageServerProperties"
},
"enqueueServerProperties": {
"$ref": "#/definitions/EnqueueServerProperties"
},
"gatewayServerProperties": {
"$ref": "#/definitions/GatewayServerProperties"
},
"enqueueReplicationServerProperties": {
"$ref": "#/definitions/EnqueueReplicationServerProperties"
},
"kernelVersion": {
"type": "string",
"description": "The central services instance Kernel Version.",
"readOnly": true,
"x-nullable": true
},
"kernelPatch": {
"type": "string",
"description": "The central services instance Kernel Patch level.",
"readOnly": true,
"x-nullable": true
},
"loadBalancerDetails": {
"description": "The Load Balancer details such as LoadBalancer ID attached to ASCS Virtual Machines",
"$ref": "#/definitions/LoadBalancerDetails",
"readOnly": true
},
"vmDetails": {
"description": "The list of virtual machines corresponding to the Central Services instance.",
"type": "array",
"items": {
"$ref": "#/definitions/CentralServerVmDetails"
},
"x-ms-identifiers": [],
"readOnly": true
},
"status": {
"$ref": "#/definitions/SAPVirtualInstanceStatus",
"readOnly": true
},
"health": {
"$ref": "#/definitions/HealthState",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"readOnly": true
},
"errors": {
"description": "Defines the errors related to SAP Central Services Instance resource.",
"readOnly": true,
"$ref": "#/definitions/SAPVirtualInstanceError"
}
}
},
"SAPCentralServerInstance": {
"description": "Define the SAP Central Services Instance resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SAPCentralServerProperties"
}
}
},
"SAPDatabaseProperties": {
"description": "Defines the Database properties.",
"type": "object",
"properties": {
"subnet": {
"type": "string",
"description": "Database subnet.",
"readOnly": true
},
"databaseSid": {
"type": "string",
"description": "Database SID name.",
"readOnly": true
},
"databaseType": {
"type": "string",
"description": "Database type, that is if the DB is HANA, DB2, Oracle, SAP ASE, Max DB or MS SQL Server.",
"readOnly": true
},
"ipAddress": {
"type": "string",
"description": "Database IP Address.",
"readOnly": true
},
"loadBalancerDetails": {
"description": "The Load Balancer details such as LoadBalancer ID attached to Database Virtual Machines",
"$ref": "#/definitions/LoadBalancerDetails",
"readOnly": true
},
"vmDetails": {
"description": "The list of virtual machines corresponding to the Database resource.",
"type": "array",
"items": {
"$ref": "#/definitions/DatabaseVmDetails"
},
"x-ms-identifiers": [],
"readOnly": true
},
"status": {
"$ref": "#/definitions/SAPVirtualInstanceStatus",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"readOnly": true
},
"errors": {
"description": "Defines the errors related to Database resource.",
"readOnly": true,
"$ref": "#/definitions/SAPVirtualInstanceError"
}
}
},
"SAPDatabaseInstance": {
"description": "Define the Database resource.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SAPDatabaseProperties"
}
}
},
"NetworkConfiguration": {
"description": "Defines the network configuration type for SAP system infrastructure that is being deployed ",
"type": "object",
"properties": {
"isSecondaryIpEnabled": {
"type": "boolean",
"description": "Specifies whether a secondary IP address should be added to the network interface on all VMs of the SAP system being deployed",
"default": false
}
}
},
"ErrorDefinition": {
"type": "object",
"description": "Error definition.",
"properties": {
"code": {
"description": "Service specific error code which serves as the substatus for the HTTP error code.",
"type": "string",
"readOnly": true
},
"message": {
"description": "Description of the error.",
"type": "string",
"readOnly": true
},
"details": {
"description": "Internal error details.",
"type": "array",
"items": {
"$ref": "#/definitions/ErrorDefinition"
},
"x-ms-identifiers": [],
"readOnly": true
}
}
}
},
"parameters": {
"SAPVirtualInstanceNameParameter": {
"name": "sapVirtualInstanceName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9]{2}$",
"description": "The name of the Virtual Instances for SAP solutions resource",
"x-ms-parameter-location": "method"
},
"SAPApplicationInstanceNameParameter": {
"name": "applicationInstanceName",
"in": "path",
"required": true,
"pattern": "^.*",
"type": "string",
"description": "The name of SAP Application Server instance resource.",
"x-ms-parameter-location": "method"
},
"DatabaseNameParameter": {
"name": "databaseInstanceName",
"in": "path",
"required": true,
"pattern": "^.*",
"type": "string",
"description": "Database resource name string modeled as parameter for auto generation to work correctly.",
"x-ms-parameter-location": "method"
},
"CentralInstanceNameParameter": {
"name": "centralInstanceName",
"in": "path",
"required": true,
"pattern": "^.*",
"type": "string",
"description": "Central Services Instance resource name string modeled as parameter for auto generation to work correctly.",
"x-ms-parameter-location": "method"
}
}
}