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

Extensions - Get

获取 Kubernetes 群集扩展。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2022-07-01

URI 参数

Name In Required Type Description
clusterName
path True
  • string

kubernetes 群集的名称。

clusterResourceName
path True
  • string

Kubernetes 群集资源名称 - 即 managedClusters、connectedClusters、provisionedClusters。

clusterRp
path True
  • string

Kubernetes 群集 RP - 例如 Microsoft.ContainerService、Microsoft.Kubernetes、Microsoft.HybridContainerService。

extensionName
path True
  • string

扩展的名称。

resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

确定

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get Extension

Sample Request

GET https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor?api-version=2022-07-01

Sample Response

{
  "id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor",
  "type": "Microsoft.KubernetesConfiguration/extensions",
  "name": "ClusterMonitor",
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2021-09-08T05:10:57.027Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2021-09-08T05:10:57.027Z"
  },
  "properties": {
    "extensionType": "azuremonitor-containers",
    "autoUpgradeMinorVersion": false,
    "releaseTrain": "Preview",
    "version": "0.1.4",
    "scope": {
      "cluster": {
        "releaseNamespace": "kube-system"
      }
    },
    "configurationSettings": {
      "omsagent.secret.wsid": "a38cef99-5a89-52ed-b6db-22095c23664b",
      "omsagent.env.clusterName": "clusterName1"
    },
    "provisioningState": "Succeeded",
    "installedVersion": "0.1.4",
    "statuses": []
  }
}

定义

AksAssignedIdentity

AKS 群集中扩展资源的标识

AKSIdentityType

标识类型。

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Extension

Extension 对象。

ExtensionStatus

扩展的状态。

Identity

资源的标识。

LevelType

状态级别。

ProvisioningState

此扩展的安装状态。

ResourceIdentityType

标识类型。

Scope

扩展的范围。 它可以是群集或命名空间;但不是两者。

ScopeCluster

指定扩展的范围为群集

ScopeNamespace

指定扩展的范围为命名空间

systemData

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

AksAssignedIdentity

AKS 群集中扩展资源的标识

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

AKSIdentityType

标识类型。

Name Type Description
SystemAssigned
  • string
UserAssigned
  • string

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

Extension

Extension 对象。

Name Type Default Value Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

扩展资源的标识

name
  • string

资源的名称

properties.aksAssignedIdentity

AKS 群集中扩展资源的标识

properties.autoUpgradeMinorVersion
  • boolean
True

如果此扩展参与次要版本的自动升级,则标记以记下。

properties.configurationProtectedSettings
  • object

敏感配置设置,作为用于配置此扩展的名称值对。

properties.configurationSettings
  • object

配置设置,作为用于配置此扩展的名称值对。

properties.customLocationSettings
  • object

自定义位置设置属性。

properties.errorInfo

代理中的错误信息-例如安装过程中的错误。

properties.extensionType
  • string

此资源所属的扩展的类型。 它必须是扩展发布者向 Microsoft.KubernetesConfiguration 注册的扩展类型之一。

properties.installedVersion
  • string

已安装的扩展版本。

properties.packageUri
  • string

Helm 包的 URI

properties.provisioningState

此扩展的安装状态。

properties.releaseTrain
  • string
Stable

仅当 autoUpgradeMinorVersion 为“true”时,此扩展才会参与自动升级 (,例如 Stable、Preview 等) 。

properties.scope

安装扩展的范围。

properties.statuses

此扩展的状态。

properties.version
  • string

此扩展的用户指定的扩展版本为“pin”。 若要使用“version”,autoUpgradeMinorVersion 必须为“false”。

systemData

顶级元数据 https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

ExtensionStatus

扩展的状态。

Name Type Default Value Description
code
  • string

扩展提供的状态代码

displayStatus
  • string

扩展状态的简短说明。

level Information

状态级别。

message
  • string

扩展状态的详细消息。

time
  • string

每个 ISO8601 (DateLiteral) 指出安装状态的时间。

Identity

资源的标识。

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

LevelType

状态级别。

Name Type Description
Error
  • string
Information
  • string
Warning
  • string

ProvisioningState

此扩展的安装状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ResourceIdentityType

标识类型。

Name Type Description
SystemAssigned
  • string

Scope

扩展的范围。 它可以是群集或命名空间;但不是两者。

Name Type Description
cluster

指定扩展的范围为群集

namespace

指定扩展的范围为命名空间

ScopeCluster

指定扩展的范围为群集

Name Type Description
releaseNamespace
  • string

对于群集范围的扩展,必须放置扩展版本的命名空间。 如果此命名空间不存在,则会创建该命名空间

ScopeNamespace

指定扩展的范围为命名空间

Name Type Description
targetNamespace
  • string

将为命名空间范围的扩展创建扩展的命名空间。 如果此命名空间不存在,则会创建该命名空间

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。