你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Extensions - Create
创建新的 Kubernetes 群集扩展。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
cluster
|
path | True |
string |
kubernetes 群集的名称。 |
cluster
|
path | True |
string |
Kubernetes 群集资源名称 - 即 managedClusters、connectedClusters、provisionedClusters。 |
cluster
|
path | True |
string |
Kubernetes 群集 RP - 即 Microsoft.ContainerService、Microsoft.Kubernetes、Microsoft.HybridContainerService。 |
extension
|
path | True |
string |
扩展的名称。 |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
identity |
扩展资源的标识 |
|
plan |
计划信息。 |
|
properties.aksAssignedIdentity |
AKS 群集中扩展资源的标识 |
|
properties.autoUpgradeMinorVersion |
boolean |
用于注意此扩展是否参与次要版本的自动升级的标志。 |
properties.configurationProtectedSettings |
object |
敏感配置设置,作为用于配置此扩展的名称/值对。 |
properties.configurationSettings |
object |
配置设置,作为用于配置此扩展的名称/值对。 |
properties.extensionType |
string |
扩展的类型,此资源是其实例。 它必须是扩展发布者向 Microsoft.KubernetesConfiguration 注册的扩展类型之一。 |
properties.releaseTrain |
string |
ReleaseTrain 此扩展参与自动升级 (例如 Stable、Preview 等 ) - 仅当 autoUpgradeMinorVersion 为“true”时。 |
properties.scope |
安装扩展的范围。 |
|
properties.statuses |
此扩展的状态。 |
|
properties.version |
string |
此扩展的用户指定版本为“固定”。 若要使用“version”,autoUpgradeMinorVersion 必须为“false”。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
已成功收到现有资源的请求。 |
|
201 Created |
已成功收到请求。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Create Extension |
Create Extension with Plan |
Create Extension
示例请求
PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor?api-version=2023-05-01
{
"properties": {
"extensionType": "azuremonitor-containers",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"configurationSettings": {
"omsagent.secret.wsid": "fakeTokenPlaceholder",
"omsagent.env.clusterName": "clusterName1"
},
"configurationProtectedSettings": {
"omsagent.secret.key": "secretKeyValue01"
}
}
}
示例响应
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/operationId?api-version=2023-05-01
{
"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": "fakeTokenPlaceholder",
"omsagent.env.clusterName": "clusterName1"
},
"provisioningState": "Creating",
"currentVersion": null,
"statuses": [],
"isSystemExtension": false
}
}
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/{operationId}
x-ms-async-operation-timeout: PT48H
{
"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": "fakeTokenPlaceholder",
"omsagent.env.clusterName": "clusterName1"
},
"provisioningState": "Succeeded",
"currentVersion": "0.1.4",
"statuses": [],
"isSystemExtension": false
}
}
Create Extension with Plan
示例请求
PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote?api-version=2023-05-01
{
"properties": {
"extensionType": "azure-vote",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview"
},
"plan": {
"name": "azure-vote-standard",
"publisher": "Microsoft",
"product": "azure-vote-standard-offer-id"
}
}
示例响应
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/operationId?api-version=2022-04-01-preview
{
"id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
"type": "Microsoft.KubernetesConfiguration/extensions",
"name": "azureVote",
"systemData": {
"createdBy": "string",
"createdByType": "Application",
"createdAt": "2021-09-08T05:10:57.027Z",
"lastModifiedBy": "string",
"lastModifiedByType": "Application",
"lastModifiedAt": "2021-09-08T05:10:57.027Z"
},
"plan": {
"name": "azure-vote-standard",
"publisher": "Microsoft",
"product": "azure-vote-standard-offer-id"
},
"properties": {
"extensionType": "azure-vote",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"version": "0.1.4",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"provisioningState": "Creating",
"statuses": [],
"currentVersion": null,
"isSystemExtension": false
}
}
Operation-Location: /subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/{operationId}
x-ms-async-operation-timeout: PT48H
{
"id": "/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote",
"type": "Microsoft.KubernetesConfiguration/extensions",
"name": "azureVote",
"systemData": {
"createdBy": "string",
"createdByType": "Application",
"createdAt": "2021-09-08T05:10:57.027Z",
"lastModifiedBy": "string",
"lastModifiedByType": "Application",
"lastModifiedAt": "2021-09-08T05:10:57.027Z"
},
"plan": {
"name": "azure-vote-standard",
"publisher": "Microsoft",
"product": "azure-vote-standard-offer-id"
},
"properties": {
"extensionType": "azure-vote",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"version": "0.1.4",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"provisioningState": "Creating",
"statuses": [],
"currentVersion": "0.1.4",
"isSystemExtension": false
}
}
定义
名称 | 说明 |
---|---|
Aks |
AKS 群集中扩展资源的标识 |
AKSIdentity |
标识类型。 |
created |
创建资源的标识类型。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Extension |
扩展对象。 |
Extension |
扩展的状态。 |
Identity |
资源的标识。 |
Level |
状态的级别。 |
Plan |
资源计划。 |
Provisioning |
此扩展的安装状态。 |
Resource |
标识类型。 |
Scope |
扩展的范围。 它可以是群集或命名空间;但不是两者兼而有之。 |
Scope |
指定扩展的范围是群集 |
Scope |
指定扩展的作用域为命名空间 |
system |
与资源的创建和上次修改相关的元数据。 |
AksAssignedIdentity
AKS 群集中扩展资源的标识
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
资源标识的主体 ID。 |
tenantId |
string |
资源的租户 ID。 |
type |
标识类型。 |
AKSIdentityType
标识类型。
名称 | 类型 | 说明 |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
Extension
扩展对象。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
扩展资源的标识 |
||
name |
string |
资源的名称 |
|
plan |
计划信息。 |
||
properties.aksAssignedIdentity |
AKS 群集中扩展资源的标识 |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
用于注意此扩展是否参与次要版本的自动升级的标志。 |
properties.configurationProtectedSettings |
object |
敏感配置设置,作为用于配置此扩展的名称/值对。 |
|
properties.configurationSettings |
object |
配置设置,作为用于配置此扩展的名称/值对。 |
|
properties.currentVersion |
string |
当前安装的扩展版本。 |
|
properties.customLocationSettings |
object |
自定义位置设置属性。 |
|
properties.errorInfo |
来自代理的错误信息 - 例如安装过程中的错误。 |
||
properties.extensionType |
string |
扩展的类型,此资源是其实例。 它必须是扩展发布者向 Microsoft.KubernetesConfiguration 注册的扩展类型之一。 |
|
properties.isSystemExtension |
boolean |
False |
用于注意此扩展是否为系统扩展的标志 |
properties.packageUri |
string |
Helm 包的 URI |
|
properties.provisioningState |
此扩展的安装状态。 |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain 此扩展参与自动升级 (例如 Stable、Preview 等 ) - 仅当 autoUpgradeMinorVersion 为“true”时。 |
properties.scope |
安装扩展的范围。 |
||
properties.statuses |
此扩展的状态。 |
||
properties.version |
string |
此扩展的用户指定版本为“固定”。 若要使用“version”,autoUpgradeMinorVersion 必须为“false”。 |
|
systemData | |||
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
ExtensionStatus
扩展的状态。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
code |
string |
扩展提供的状态代码 |
|
displayStatus |
string |
扩展状态的简短说明。 |
|
level | Information |
状态的级别。 |
|
message |
string |
来自扩展的状态的详细消息。 |
|
time |
string |
DateLiteral (每ISO8601) 指出安装状态的时间。 |
Identity
资源的标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
资源标识的主体 ID。 |
tenantId |
string |
资源的租户 ID。 |
type |
标识类型。 |
LevelType
状态的级别。
名称 | 类型 | 说明 |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
资源计划。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
正在采购的第三方项目的用户定义名称。 |
product |
string |
正在采购的第三方项目。 例如 NewRelic。 产品映射到加入数据市场时为项目指定的 OfferID。 |
promotionCode |
string |
发布者为上述产品/项目提供了在数据市场中预配的促销代码。 |
publisher |
string |
正在购买的第三方项目的发布者。 例如,NewRelic |
version |
string |
所需产品/项目的版本。 |
ProvisioningState
此扩展的安装状态。
名称 | 类型 | 说明 |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
标识类型。
名称 | 类型 | 说明 |
---|---|---|
SystemAssigned |
string |
Scope
扩展的范围。 它可以是群集或命名空间;但不是两者兼而有之。
名称 | 类型 | 说明 |
---|---|---|
cluster |
指定扩展的范围是群集 |
|
namespace |
指定扩展的作用域为命名空间 |
ScopeCluster
指定扩展的范围是群集
名称 | 类型 | 说明 |
---|---|---|
releaseNamespace |
string |
必须为群集范围的扩展放置扩展 Release 的命名空间。 如果此命名空间不存在,则会创建它 |
ScopeNamespace
指定扩展的作用域为命名空间
名称 | 类型 | 说明 |
---|---|---|
targetNamespace |
string |
将为命名空间范围的扩展创建扩展的命名空间。 如果此命名空间不存在,则会创建它 |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |