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

Clusters - Create

参考

Service:: Azure Stack HCI

API Version:: 2024-01-01

Create HCI 群集。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}?api-version=2024-01-01

URI 参数

名称	在	必需	类型	说明
clusterName	path	True	string	群集的名称。
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
identity.type	True	ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
location	True	string	资源所在的地理位置
identity.userAssignedIdentities		<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是请求中 ({}) 的空对象。
properties.aadApplicationObjectId		string	群集 AAD 标识的对象 ID。
properties.aadClientId		string	群集 AAD 标识的应用 ID。
properties.aadServicePrincipalObjectId		string	群集标识服务主体的 ID。
properties.aadTenantId		string	群集 AAD 标识的租户 ID。
properties.cloudManagementEndpoint		string	为从Azure 门户管理配置的终结点。
properties.desiredProperties		ClusterDesiredProperties	群集的所需属性。
properties.softwareAssuranceProperties		SoftwareAssuranceProperties	群集的软件保障属性。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	Cluster	确定
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create cluster

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster?api-version=2024-01-01

{
  "location": "East US",
  "properties": {
    "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
    "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
    "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster",
  "name": "myCluster",
  "type": "Microsoft.AzureStackHCI/clusters",
  "location": "East US",
  "identity": {
    "principalId": "87a834db-2e45-409e-911b-e16a44562ec3",
    "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
    "type": "SystemAssigned"
  },
  "tags": {},
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "status": "NotYetRegistered",
    "connectivityStatus": "NotYetRegistered",
    "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0",
    "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com",
    "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc",
    "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94",
    "desiredProperties": {
      "windowsServerSubscription": "Disabled",
      "diagnosticLevel": "Basic"
    },
    "reportedProperties": {},
    "trialDaysRemaining": 30,
    "billingModel": "Trial",
    "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus"
  }
}

定义

名称	说明
Cluster	群集详细信息。
ClusterDesiredProperties	群集的所需属性。
ClusterNode	群集节点详细信息。
ClusterNodeType	群集节点硬件的类型。
ClusterReportedProperties	群集代理报告的属性。
ConnectivityStatus	群集资源的总体连接状态。
createdByType	创建资源的标识类型。
DiagnosticLevel	群集发出的所需级别的诊断数据。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ImdsAttestation	群集的 IMDS 证明状态。
IsolatedVmAttestationConfiguration	独立 VM (的证明配置，例如群集的 TVM、CVM) 。
ManagedServiceIdentityType	) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。
OemActivation	节点的 OEM 激活状态。
ProvisioningState	预配状态。
SoftwareAssuranceIntent	软件保障权益的客户意向。
SoftwareAssuranceProperties	群集的软件保障属性。
SoftwareAssuranceStatus	群集的软件保障的状态。
Status	群集代理的状态。
systemData	与资源的创建和上次修改相关的元数据。
UserAssignedIdentity	用户分配的标识属性
WindowsServerSubscription	Windows Server 订阅的所需状态。

Cluster

