REST Resource: projects.locations.azureClusters

资源：AzureCluster

在 Azure 上运行的 Anthos 集群。

JSON 表示法 
{
  "name": string,
  "description": string,
  "azureRegion": string,
  "resourceGroupId": string,
  "azureClient": string,
  "networking": {
    object (AzureClusterNetworking)
  },
  "controlPlane": {
    object (AzureControlPlane)
  },
  "authorization": {
    object (AzureAuthorization)
  },
  "azureServicesAuthentication": {
    object (AzureServicesAuthentication)
  },
  "state": enum (State),
  "endpoint": string,
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "workloadIdentityConfig": {
    object (WorkloadIdentityConfig)
  },
  "clusterCaCertificate": string,
  "fleet": {
    object (Fleet)
  },
  "managedResources": {
    object (AzureClusterResources)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "errors": [
    {
      object (AzureClusterError)
    }
  ],
  "monitoringConfig": {
    object (MonitoringConfig)
  }
}
字段
name

string

此资源的名称。

集群名称的格式为 projects/<project-number>/locations/<region>/azureClusters/<cluster-id>。

如需详细了解 Google Cloud Platform 资源名称，请参阅资源名称。
description

string

可选。此集群的人类可读说明。长度不能超过 255 个 UTF-8 编码字节。
azureRegion

string

必需。运行集群的 Azure 区域。

每个 Google Cloud 区域都支持附近的一部分 Azure 区域。您可以调用 locations.getAzureServerConfig 以列出给定 Google Cloud 区域内所有支持的 Azure 区域。
resourceGroupId

string

必需。部署集群资源的资源组的 ARM ID。例如：/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>
azureClient

string

可选。AzureClient 的名称，包含 Anthos Multi-Cloud API 如何连接到 Azure API 的身份验证配置。

应提供 azureClient 或 azureServicesAuthentication。

AzureClient 资源必须与 AzureCluster 位于同一 Google Cloud Platform 项目和区域中。

AzureClient 名称的格式为 projects/<project-number>/locations/<region>/azureClients/<client-id>。

如需详细了解 Google Cloud 资源名称，请参阅资源名称。
networking

object (AzureClusterNetworking)

必需。集群级网络配置。
controlPlane

object (AzureControlPlane)

必需。与集群控制平面相关的配置。
authorization

object (AzureAuthorization)

必需。与集群 RBAC 设置相关的配置。
azureServicesAuthentication

object (AzureServicesAuthentication)

可选。用于管理 Azure 资源的身份验证配置

应提供 azureClient 或 azureServicesAuthentication。
state

enum (State)

仅限输出。集群的当前状态。
endpoint

string

仅限输出。集群的 API 服务器的端点。
uid

string

仅限输出。集群的全局唯一标识符。
reconciling

boolean

仅限输出。如果设置了此字段，则当前正在对集群进行更改。
createTime

string (Timestamp format)

仅限输出。创建此集群的时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。上次更新此集群的时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
etag

string

允许客户端通过乐观并发控制执行一致的“读取-修改-写入”操作。

可在更新和删除请求中发送，以确保客户端在继续操作之前具有最新值。
annotations

map (key: string, value: string)

可选。集群上的注解。

此字段的限制与 Kubernetes 注解相同。所有键和值的总大小不得超过 256k。键可以包含 2 个部分：前缀（可选）和名称（必需），以斜杠 (/) 分隔。前缀必须是 DNS 子网域。名称不得超过 63 个字符，以字母数字字符开头和结尾，中间可以使用短划线 (-)、下划线 (_)、点 (.) 和字母数字字符。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
workloadIdentityConfig

object (WorkloadIdentityConfig)

仅限输出。Workload Identity 设置。
clusterCaCertificate

string

仅限输出。集群信任根的 PEM 编码 x509 证书。
fleet

object (Fleet)

必需。舰队配置。
managedResources

object (AzureClusterResources)

仅限输出。此集群的托管式 Azure 资源。
loggingConfig

object (LoggingConfig)

可选。此集群的 Logging 配置。
errors[]

object (AzureClusterError)

仅限输出。在集群中发现的一组错误。
monitoringConfig

object (MonitoringConfig)

可选。此集群的 Monitoring 配置。

AzureClusterNetworking

ClusterNetworking 包含集群级网络配置。

JSON 表示法 
{
  "virtualNetworkId": string,
  "podAddressCidrBlocks": [
    string
  ],
  "serviceAddressCidrBlocks": [
    string
  ],
  "serviceLoadBalancerSubnetId": string
}
字段
virtualNetworkId

string

必需。与您的集群关联的 VNet 的 Azure Resource Manager (ARM) ID。

集群中的所有组件（即控制平面和节点池）都在单个 VNet 上运行。

示例：/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>

此字段一经创建便无法更改。
podAddressCidrBlocks[]

string

必需。此集群中 Pod 的 IP 地址范围（采用 CIDR 表示法，例如 10.96.0.0/14）。

集群中的所有 Pod 都会分配有这些范围内的唯一 IPv4 地址。仅支持单个范围。

此字段一经创建便无法更改。
serviceAddressCidrBlocks[]

string

必需。此集群中服务的 IP 地址范围（采用 CIDR 表示法，例如 10.96.0.0/14）。

集群中的所有服务都会分配有这些范围内的唯一 IPv4 地址。仅支持单个范围。

创建集群后，此字段便无法更改。
serviceLoadBalancerSubnetId

string

可选。部署 Kubernetes 专用服务类型负载均衡器的子网的 ARM ID。如果未指定，则默认为 AzureControlPlane.subnet_id。

示例：“/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid456”

AzureControlPlane

AzureControlPlane 表示控制平面配置。

JSON 表示法 
{
  "version": string,
  "subnetId": string,
  "vmSize": string,
  "sshConfig": {
    object (AzureSshConfig)
  },
  "rootVolume": {
    object (AzureDiskTemplate)
  },
  "mainVolume": {
    object (AzureDiskTemplate)
  },
  "databaseEncryption": {
    object (AzureDatabaseEncryption)
  },
  "proxyConfig": {
    object (AzureProxyConfig)
  },
  "configEncryption": {
    object (AzureConfigEncryption)
  },
  "tags": {
    string: string,
    ...
  },
  "replicaPlacements": [
    {
      object (ReplicaPlacement)
    }
  ],
  "endpointSubnetId": string
}
字段
version

string

必需。要在控制平面副本上运行的 Kubernetes 版本（例如 1.19.10-gke.1000）。

您可以通过调用 locations.getAzureServerConfig 来列出给定 Google Cloud 区域中所有受支持的版本。
subnetId

string

可选。控制平面的默认子网的 ARM ID。除非指定了 AzureControlPlane.replica_placements，否则控制平面虚拟机会部署在此子网中。如果未指定 AzureControlPlane.endpoint_subnet_id，此子网也将用作 AzureControlPlane.endpoint_subnet_id 的默认值。同样，它将用作 AzureClusterNetworking.service_load_balancer_subnet_id 的默认值。

示例：/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default。
vmSize

string

可选。Azure 虚拟机大小名称。示例：Standard_DS2_v2。

如需了解可用的虚拟机大小，请参阅 https://learn.microsoft.com/zh-cn/azure/virtual-machines/vm-naming-conventions。

如果未指定，则默认为 Standard_DS2_v2。
sshConfig

object (AzureSshConfig)

必需。用于指定如何访问底层控制平面机器的 SSH 配置。
rootVolume

object (AzureDiskTemplate)

可选。与为每个控制平面副本预配的根卷相关的配置。

如果未指定，则默认为 32 GiB Azure 磁盘。
mainVolume

object (AzureDiskTemplate)

可选。与为每个控制平面副本预配的主卷相关的配置。主卷负责存储集群的所有 etcd 状态。

如果未指定，则默认为 8 GiB Azure 磁盘。
databaseEncryption

object (AzureDatabaseEncryption)

可选。与应用层 Secret 加密相关的配置。
proxyConfig

object (AzureProxyConfig)

可选。出站 HTTP(S) 流量的代理配置。
configEncryption

object (AzureConfigEncryption)

可选。与虚拟机 config 加密相关的配置。
tags

map (key: string, value: string)

可选。一组要应用于所有底层控制平面 Azure 资源的标记。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
replicaPlacements[]

object (ReplicaPlacement)

可选。放置控制平面副本的位置配置。

最多可以指定三个副本放置实例。如果设置了 replicaPlacements，则副本放置实例将尽可能均匀地应用于三个控制平面副本。
endpointSubnetId

string

可选。在其中部署控制平面负载均衡器的子网的 ARM ID。如果未指定，则默认为 AzureControlPlane.subnet_id。

示例：“/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123”

AzureDatabaseEncryption

与应用层 Secret 加密相关的配置。

Anthos clusters on Azure 使用 Azure Key Vault 加密 etcd 中的 Kubernetes 静态数据。

JSON 表示法 
{
  "keyId": string
}
字段
keyId

string

必需。用于加密/解密数据的 Azure Key Vault 密钥的 ARM ID。

例如：/subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.KeyVault/vaults/<key-vault-id>/keys/<key-name> 加密将始终使用最新版本的密钥，因此特定版本不受支持。

ReplicaPlacement

控制平面副本的放置位置配置。

JSON 表示法 
{
  "subnetId": string,
  "azureAvailabilityZone": string
}
字段
subnetId

string

必需。适用于特定副本，部署控制平面虚拟机的子网的 ARM ID。确保它是集群配置中虚拟网络下的子网。
azureAvailabilityZone

string

必需。适用于特定副本，用于预配控制平面虚拟机和 ETCD 磁盘的 Azure 可用性区域。

AzureAuthorization

与集群 RBAC 设置相关的配置。

JSON 表示法 
{
  "adminUsers": [
    {
      object (AzureClusterUser)
    }
  ],
  "adminGroups": [
    {
      object (AzureClusterGroup)
    }
  ]
}
字段
adminUsers[]

object (AzureClusterUser)

可选。能够以集群管理员身份执行操作的用户。将创建托管式 ClusterRoleBinding 以向用户授予 cluster-admin ClusterRole。最多可以提供 10 个管理员用户。

如需详细了解 RBAC，请参阅 https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles
adminGroups[]

object (AzureClusterGroup)

可选。能够以集群管理员身份执行操作的用户群组。将创建托管式 ClusterRoleBinding 以向群组授予 cluster-admin ClusterRole。最多可以提供 10 个管理员群组。

如需详细了解 RBAC，请参阅 https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles

AzureClusterUser

Azure 集群的用户类型主体的身份。

JSON 表示法 
{
  "username": string
}
字段
username

string

必需。用户的名称，例如 my-gcp-id@gmail.com。

AzureClusterGroup

Azure 集群的群组类型主体的身份。

JSON 表示法 
{
  "group": string
}
字段
group

string

必需。群组的名称，例如 my-group@domain.com。

AzureServicesAuthentication

用于管理 Azure 资源的身份验证配置。

JSON 表示法 
{
  "tenantId": string,
  "applicationId": string
}
字段
tenantId

string

必需。Azure Active Directory 租户 ID。
applicationId

string

必需。Azure Active Directory 应用 ID。

状态

集群的生命周期状态。

枚举
STATE_UNSPECIFIED 未设置。
PROVISIONING “PROVISIONING”状态表示正在创建集群。
RUNNING “RUNNING”状态表示集群已创建并且完全可用。
RECONCILING “RECONCILING”状态表示集群上正在进行某些工作，例如升级控制平面副本。
STOPPING “STOPPING”状态表示集群正在被删除。
ERROR “ERROR”状态表示集群处于不可恢复的损坏状态。
DEGRADED “DEGRADED”状态表示集群需要用户执行操作才能恢复全部功能。

AzureClusterResources

集群的托管式 Azure 资源。

这些值可能会发生变化，也可能会为空，具体取决于集群的状态。

JSON 表示法 
{
  "networkSecurityGroupId": string,
  "controlPlaneApplicationSecurityGroupId": string
}
字段
networkSecurityGroupId

string

仅限输出。集群网络安全群组的 ARM ID。
controlPlaneApplicationSecurityGroupId

string

仅限输出。控制平面应用安全保障群组的 ARM ID。

AzureClusterError

AzureClusterError 描述了在 Azure 集群上发现的错误。

JSON 表示法 
{
  "message": string
}
字段
message

string

直观易懂的错误说明。

方法

create
(deprecated)

 在给定的 Google Cloud Platform 项目和区域中创建新的 AzureCluster 资源。

delete
(deprecated)

 删除特定的 AzureCluster 资源。

generateAzureAccessToken
(deprecated)

 生成短期有效的访问令牌，以向给定 AzureCluster 资源进行身份验证。

generateAzureClusterAgentToken
(deprecated)

 为集群代理生成访问令牌。

get
(deprecated)

 描述特定的 AzureCluster 资源。

getJwks
(deprecated)

 获取 JSON Web 密钥格式的集群签名密钥的公共组成部分。

list
(deprecated)

 列出给定 Google Cloud 项目和区域中的所有 AzureCluster 资源。

patch
(deprecated)

 更新 AzureCluster。