Extensions - Create
Crie uma nova extensão de cluster do Kubernetes.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2025-03-01
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
cluster
|
path | True |
string pattern: ^.* |
O nome do cluster kubernetes. |
|
cluster
|
path | True |
string pattern: ^[a-zA-Z]*$ |
O nome do recurso do cluster Kubernetes - ou seja, managedClusters, connectedClusters, provisionedClusters, appliances. |
|
cluster
|
path | True |
string |
O cluster Kubernetes RP - ou seja, Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. |
|
extension
|
path | True |
string |
Nome da extensão. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
|
subscription
|
path | True |
string minLength: 1 |
A ID da assinatura de destino. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
| Name | Tipo | Description |
|---|---|---|
| identity |
Identidade do recurso de extensão |
|
| managedBy |
string (arm-id) |
A ID de recurso totalmente qualificada do recurso que gerencia esse recurso. Indica se esse recurso é gerenciado por outro recurso do Azure. Se isso estiver presente, a implantação em modo completo não excluirá o recurso se ele for removido do modelo, uma vez que é gerenciado por outro recurso. |
| plan |
Detalhes do plano de recursos. |
|
| properties.additionalDetails |
Detalhes adicionais fornecidos pelo editor da extensão. |
|
| properties.aksAssignedIdentity |
Identidade do recurso de extensão em um cluster AKS |
|
| properties.autoUpgradeMinorVersion |
boolean |
Sinalize para observar se esta extensão participa na atualização automática da versão secundária ou não. |
| properties.autoUpgradeMode |
O modo de upgrade para upgrade automático. O padrão é "compatível". |
|
| properties.configurationProtectedSettings |
object |
Definições de configuração que são confidenciais, como pares nome-valor para configurar esta extensão. |
| properties.configurationSettings |
object |
Definições de configuração, como pares nome-valor para configurar esta extensão. |
| properties.extensionType |
string |
Tipo de extensão, da qual este recurso é uma instância. Ele deve ser um dos tipos de extensão registrados com Microsoft.KubernetesConfiguration pelo editor de extensão. |
| properties.managementDetails |
Detalhes de gestão da extensão |
|
| properties.releaseTrain |
string |
ReleaseTrain esta extensão participa para atualização automática (por exemplo, Stable, Preview, etc.) - somente se autoUpgradeMinorVersion for 'true'. |
| properties.scope |
Escopo no qual a extensão está instalada. |
|
| properties.statuses |
Status desta extensão. |
|
| properties.version |
string |
Versão especificada pelo usuário da extensão para esta extensão para 'pin'. Para usar 'version', autoUpgradeMinorVersion deve ser 'false'. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
Operação de atualização 'Extensão' de recurso bem-sucedida |
|
| 201 Created |
Operação de criação de 'Extensão' de recurso foi bem-sucedida Cabeçalhos
|
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Description |
|---|---|
| user_impersonation | personificar a sua conta de utilizador |
Exemplos
| Create Extension |
| Create Extension with Plan |
Create Extension
Pedido de amostra
PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor?api-version=2025-03-01
{
"properties": {
"extensionType": "azuremonitor-containers",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"configurationSettings": {
"omsagent.secret.wsid": "fakeTokenPlaceholder",
"omsagent.env.clusterName": "clusterName1"
},
"configurationProtectedSettings": {
"omsagent.secret.key": "secretKeyValue01"
}
}
}
Resposta da amostra
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/operationId?api-version=2025-03-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",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"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
}
}
{
"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",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"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
Pedido de amostra
PUT https://management.azure.com/subscriptions/subId1/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote?api-version=2025-03-01
{
"properties": {
"extensionType": "azure-vote",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview"
},
"plan": {
"name": "azure-vote-standard",
"publisher": "Microsoft",
"product": "azure-vote-standard-offer-id"
}
}
Resposta da amostra
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/azureVote/operations/operationId?api-version=2025-03-01
{
"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",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"version": "0.1.4",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"provisioningState": "Creating",
"statuses": [],
"currentVersion": null,
"isSystemExtension": false
}
}
Azure-AsyncOperation: http://management.azure.com/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Kubernetes/ConnectedClusters/clusterName1/providers/Microsoft.KubernetesConfiguration/extensions/ClusterMonitor/operations/operationId?api-version=2025-03-01
{
"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",
"autoUpgradeMode": "compatible",
"autoUpgradeMinorVersion": true,
"releaseTrain": "Preview",
"version": "0.1.4",
"scope": {
"cluster": {
"releaseNamespace": "kube-system"
}
},
"provisioningState": "Creating",
"statuses": [],
"currentVersion": "0.1.4",
"isSystemExtension": false
}
}
Definições
| Name | Description |
|---|---|
|
Access |
Metadados sobre os detalhes de acesso da entidade gestora da extensão |
|
Additional |
Detalhes adicionais fornecidos pelo editor da extensão. |
|
AKSIdentity |
O tipo de identidade. |
|
Auto |
O modo de upgrade para upgrade automático. O padrão é "compatível". |
|
created |
O tipo de identidade que criou o recurso. |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
| Extension |
O objeto Extension. |
|
Extension |
Identidade do recurso de extensão em um cluster AKS |
|
Extension |
Status da extensão. |
| Identity |
Identidade do recurso. |
|
Level |
Nível do estatuto. |
|
Management |
Metadados sobre a entidade gestora da extensão e as operações permitidas. |
| Plan |
Planeje o recurso. |
|
Provisioning |
O estado de provisionamento do recurso. |
|
Resource |
O tipo de identidade. |
| Scope |
Âmbito da extensão. Pode ser Cluster ou Namespace; mas não ambos. |
|
Scope |
Especifica que o escopo da extensão é Cluster |
|
Scope |
Especifica que o escopo da extensão é Namespace |
|
system |
Metadados referentes à criação e última modificação do recurso. |
AccessDetail
Metadados sobre os detalhes de acesso da entidade gestora da extensão
| Name | Tipo | Description |
|---|---|---|
| allowedActions |
string[] |
Lista de ações permitidas para a entidade |
| description |
string |
A descrição da entidade |
| entity |
string |
A entidade a que se aplicam os dados de acesso |
AdditionalDetails
Detalhes adicionais fornecidos pelo editor da extensão.
| Name | Tipo | Description |
|---|---|---|
| docs |
string |
Documentação para a extensão. |
| releaseNotes |
string |
Notas de lançamento da extensão. |
| troubleshootingGuide |
string |
Guia de resolução de problemas para a extensão. |
AKSIdentityType
O tipo de identidade.
| Valor | Description |
|---|---|
| SystemAssigned |
Identidade SystemAssigned |
| UserAssigned |
Identidade UserAssigned |
| Workload |
Identidade do fluxo de trabalho |
AutoUpgradeMode
O modo de upgrade para upgrade automático. O padrão é "compatível".
| Valor | Description |
|---|---|
| none |
A extensão não será automaticamente atualizada. |
| patch |
A extensão será automaticamente atualizada para a versão mais recente da atualização dentro da versão menor. |
| compatible |
A extensão será automaticamente atualizada para versões compatíveis conforme determinado pelo utilizador. |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
| Name | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O alvo do erro. |
ErrorResponse
Resposta de erro
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
Extension
O objeto Extension.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| id |
string |
ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| identity |
Identidade do recurso de extensão |
||
| managedBy |
string (arm-id) |
A ID de recurso totalmente qualificada do recurso que gerencia esse recurso. Indica se esse recurso é gerenciado por outro recurso do Azure. Se isso estiver presente, a implantação em modo completo não excluirá o recurso se ele for removido do modelo, uma vez que é gerenciado por outro recurso. |
|
| name |
string |
O nome do recurso |
|
| plan |
Detalhes do plano de recursos. |
||
| properties.additionalDetails |
Detalhes adicionais fornecidos pelo editor da extensão. |
||
| properties.aksAssignedIdentity |
Identidade do recurso de extensão em um cluster AKS |
||
| properties.autoUpgradeMinorVersion |
boolean |
True |
Sinalize para observar se esta extensão participa na atualização automática da versão secundária ou não. |
| properties.autoUpgradeMode | compatible |
O modo de upgrade para upgrade automático. O padrão é "compatível". |
|
| properties.configurationProtectedSettings |
object |
Definições de configuração que são confidenciais, como pares nome-valor para configurar esta extensão. |
|
| properties.configurationSettings |
object |
Definições de configuração, como pares nome-valor para configurar esta extensão. |
|
| properties.currentVersion |
string |
Versão atualmente instalada da extensão. |
|
| properties.customLocationSettings |
object |
Propriedades de configurações de local personalizadas. |
|
| properties.errorInfo |
Informações de erro do agente - por exemplo, erros durante a instalação. |
||
| properties.extensionState |
string |
Estado da extensão no cluster. |
|
| properties.extensionType |
string |
Tipo de extensão, da qual este recurso é uma instância. Ele deve ser um dos tipos de extensão registrados com Microsoft.KubernetesConfiguration pelo editor de extensão. |
|
| properties.isSystemExtension |
boolean |
False |
Sinalizar para observar se esta extensão é uma extensão do sistema |
| properties.managementDetails |
Detalhes de gestão da extensão |
||
| properties.packageUri |
string |
Uri do pacote Helm |
|
| properties.provisioningState |
Estado de instalação desta extensão. |
||
| properties.releaseTrain |
string |
Stable |
ReleaseTrain esta extensão participa para atualização automática (por exemplo, Stable, Preview, etc.) - somente se autoUpgradeMinorVersion for 'true'. |
| properties.scope |
Escopo no qual a extensão está instalada. |
||
| properties.statuses |
Status desta extensão. |
||
| properties.version |
string |
Versão especificada pelo usuário da extensão para esta extensão para 'pin'. Para usar 'version', autoUpgradeMinorVersion deve ser 'false'. |
|
| systemData |
Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy. |
||
| type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ExtensionPropertiesAksAssignedIdentity
Identidade do recurso de extensão em um cluster AKS
| Name | Tipo | Description |
|---|---|---|
| clientId |
string |
O ID do cliente da identidade do recurso. |
| objectId |
string |
O ID do objeto da identidade do recurso. |
| principalId |
string |
A ID principal da identidade do recurso. |
| resourceId |
string (arm-id) |
O ID da identidade do recurso. |
| tenantId |
string |
A ID do locatário do recurso. |
| type |
O tipo de identidade. |
ExtensionStatus
Status da extensão.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| code |
string |
Código de status fornecido pela extensão |
|
| displayStatus |
string |
Breve descrição do estado da extensão. |
|
| level | Information |
Nível do estatuto. |
|
| message |
string |
Mensagem detalhada do status da extensão. |
|
| time |
string |
DateLiteral (por ISO8601) observando a hora do status da instalação. |
Identity
Identidade do recurso.
| Name | Tipo | Description |
|---|---|---|
| principalId |
string |
A ID principal da identidade do recurso. |
| tenantId |
string |
A ID do locatário do recurso. |
| type |
O tipo de identidade. |
LevelType
Nível do estatuto.
| Valor | Description |
|---|---|
| Error |
Indica um estado de erro da extensão. |
| Warning |
Indica um estado de aviso da extensão. |
| Information |
Indica um estado informativo da extensão. |
ManagementDetails
Metadados sobre a entidade gestora da extensão e as operações permitidas.
| Name | Tipo | Description |
|---|---|---|
| accessDetails |
Lista de detalhes de acesso da entidade gestora |
|
| category |
string |
A categoria da entidade gestora |
Plan
Planeje o recurso.
| Name | Tipo | Description |
|---|---|---|
| name |
string |
Um nome definido pelo usuário do artefato de 3ª parte que está sendo adquirido. |
| product |
string |
O artefato da 3ª Parte que está sendo adquirido. Por exemplo, NewRelic. O produto é mapeado para o OfferID especificado para o artefato no momento da integração do Data Market. |
| promotionCode |
string |
Um editor forneceu o código promocional conforme previsto no Data Market para o referido produto/artefato. |
| publisher |
string |
O editor do 3rd Party Artifact que está sendo comprado. Por exemplo, NewRelic |
| version |
string |
A versão do produto/artefato desejado. |
ProvisioningState
O estado de provisionamento do recurso.
| Valor | Description |
|---|---|
| Succeeded |
O recurso foi criado. |
| Failed |
Falha na criação de recursos. |
| Canceled |
A criação de recursos foi cancelada. |
| Creating |
O recurso está sendo criado. |
| Updating |
O recurso está sendo atualizado. |
| Deleting |
O recurso está sendo excluído. |
ResourceIdentityType
O tipo de identidade.
| Valor | Description |
|---|---|
| SystemAssigned |
Scope
Âmbito da extensão. Pode ser Cluster ou Namespace; mas não ambos.
| Name | Tipo | Description |
|---|---|---|
| cluster |
Especifica que o escopo da extensão é Cluster |
|
| namespace |
Especifica que o escopo da extensão é Namespace |
ScopeCluster
Especifica que o escopo da extensão é Cluster
| Name | Tipo | Description |
|---|---|---|
| releaseNamespace |
string |
Namespace onde a extensão Release deve ser colocada, para uma extensão com escopo de cluster. Se esse namespace não existir, ele será criado |
ScopeNamespace
Especifica que o escopo da extensão é Namespace
| Name | Tipo | Description |
|---|---|---|
| targetNamespace |
string |
Namespace onde a extensão será criada para uma extensão com escopo Namespace. Se esse namespace não existir, ele será criado |
systemData
Metadados referentes à criação e última modificação do recurso.
| Name | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
O carimbo de data/hora da criação de recursos (UTC). |
| createdBy |
string |
A identidade que criou o recurso. |
| createdByType |
O tipo de identidade que criou o recurso. |
|
| lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
| lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
| lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |