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

Managed Clusters - List Cluster User Credentials

列出托管群集的用户凭据。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential?api-version=2024-05-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential?api-version=2024-05-01&server-fqdn={server-fqdn}&format={format}

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 名称不区分大小写。

resourceName
path True

string

托管群集资源的名称。

正则表达式模式: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$

subscriptionId
path True

string

uuid

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

用于此操作的 API 版本。

format
query

format

仅适用于 AAD 群集,指定返回的 kubeconfig 的格式。 格式“azure”将返回 azure 身份验证提供程序 kubeconfig;格式“exec”将返回 exec format kubeconfig,该格式需要路径中的 kubelogin 二进制文件。

server-fqdn
query

string

要返回的凭据的服务器 fqdn 类型

响应

名称 类型 说明
200 OK

CredentialResults

还行

Other Status Codes

CloudError

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get Managed Cluster

示例请求

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/listClusterUserCredential?api-version=2024-05-01

示例响应

{
  "kubeconfigs": [
    {
      "name": "credentialName1",
      "value": "Y3JlZGVudGlhbFZhbHVlMQ=="
    }
  ]
}

定义

名称 说明
CloudError

容器服务的错误响应。

CloudErrorBody

容器服务的错误响应。

CredentialResult

凭据结果响应。

CredentialResults

列表凭据结果响应。

format

仅适用于 AAD 群集,指定返回的 kubeconfig 的格式。 格式“azure”将返回 azure 身份验证提供程序 kubeconfig;格式“exec”将返回 exec format kubeconfig,该格式需要路径中的 kubelogin 二进制文件。

CloudError

容器服务的错误响应。

名称 类型 说明
error

CloudErrorBody

有关错误的详细信息。

CloudErrorBody

容器服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,旨在适合在用户界面中显示。

target

string

特定错误的目标。 例如,错误属性的名称。

CredentialResult

凭据结果响应。

名称 类型 说明
name

string

凭据的名称。

value

string

Base64 编码的 Kubernetes 配置文件。

CredentialResults

列表凭据结果响应。

名称 类型 说明
kubeconfigs

CredentialResult[]

Base64 编码的 Kubernetes 配置文件。

format

仅适用于 AAD 群集,指定返回的 kubeconfig 的格式。 格式“azure”将返回 azure 身份验证提供程序 kubeconfig;格式“exec”将返回 exec format kubeconfig,该格式需要路径中的 kubelogin 二进制文件。

名称 类型 说明
azure

string

返回 azure 身份验证提供程序 kubeconfig。 此格式在 v1.22 中已弃用,将在 v1.26 中完全删除。 请参阅:https://aka.ms/k8s/changes-1-26

exec

string

返回 exec 格式 kubeconfig。 此格式需要路径中的 kubelogin 二进制文件。