你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SAP Virtual Instances - Update

服务:

Workloads

API 版本:

2023-04-01

汇报 SAP 解决方案的虚拟实例资源

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Workloads/sapVirtualInstances/{sapVirtualInstanceName}?api-version=2023-04-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。 此名称不区分大小写。
sapVirtualInstanceName	path	True	string	SAP 解决方案资源的虚拟实例的名称
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
identity	UserAssignedServiceIdentity	预先创建的用户分配的标识，其中分配了相应的角色。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。
tags	object	获取或设置资源标记。

响应

名称	类型	说明
200 OK	SAPVirtualInstance	介绍已成功更新的 SAP 解决方案的虚拟实例资源。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

SAPVirtualInstances_Update

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/8e17e36c-42e9-4cd5-a078-7b44883414e0/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00?api-version=2023-04-01

{
  "tags": {
    "key1": "svi1"
  },
  "identity": {
    "type": "None"
  }
}

Java

import com.azure.resourcemanager.workloads.models.ManagedServiceIdentityType;
import com.azure.resourcemanager.workloads.models.SapVirtualInstance;
import com.azure.resourcemanager.workloads.models.UserAssignedServiceIdentity;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for SapVirtualInstances Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/
     * SAPVirtualInstances_Update.json
     */
    /**
     * Sample code: SAPVirtualInstances_Update.
     * 
     * @param manager Entry point to WorkloadsManager.
     */
    public static void sAPVirtualInstancesUpdate(com.azure.resourcemanager.workloads.WorkloadsManager manager) {
        SapVirtualInstance resource = manager.sapVirtualInstances()
            .getByResourceGroupWithResponse("test-rg", "X00", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("key1", "fakeTokenPlaceholder"))
            .withIdentity(new UserAssignedServiceIdentity().withType(ManagedServiceIdentityType.NONE)).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.workloads import WorkloadsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-workloads
# USAGE
    python sap_virtual_instances_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WorkloadsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="8e17e36c-42e9-4cd5-a078-7b44883414e0",
    )

    response = client.sap_virtual_instances.update(
        resource_group_name="test-rg",
        sap_virtual_instance_name="X00",
    )
    print(response)


# x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPVirtualInstances_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armworkloads_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/workloads/armworkloads"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPVirtualInstances_Update.json
func ExampleSAPVirtualInstancesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armworkloads.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSAPVirtualInstancesClient().Update(ctx, "test-rg", "X00", armworkloads.UpdateSAPVirtualInstanceRequest{
		Identity: &armworkloads.UserAssignedServiceIdentity{
			Type: to.Ptr(armworkloads.ManagedServiceIdentityTypeNone),
		},
		Tags: map[string]*string{
			"key1": to.Ptr("svi1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SAPVirtualInstance = armworkloads.SAPVirtualInstance{
	// 	Name: to.Ptr("X00"),
	// 	Type: to.Ptr("Microsoft.Workloads/sapVirtualInstances"),
	// 	ID: to.Ptr("/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00"),
	// 	SystemData: &armworkloads.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
	// 		CreatedBy: to.Ptr("user@xyz.com"),
	// 		CreatedByType: to.Ptr(armworkloads.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-19T15:10:46.196Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user@xyz.com"),
	// 		LastModifiedByType: to.Ptr(armworkloads.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("westcentralus"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("svi1"),
	// 	},
	// 	Identity: &armworkloads.UserAssignedServiceIdentity{
	// 		Type: to.Ptr(armworkloads.ManagedServiceIdentityTypeNone),
	// 	},
	// 	Properties: &armworkloads.SAPVirtualInstanceProperties{
	// 		Configuration: &armworkloads.DeploymentConfiguration{
	// 			ConfigurationType: to.Ptr(armworkloads.SAPConfigurationTypeDeployment),
	// 		},
	// 		Environment: to.Ptr(armworkloads.SAPEnvironmentTypeProd),
	// 		Health: to.Ptr(armworkloads.SAPHealthStateUnknown),
	// 		ManagedResourceGroupConfiguration: &armworkloads.ManagedRGConfiguration{
	// 			Name: to.Ptr("mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443"),
	// 		},
	// 		ProvisioningState: to.Ptr(armworkloads.SapVirtualInstanceProvisioningStateSucceeded),
	// 		SapProduct: to.Ptr(armworkloads.SAPProductTypeS4HANA),
	// 		State: to.Ptr(armworkloads.SAPVirtualInstanceStateInfrastructureDeploymentPending),
	// 		Status: to.Ptr(armworkloads.SAPVirtualInstanceStatusStarting),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WorkloadsClient } = require("@azure/arm-workloads");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates a Virtual Instance for SAP solutions resource
 *
 * @summary Updates a Virtual Instance for SAP solutions resource
 * x-ms-original-file: specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/examples/sapvirtualinstances/SAPVirtualInstances_Update.json
 */
async function sapVirtualInstancesUpdate() {
  const subscriptionId =
    process.env["WORKLOADS_SUBSCRIPTION_ID"] || "8e17e36c-42e9-4cd5-a078-7b44883414e0";
  const resourceGroupName = process.env["WORKLOADS_RESOURCE_GROUP"] || "test-rg";
  const sapVirtualInstanceName = "X00";
  const body = {
    identity: { type: "None" },
    tags: { key1: "svi1" },
  };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new WorkloadsClient(credential, subscriptionId);
  const result = await client.sAPVirtualInstances.update(
    resourceGroupName,
    sapVirtualInstanceName,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "id": "/subscriptions/6d875e77-e412-4d7d-9af4-8895278b4443/resourceGroups/test-rg/providers/Microsoft.Workloads/sapVirtualInstances/X00",
  "name": "X00",
  "type": "Microsoft.Workloads/sapVirtualInstances",
  "tags": {
    "key1": "svi1"
  },
  "location": "westcentralus",
  "systemData": {
    "createdBy": "user@xyz.com",
    "createdByType": "User",
    "createdAt": "2021-08-19T15:10:46.196Z",
    "lastModifiedBy": "user@xyz.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-19T15:10:46.196Z"
  },
  "identity": {
    "type": "None"
  },
  "properties": {
    "environment": "Prod",
    "sapProduct": "S4HANA",
    "configuration": {
      "configurationType": "Deployment"
    },
    "status": "Starting",
    "health": "Unknown",
    "state": "InfrastructureDeploymentPending",
    "managedResourceGroupConfiguration": {
      "name": "mrg-x00-6d875e77-e412-4d7d-9af4-8895278b4443"
    },
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
ApplicationServerConfiguration	获取或设置应用程序服务器配置。
ApplicationServerFullResourceNames	应用程序层资源的完整资源名称对象。 此列表中的条目数应等于要为应用程序层创建的 VM 数。
CentralServerConfiguration	获取或设置中央服务器配置。
CentralServerFullResourceNames	中心服务器层资源的完整资源名称对象。
CreateAndMountFileShareConfiguration	获取或设置文件共享配置，其中将创建传输目录文件共享并将其装载为创建基础结构流的一部分。 请预先创建要放置传输目录的资源组。 存储帐户和文件共享将由 ACSS 自动创建，无需预先创建。
createdByType	创建资源的标识类型。
DatabaseConfiguration	获取或设置数据库配置。
DatabaseServerFullResourceNames	数据库层资源的完整资源名称对象。 此列表中的条目数应等于要为数据库层创建的 VM 数。
DeployerVmPackages	定义上传部署程序 VM 包的 URL 和存储帐户 ID
DeploymentConfiguration	部署配置。
DeploymentWithOSConfiguration	部署以及 OS 配置。
DiscoveryConfiguration	发现详细信息。
DiskConfiguration	磁盘配置详细信息。
DiskSku	磁盘 SKU 的类型。 例如，Standard_LRS、Standard_ZRS、Premium_LRS、Premium_ZRS。
DiskSkuName	定义磁盘 SKU 名称。
DiskVolumeConfiguration	所选卷所需的磁盘配置。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDefinition	错误定义。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExternalInstallationSoftwareConfiguration	在服务外部安装软件时，SAP 软件配置输入。
HighAvailabilityConfiguration	获取或设置高可用性配置。
HighAvailabilitySoftwareConfiguration	获取或设置 HA 软件配置。
ImageReference	指定有关要使用的映像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像，但未在其他创建操作中使用，则此元素是必需的。 注意：只能在创建规模集时设置映像引用发布者和产品/服务。
LinuxConfiguration	指定虚拟机上的 Linux 操作系统设置。 有关支持的 Linux 发行版的列表，请参阅 Linux on Azure-Endorsed Distributions。
LoadBalancerResourceNames	负载均衡器和相关资源的资源名称对象。
ManagedRGConfiguration	托管资源组配置
ManagedServiceIdentityType	托管服务标识的类型仅 (None，) 允许使用 UserAssigned 类型。
MountFileShareConfiguration	获取或设置文件共享配置，其中传输目录文件共享已存在，并且用户希望将文件共享装载为创建基础结构流的一部分。
NamingPatternType	要用于资源命名的模式类型。
NetworkConfiguration	定义正在部署的 SAP 系统基础结构的网络配置类型
NetworkInterfaceResourceNames	网络接口和相关资源的资源名称对象。
OSProfile	指定虚拟机的操作系统设置。 预配 VM 后，无法更改某些设置。
OsSapConfiguration	定义部署的 OS 和 SAP 配置
SAPDatabaseType	定义支持的 SAP 数据库类型。
SAPDeploymentType	部署类型。 例如：SingleServer/ThreeTier
SAPEnvironmentType	定义环境类型 - 生产/非生产。
SAPHealthState	定义 SAP 实例的运行状况。
SAPHighAvailabilityType	高可用性类型。
SAPInstallWithoutOSConfigSoftwareConfiguration	SAP 软件配置输入，当软件要由没有 OS 配置的服务安装时
SAPProductType	定义 SAP 产品类型。
SAPSoftwareInstallationType	SAP 软件安装类型。
SAPVirtualInstance	定义 SAP 解决方案的虚拟实例资源。
SAPVirtualInstanceError	来自 SAP 工作负载服务的虚拟实例的错误响应。
SapVirtualInstanceProvisioningState	定义预配状态。
SAPVirtualInstanceState	定义 SAP 状态的虚拟实例。
SAPVirtualInstanceStatus	定义 SAP 实例状态。
ServiceInitiatedSoftwareConfiguration	服务安装软件时的 SAP 软件配置输入。
sharedStorageResourceNames	共享存储的资源名称对象。
SingleServerConfiguration	获取或设置单一服务器配置。 有关创建基础结构的先决条件，请参阅 此处
SingleServerFullResourceNames	资源名称对象，其中指定的值将是单个服务器 SAP 系统中相应资源的完整资源名称。
SkipFileShareConfiguration	获取或设置不创建或不需要传输目录文件共享的方案的文件共享配置。
SshConfiguration	适用于在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置
SshKeyPair	用于向 VM 进行身份验证的 SSH 密钥对。 密钥需要至少为 2048 位且采用 ssh-rsa 格式。 若要创建 SSH 密钥，请参阅 在 Linux 和 Mac 上为 Azure 中的 Linux VM 创建 SSH 密钥。
SshPublicKey	包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。
StorageConfiguration	获取或设置存储配置。
systemData	与资源的创建和上次修改相关的元数据。
ThreeTierConfiguration	获取或设置三层 SAP 配置。 有关创建基础结构的先决条件，请参阅 此处
ThreeTierFullResourceNames	资源名称对象，其中指定的值将是三层 SAP 系统中相应资源的完整资源名称。
UpdateSAPVirtualInstanceRequest	定义用于更新 SAP 虚拟实例的请求正文。
UserAssignedIdentity	用户分配的标识属性
UserAssignedServiceIdentity	预先创建的用户分配的标识，其中分配了相应的角色。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。
VirtualMachineConfiguration	定义虚拟机配置。
VirtualMachineResourceNames	虚拟机和相关资源的资源名称对象。
WindowsConfiguration	指定虚拟机上的 Windows 操作系统设置。

ApplicationServerConfiguration

获取或设置应用程序服务器配置。

名称	类型	说明
instanceCount	integer	应用服务器实例数。
subnetId	string	子网 ID。
virtualMachineConfiguration	VirtualMachineConfiguration	获取或设置虚拟机配置。

ApplicationServerFullResourceNames

应用程序层资源的完整资源名称对象。 此列表中的条目数应等于要为应用程序层创建的 VM 数。

名称	类型	说明
availabilitySetName	string	可用性集的全名。 如果未提供名称，它将默认为 {SID}-App-AvSet。
virtualMachines	VirtualMachineResourceNames[]	虚拟机命名详细信息的列表。

CentralServerConfiguration

获取或设置中央服务器配置。

名称	类型	说明
instanceCount	integer	中央服务器 VM 的数目。
subnetId	string	子网 ID。
virtualMachineConfiguration	VirtualMachineConfiguration	获取或设置虚拟机配置。

CentralServerFullResourceNames

中心服务器层资源的完整资源名称对象。

名称	类型	说明
availabilitySetName	string	可用性集的全名。 如果未提供名称，则默认为 {SID}-ASCS-AvSet。
loadBalancer	LoadBalancerResourceNames	负载均衡器和相关资源的资源名称对象。
virtualMachines	VirtualMachineResourceNames[]	要部署的所有 ASCS 虚拟机的名称列表。 此列表中的条目数应等于要为 ASCS 层创建的 VM 数。 此层最多可以有两个虚拟机：ASCS 和 ERS。

CreateAndMountFileShareConfiguration

获取或设置文件共享配置，其中将创建传输目录文件共享并将其装载为创建基础结构流的一部分。 请预先创建要放置传输目录的资源组。 存储帐户和文件共享将由 ACSS 自动创建，无需预先创建。

名称	类型	说明
configurationType	string: CreateAndMount	文件共享配置的类型。
resourceGroup	string	传输文件共享资源组的名称。 这应该由客户预先创建。 应用 rg 用于缺少输入的情况。
storageAccountName	string	文件共享存储帐户的名称 。 在缺少输入时使用自定义名称。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseConfiguration

获取或设置数据库配置。

名称	类型	说明
databaseType	SAPDatabaseType	数据库类型。
diskConfiguration	DiskConfiguration	获取或设置磁盘配置。
instanceCount	integer	数据库 VM 的数目。
subnetId	string	子网 ID。
virtualMachineConfiguration	VirtualMachineConfiguration	获取或设置虚拟机配置。

DatabaseServerFullResourceNames

数据库层资源的完整资源名称对象。 此列表中的条目数应等于要为数据库层创建的 VM 数。

名称	类型	说明
availabilitySetName	string	可用性集的全名。 如果未提供名称，则默认为 {SID}-DB-AvSet。
loadBalancer	LoadBalancerResourceNames	负载均衡器和相关资源的资源名称对象。
virtualMachines	VirtualMachineResourceNames[]	虚拟机命名详细信息的列表。

DeployerVmPackages

定义上传部署程序 VM 包的 URL 和存储帐户 ID

名称	类型	说明
storageAccountId	string	部署程序 VM 包存储帐户 ID
url	string	部署程序 VM 包文件的 URL。

DeploymentConfiguration

部署配置。

名称	类型	说明
appLocation	string	要在其中创建 SAP 系统的地理位置。
configurationType	string: Deployment	配置类型。
infrastructureConfiguration	InfrastructureConfiguration: SingleServerConfiguration ThreeTierConfiguration	基础结构配置。
softwareConfiguration	SoftwareConfiguration: ExternalInstallationSoftwareConfiguration SAPInstallWithoutOSConfigSoftwareConfiguration ServiceInitiatedSoftwareConfiguration	软件配置。

DeploymentWithOSConfiguration

部署以及 OS 配置。

名称	类型	说明
appLocation	string	要在其中创建 SAP 系统的地理位置。
configurationType	string: DeploymentWithOSConfig	配置类型。
infrastructureConfiguration	InfrastructureConfiguration: SingleServerConfiguration ThreeTierConfiguration	基础结构配置。
osSapConfiguration	OsSapConfiguration	OS 和 SAP 配置。
softwareConfiguration	SoftwareConfiguration: ExternalInstallationSoftwareConfiguration SAPInstallWithoutOSConfigSoftwareConfiguration ServiceInitiatedSoftwareConfiguration	软件配置。

DiscoveryConfiguration

发现详细信息。

名称	类型	说明
appLocation	string	SAP 系统所在的地理位置。
centralServerVmId	string	中央服务器的虚拟机 ID。
configurationType	string: Discovery	配置类型。
managedRgStorageAccountName	string	在 VIS 部署过程中创建的托管资源组中由服务创建的存储帐户的自定义存储帐户名称。 请参阅 此处的存储帐户命名规则。 如果未提供，该服务将使用随机名称创建存储帐户。

DiskConfiguration

磁盘配置详细信息。

名称	类型	说明
diskVolumeConfigurations	<string,  DiskVolumeConfiguration>	数据库卷的磁盘配置。 对于 HANA，必需的卷为：['hana/data'， 'hana/log'， hana/shared'， 'usr/sap'， 'os']，可选卷 ： ['backup']。

DiskSku

磁盘 SKU 的类型。 例如，Standard_LRS、Standard_ZRS、Premium_LRS、Premium_ZRS。

名称	类型	说明
name	DiskSkuName	定义磁盘 SKU 名称。

DiskSkuName

定义磁盘 SKU 名称。

名称	类型	说明
PremiumV2_LRS	string
Premium_LRS	string
Premium_ZRS	string
StandardSSD_LRS	string
StandardSSD_ZRS	string
Standard_LRS	string
UltraSSD_LRS	string

DiskVolumeConfiguration

所选卷所需的磁盘配置。

名称	类型	说明
count	integer	相关卷所需的磁盘总数。
sizeGB	integer	磁盘大小（以 GB 为单位）。
sku	DiskSku	磁盘 SKU 详细信息。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDefinition

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	ErrorDefinition[]	内部错误详细信息。
message	string	错误的说明。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExternalInstallationSoftwareConfiguration

在服务外部安装软件时，SAP 软件配置输入。

名称	类型	说明
centralServerVmId	string	包含中央服务器实例的虚拟机的资源 ID。
softwareInstallationType	string: External	SAP 软件安装类型。

HighAvailabilityConfiguration

获取或设置高可用性配置。

名称	类型	说明
highAvailabilityType	SAPHighAvailabilityType	高可用性类型。

HighAvailabilitySoftwareConfiguration

获取或设置 HA 软件配置。

名称	类型	说明
fencingClientId	string	隔离客户端 ID。
fencingClientPassword	string	隔离客户端 ID 机密/密码。 机密不应过期。 这将用于启动/停止群集 VM。

ImageReference

指定有关要使用的映像的信息。 可以指定有关平台映像、市场映像或虚拟机映像的信息。 若要使用平台映像、市场映像或虚拟机映像，但未在其他创建操作中使用，则此元素是必需的。 注意：只能在创建规模集时设置映像引用发布者和产品/服务。

名称	类型	说明
offer	string	指定用于创建虚拟机的平台映像或市场映像的套餐。
publisher	string	映像发布者。
sku	string	映像 SKU。
version	string	指定用于创建虚拟机的平台映像或市场映像的版本。 允许的格式为 Major.Minor.Build 或“latest”。 “主要”、“次要”和“生成”是十进制数。 指定“latest”以使用部署时可用的最新版本的映像。 即使使用“latest”，VM 映像也不会在部署后自动更新，即使新版本可用。

LinuxConfiguration

指定虚拟机上的 Linux 操作系统设置。

有关支持的 Linux 发行版的列表，请参阅 Linux on Azure-Endorsed Distributions。

名称	类型	说明
disablePasswordAuthentication	boolean	指定是否应禁用密码身份验证。
osType	string: Linux	OS 类型
ssh	SshConfiguration	指定 Linux OS 的 SSH 密钥配置。 (此属性已弃用，请改用“sshKeyPair”)
sshKeyPair	SshKeyPair	用于向 VM 进行身份验证的 SSH 密钥对。

LoadBalancerResourceNames

负载均衡器和相关资源的资源名称对象。

名称	类型	说明
backendPoolNames	string[]	后端池名称的列表。 目前，ACSS 仅部署一个后端池，因此，此列表的大小应为 1
frontendIpConfigurationNames	string[]	前端 IP 配置名称的列表。 如果作为输入提供，则对于 cs 层，此列表的大小应为 2，对于数据库层应为 1。
healthProbeNames	string[]	运行状况探测名称的列表。 如果作为输入提供，则对于 cs 层，此列表的大小应为 2，对于数据库层应为 1。
loadBalancerName	string	负载均衡器的完整资源名称。 如果未提供此值，负载均衡器的名称将为 {ASCS/DB}-loadBalancer。

ManagedRGConfiguration

托管资源组配置

名称	类型	说明
name	string	托管资源组名称

ManagedServiceIdentityType

托管服务标识的类型仅 (None，) 允许使用 UserAssigned 类型。

名称	类型	说明
None	string
UserAssigned	string

MountFileShareConfiguration

获取或设置文件共享配置，其中传输目录文件共享已存在，并且用户希望将文件共享装载为创建基础结构流的一部分。

名称	类型	说明
configurationType	string: Mount	文件共享配置的类型。
id	string	文件共享资源 ID
privateEndpointId	string	专用终结点资源 ID

NamingPatternType

要用于资源命名的模式类型。

名称	类型	说明
FullResourceName	string

NetworkConfiguration

定义正在部署的 SAP 系统基础结构的网络配置类型

名称	类型	默认值	说明
isSecondaryIpEnabled	boolean	False	指定是否应将辅助 IP 地址添加到正在部署的 SAP 系统的所有 VM 上的网络接口

NetworkInterfaceResourceNames

网络接口和相关资源的资源名称对象。

名称	类型	说明
networkInterfaceName	string	网络接口的全名。 如果未提供名称，则服务会根据部署类型使用默认名称。 对于 SingleServer，默认名称为 {SID}-Nic。 对于 HA-AvZone 系统，如果每层超过 1 个实例，默认名称将为 {SID}-{App/ASCS/DB}-Zone{A/B}-Nic，末尾有一个增量器。 对于分布式和 HA-AvSet 系统，如果每层超过 1 个实例，默认名称将为 {SID}-{App/ASCS/DB}-Nic，末尾有一个递增器。

OSProfile

指定虚拟机的操作系统设置。 预配 VM 后，无法更改某些设置。

名称	类型	说明
adminPassword	string	指定管理员帐户的密码。 Windows) 最小长度 (： 8 个字符 Linux) 最小长度 (： 6 个字符 最大长度 (Windows) ： 123 个字符 最大长度 (Linux) ： 72 个字符 复杂性要求： 需要满足以下 4 个条件中的 3 个 包含较低字符 包含大写字符 有一个数字 具有一个特殊字符 (正则表达式匹配 [\W_]) 不允许的值： “abc@123”、“P@$$w 0rd”、“P@ssw0rd”、“P@ssword123”、“Pa$$word”、“pass@word1”、“Password！”、“Password1”、“Password22”、“iloveyou！” 有关重置密码的信息，请参阅 如何在 Windows VM 中重置远程桌面服务或其登录密码 有关重置 root 密码的信息，请参阅使用 VMAccess 扩展管理用户、SSH 和检查或修复 Azure Linux VM 上的磁盘
adminUsername	string	指定管理员帐户的名称。 创建 VM 后，无法更新此属性。 仅限 Windows 的限制： 不能以“.”结尾 不允许的值： “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”。 Linux) (最小长度： 1 个字符 最大长度 (Linux) ： 64 个字符 最大长度 (Windows) ： 20 个字符。
osConfiguration	OSConfiguration: LinuxConfiguration WindowsConfiguration	指定虚拟机上的 Windows 操作系统设置。

OsSapConfiguration

定义部署的 OS 和 SAP 配置

名称	类型	说明
deployerVmPackages	DeployerVmPackages	上传部署程序 VM 包的 URL 和存储帐户 ID
sapFqdn	string	要为 SAP 系统设置的 FQDN

SAPDatabaseType

定义支持的 SAP 数据库类型。

名称	类型	说明
DB2	string
HANA	string

SAPDeploymentType

部署类型。 例如：SingleServer/ThreeTier

名称	类型	说明
SingleServer	string
ThreeTier	string

SAPEnvironmentType

定义环境类型 - 生产/非生产。

名称	类型	说明
NonProd	string
Prod	string

SAPHealthState

定义 SAP 实例的运行状况。

名称	类型	说明
Degraded	string
Healthy	string
Unhealthy	string
Unknown	string

SAPHighAvailabilityType

高可用性类型。

名称	类型	说明
AvailabilitySet	string
AvailabilityZone	string

SAPInstallWithoutOSConfigSoftwareConfiguration

SAP 软件配置输入，当软件要由没有 OS 配置的服务安装时

名称	类型	说明
bomUrl	string	BOM) 文件的 SAP 内部版本 (URL。
highAvailabilitySoftwareConfiguration	HighAvailabilitySoftwareConfiguration	获取或设置 HA 软件配置。
sapBitsStorageAccountId	string	SAP 位存储帐户 ID。
softwareInstallationType	string: SAPInstallWithoutOSConfig	SAP 软件安装类型。
softwareVersion	string	要安装的软件版本。

SAPProductType

定义 SAP 产品类型。

名称	类型	说明
ECC	string
Other	string
S4HANA	string

SAPSoftwareInstallationType

SAP 软件安装类型。

名称	类型	说明
External	string
SAPInstallWithoutOSConfig	string
ServiceInitiated	string

SAPVirtualInstance

定义 SAP 解决方案的虚拟实例资源。

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	UserAssignedServiceIdentity	预先创建的用户分配的标识，其中分配了相应的角色。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。
location	string	资源所在的地理位置
name	string	资源的名称
properties.configuration	SAPConfiguration: DeploymentConfiguration DeploymentWithOSConfiguration DiscoveryConfiguration	定义是使用适用于 SAP 解决方案的 Azure 中心 (ACSS) 创建 SAP 系统，还是向 ACSS 注册现有 SAP 系统
properties.environment	SAPEnvironmentType	定义环境类型 - 生产/非生产。
properties.errors	SAPVirtualInstanceError	指示 SAP 解决方案资源虚拟实例上出现的任何错误。
properties.health	SAPHealthState	定义 SAP 实例的运行状况。
properties.managedResourceGroupConfiguration	ManagedRGConfiguration	托管资源组配置
properties.provisioningState	SapVirtualInstanceProvisioningState	定义预配状态。
properties.sapProduct	SAPProductType	定义 SAP 产品类型。
properties.state	SAPVirtualInstanceState	定义 SAP 状态的虚拟实例。
properties.status	SAPVirtualInstanceStatus	定义 SAP 实例状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SAPVirtualInstanceError

来自 SAP 工作负载服务的虚拟实例的错误响应。

名称	类型	说明
properties	ErrorDefinition	SAP 的虚拟实例错误正文。

SapVirtualInstanceProvisioningState

定义预配状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

SAPVirtualInstanceState

定义 SAP 状态的虚拟实例。

名称	类型	说明
DiscoveryFailed	string
DiscoveryInProgress	string
DiscoveryPending	string
InfrastructureDeploymentFailed	string
InfrastructureDeploymentInProgress	string
InfrastructureDeploymentPending	string
RegistrationComplete	string
SoftwareDetectionFailed	string
SoftwareDetectionInProgress	string
SoftwareInstallationFailed	string
SoftwareInstallationInProgress	string
SoftwareInstallationPending	string

SAPVirtualInstanceStatus

定义 SAP 实例状态。

名称	类型	说明
Offline	string
PartiallyRunning	string
Running	string
SoftShutdown	string
Starting	string
Stopping	string
Unavailable	string

ServiceInitiatedSoftwareConfiguration

服务安装软件时的 SAP 软件配置输入。

名称	类型	说明
bomUrl	string	BOM) 文件的 SAP 内部版本 (URL。
highAvailabilitySoftwareConfiguration	HighAvailabilitySoftwareConfiguration	获取或设置 HA 软件配置。
sapBitsStorageAccountId	string	SAP 位存储帐户 ID。
sapFqdn	string	在安装期间为 SAP 系统设置的 FQDN。
softwareInstallationType	string: ServiceInitiated	SAP 软件安装类型。
softwareVersion	string	要安装的软件版本。
sshPrivateKey	string	SSH 私钥。

sharedStorageResourceNames

共享存储的资源名称对象。

名称	类型	说明
sharedStorageAccountName	string	共享存储帐户的全名。 如果未提供，则默认为 {SID}nfs{guid，共 15 个字符}。
sharedStorageAccountPrivateEndPointName	string	共享存储帐户的专用终结点的全名。 如果未提供，则默认为 {storageAccountName}_pe

SingleServerConfiguration

获取或设置单一服务器配置。 有关创建基础结构的先决条件，请参阅 此处

名称	类型	说明
appResourceGroup	string	将部署 SAP 系统资源的应用程序资源组。
customResourceNames	SingleServerCustomResourceNames: SingleServerFullResourceNames	要用于 SAP 系统一部分的基础 Azure 资源的自定义名称集。
databaseType	SAPDatabaseType	数据库类型。
dbDiskConfiguration	DiskConfiguration	获取或设置磁盘配置。
deploymentType	string: SingleServer	SAP 部署、单一服务器或三层的类型。
networkConfiguration	NetworkConfiguration	服务器的网络配置
subnetId	string	子网 ID。
virtualMachineConfiguration	VirtualMachineConfiguration	获取或设置虚拟机配置。

SingleServerFullResourceNames

资源名称对象，其中指定的值将是单个服务器 SAP 系统中相应资源的完整资源名称。

名称	类型	说明
namingPatternType	string: FullResourceName	要用于资源命名的模式类型。
virtualMachine	VirtualMachineResourceNames	虚拟机和相关资源的资源名称对象。

SkipFileShareConfiguration

获取或设置不创建或不需要传输目录文件共享的方案的文件共享配置。

名称	类型	说明
configurationType	string: Skip	文件共享配置的类型。

SshConfiguration

适用于在 Azure 上运行的基于 Linux 的 VM 的 SSH 配置

名称	类型	说明
publicKeys	SshPublicKey[]	用于在基于 Linux 的 VM 中进行身份验证的 SSH 公钥列表。

SshKeyPair

用于向 VM 进行身份验证的 SSH 密钥对。 密钥需要至少为 2048 位且采用 ssh-rsa 格式。

若要创建 SSH 密钥，请参阅 在 Linux 和 Mac 上为 Azure 中的 Linux VM 创建 SSH 密钥。

名称	类型	说明
privateKey	string	SSH 私钥。
publicKey	string	SSH 公钥

SshPublicKey

包含有关 SSH 证书公钥以及放置公钥的 Linux VM 上的路径的信息。

名称	类型	说明
keyData	string	用于通过 ssh 向 VM 进行身份验证的 SSH 公钥证书。 密钥需要至少为 2048 位且采用 ssh-rsa 格式。 若要创建 SSH 密钥，请参阅 在 Linux 和 Mac 上为 Azure 中的 Linux VM 创建 SSH 密钥。

StorageConfiguration

获取或设置存储配置。

名称	类型	说明
transportFileShareConfiguration	FileShareConfiguration: CreateAndMountFileShareConfiguration MountFileShareConfiguration SkipFileShareConfiguration	附加到 VIS 的传输目录的属性。 如果缺少存储配置，则 transportFileShareConfiguration 的默认值为 createAndMount 流。

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

ThreeTierConfiguration

获取或设置三层 SAP 配置。 有关创建基础结构的先决条件，请参阅 此处

名称	类型	说明
appResourceGroup	string	将部署 SAP 系统资源的应用程序资源组。
applicationServer	ApplicationServerConfiguration	应用程序服务器配置。
centralServer	CentralServerConfiguration	中央服务器配置。
customResourceNames	ThreeTierCustomResourceNames: ThreeTierFullResourceNames	要用于 SAP 系统一部分的基础 Azure 资源的自定义名称集。
databaseServer	DatabaseConfiguration	数据库配置。
deploymentType	string: ThreeTier	SAP 部署、单一服务器或三层的类型。
highAvailabilityConfig	HighAvailabilityConfiguration	高可用性配置。
networkConfiguration	NetworkConfiguration	所有服务器通用的网络配置
storageConfiguration	StorageConfiguration	存储配置。

ThreeTierFullResourceNames

资源名称对象，其中指定的值将是三层 SAP 系统中相应资源的完整资源名称。

名称	类型	说明
applicationServer	ApplicationServerFullResourceNames	应用程序层资源的完整资源名称对象。 此列表中的条目数应等于要为应用程序层创建的 VM 数。
centralServer	CentralServerFullResourceNames	中心服务器层资源的完整资源名称对象。
databaseServer	DatabaseServerFullResourceNames	数据库层资源的完整资源名称对象。 此列表中的条目数应等于要为数据库层创建的 VM 数。
namingPatternType	string: FullResourceName	要用于资源命名的模式类型。
sharedStorage	sharedStorageResourceNames	共享存储的资源名称对象。

UpdateSAPVirtualInstanceRequest

定义用于更新 SAP 虚拟实例的请求正文。

名称	类型	说明
identity	UserAssignedServiceIdentity	预先创建的用户分配的标识，其中分配了相应的角色。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。
tags	object	获取或设置资源标记。

UserAssignedIdentity

用户分配的标识属性

名称	类型	说明
clientId	string	已分配标识的客户端 ID。
principalId	string	分配的标识的主体 ID。

UserAssignedServiceIdentity

预先创建的用户分配的标识，其中分配了相应的角色。 若要详细了解所需的标识和角色，请访问 ACSS 操作指南。

名称	类型	说明
type	ManagedServiceIdentityType	管理标识的类型
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned 标识 用户分配的标识字典

VirtualMachineConfiguration

定义虚拟机配置。

名称	类型	说明
imageReference	ImageReference	图像引用。
osProfile	OSProfile	OS 配置文件。
vmSize	string	虚拟机大小。

VirtualMachineResourceNames

虚拟机和相关资源的资源名称对象。

名称	类型	说明
dataDiskNames	object	虚拟机数据磁盘的完整资源名称。 这是一个字典，其中包含每个卷的数据磁盘的名称列表。 数据库层当前支持的卷为 ['hana/data'、 'hana/log'、 hana/shared'、 'usr/sap'、 'os'、 'backup']。 对于应用程序和 cs 层，仅支持“默认”卷
hostName	string	虚拟机主机的全名 (计算机名) 。 目前，ACSS 仅支持长度小于或等于 13 个字符的主机名。 如果未提供此值，vmName 将用作主机名。
networkInterfaces	NetworkInterfaceResourceNames[]	所选虚拟机的网络接口名称对象列表。 目前，每个虚拟机仅支持一个网络接口。
osDiskName	string	附加到 VM 的 OS 磁盘的全名。 如果未提供此值，ARM 将按照其默认命名标准对其进行命名， (前缀为 vm 名称) 。 每个虚拟机只附加了一个 OS 磁盘。
vmName	string	虚拟机的全名。 此字段的长度最多可以为 64 个字符。 如果未提供名称，则服务会根据部署类型使用默认名称。 对于 SingleServer，默认名称为 {SID}vm。 对于 HA-AvZone 系统，如果每层超过 1 个 vm，默认名称将为 {SID}{app/ascs/db}z{a/b}vm，末尾有一个增量器。 对于分布式和 HA-AvSet 系统，如果每层超过 1 个 vm，默认名称将为 {SID}{app/ascs/db}vm，末尾有一个增量器。

WindowsConfiguration

指定虚拟机上的 Windows 操作系统设置。

名称	类型	说明
osType	string: Windows	OS 类型