群集详细信息。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string	系统分配的标识的服务主体 ID。此属性仅针对系统分配的标识提供。
identity.tenantId	string	系统分配的标识的租户 ID。此属性仅针对系统分配的标识提供。
identity.type	ManagedServiceIdentityType	) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。
identity.userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是请求中) ({} 空对象。
location	string	资源所在的地理位置
name	string	资源的名称
properties.aadApplicationObjectId	string	群集 AAD 标识的对象 ID。
properties.aadClientId	string	群集 AAD 标识的应用 ID。
properties.aadServicePrincipalObjectId	string	群集标识服务主体的 ID。
properties.aadTenantId	string	群集 AAD 标识的租户 ID。
properties.billingModel	string	应用于资源的计费类型。
properties.cloudId	string	唯一的不可变资源 ID。
properties.cloudManagementEndpoint	string	配置为从Azure 门户进行管理的终结点。
properties.connectivityStatus	ConnectivityStatus	群集资源的总体连接状态。
properties.desiredProperties	ClusterDesiredProperties	群集的所需属性。
properties.isolatedVmAttestationConfiguration	IsolatedVmAttestationConfiguration	独立 VM (的证明配置，例如群集的 TVM、CVM) 。
properties.lastBillingTimestamp	string	最近的计费计量时间戳。
properties.lastSyncTimestamp	string	最新的群集同步时间戳。
properties.provisioningState	ProvisioningState	预配状态。
properties.registrationTimestamp	string	第一个群集同步时间戳。
properties.reportedProperties	ClusterReportedProperties	群集代理报告的属性。
properties.resourceProviderObjectId	string	RP 服务主体的对象 ID
properties.serviceEndpoint	string	群集的区域特定 DataPath 终结点。
properties.softwareAssuranceProperties	SoftwareAssuranceProperties	群集的软件保障属性。
properties.status	Status	群集代理的状态。
properties.trialDaysRemaining	number	试用期剩余的天数。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ClusterDesiredProperties

群集的所需属性。

名称	类型	说明
diagnosticLevel	DiagnosticLevel	群集发出的所需级别的诊断数据。
windowsServerSubscription	WindowsServerSubscription	Windows Server 订阅的所需状态。

ClusterNode

群集节点详细信息。

名称	类型	说明
coreCount	number	群集节点上的物理核心数。
ehcResourceId	string	Edge Hardware Center 资源 ID
id	number	群集中节点的 ID。
lastLicensingTimestamp	string	最新的许可时间戳。
manufacturer	string	群集节点硬件的制造商。
memoryInGiB	number	群集节点上 (的总可用内存，以 GiB) 为单位。
model	string	群集节点硬件的模型名称。
name	string	群集节点的名称。
nodeType	ClusterNodeType	群集节点硬件的类型。
oemActivation	OemActivation	节点的 OEM 激活状态。
osDisplayVersion	string	显示群集节点上运行的操作系统的版本。
osName	string	在群集节点上运行的操作系统。
osVersion	string	群集节点上运行的操作系统的版本。
serialNumber	string	群集节点的不可变 ID。
windowsServerSubscription	WindowsServerSubscription	Windows Server 订阅的状态。

ClusterNodeType

群集节点硬件的类型。

名称	类型	说明
FirstParty	string
ThirdParty	string

ClusterReportedProperties

群集代理报告的属性。

名称	类型	说明
clusterId	string	本地群集生成的唯一 ID。
clusterName	string	连接到此资源的本地群集的名称。
clusterType	ClusterNodeType	群集的所有节点的节点类型。
clusterVersion	string	群集软件的版本。
diagnosticLevel	DiagnosticLevel	群集发出的诊断数据的级别。
imdsAttestation	ImdsAttestation	群集的 IMDS 证明状态。
lastUpdated	string	上次群集报告数据的时间。
manufacturer	string	群集所有节点的制造商。
nodes	ClusterNode[]	群集报告的节点列表。
oemActivation	OemActivation	群集的 OEM 激活状态。
supportedCapabilities	string[]	群集支持的功能。

ConnectivityStatus

群集资源的总体连接状态。

名称	类型	说明
Connected	string
Disconnected	string
NotConnectedRecently	string
NotSpecified	string
NotYetRegistered	string
PartiallyConnected	string

createdByType

创建资源的标识类型。

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

DiagnosticLevel

群集发出的所需级别的诊断数据。

名称	类型	说明
Basic	string
Enhanced	string
Off	string

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

ImdsAttestation

群集的 IMDS 证明状态。

名称	类型	说明
Disabled	string
Enabled	string

IsolatedVmAttestationConfiguration

独立 VM (的证明配置，例如群集的 TVM、CVM) 。

名称	类型	说明
attestationResourceId	string	与此群集关联的 Microsoft Azure 证明资源的完全限定的 Azure 资源 ID。
attestationServiceEndpoint	string	群集的 Microsoft Azure 证明服务的区域特定终结点
relyingPartyServiceEndpoint	string	信赖方服务的区域特定终结点。

ManagedServiceIdentityType

) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

OemActivation

节点的 OEM 激活状态。

名称	类型	说明
Disabled	string
Enabled	string

ProvisioningState

预配状态。

名称	类型	说明
Accepted	string
Canceled	string
Connected	string
Creating	string
Deleted	string
Deleting	string
DisableInProgress	string
Disconnected	string
Failed	string
InProgress	string
Moving	string
NotSpecified	string
PartiallyConnected	string
PartiallySucceeded	string
Provisioning	string
Succeeded	string
Updating	string

SoftwareAssuranceIntent

软件保障权益的客户意向。

名称	类型	说明
Disable	string
Enable	string

SoftwareAssuranceProperties

群集的软件保障属性。

名称	类型	说明
lastUpdated	string	验证表示最新的 SA 权益适用性的 TimeStamp。
softwareAssuranceIntent	SoftwareAssuranceIntent	软件保障权益的客户意向。
softwareAssuranceStatus	SoftwareAssuranceStatus	群集的软件保障的状态。

SoftwareAssuranceStatus

群集的软件保障的状态。

名称	类型	说明
Disabled	string
Enabled	string

Status

群集代理的状态。

名称	类型	说明
ConnectedRecently	string
DeploymentFailed	string
DeploymentInProgress	string
DeploymentSuccess	string
Disconnected	string
Error	string
NotConnectedRecently	string
NotSpecified	string
NotYetRegistered	string
ValidationFailed	string
ValidationInProgress	string
ValidationSuccess	string

systemData

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

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

UserAssignedIdentity

用户分配的标识属性

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

WindowsServerSubscription

Windows Server 订阅的所需状态。

名称	类型	说明
Disabled	string
Enabled	string