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=2023-05-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
O nome do cluster kubernetes. |
cluster
|
path | True |
string |
O nome do recurso de cluster do Kubernetes – ou seja, managedClusters, connectedClusters, provisionedClusters. |
cluster
|
path | True |
string |
O RP do cluster kubernetes – ou seja, Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. |
extension
|
path | True |
string |
Nome da Extensão. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
identity |
Identidade do recurso de extensão |
|
plan |
As informações do plano. |
|
properties.aksAssignedIdentity |
Identidade do recurso de extensão em um cluster do AKS |
|
properties.autoUpgradeMinorVersion |
boolean |
Sinalize para observar se essa extensão participa da atualização automática da versão secundária ou não. |
properties.configurationProtectedSettings |
object |
Configurações confidenciais, como pares nome-valor para configurar essa extensão. |
properties.configurationSettings |
object |
Configurações, como pares nome-valor para configurar essa extensão. |
properties.extensionType |
string |
Tipo da Extensão, da qual esse recurso é uma instância do . Ele deve ser um dos Tipos de Extensão registrados com Microsoft.KubernetesConfiguration pelo editor de extensão. |
properties.releaseTrain |
string |
ReleaseTrain essa extensão participa da atualização automática (por exemplo, Estável, Versão Prévia etc.) – somente se autoUpgradeMinorVersion for 'true'. |
properties.scope |
Escopo no qual a extensão está instalada. |
|
properties.statuses |
Status dessa extensão. |
|
properties.version |
string |
Versão especificada pelo usuário da extensão para essa extensão para "fixar". Para usar 'version', autoUpgradeMinorVersion deve ser 'false'. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Solicitação recebida com êxito para um recurso existente. |
|
201 Created |
Solicitação recebida com êxito. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
Create Extension |
Create Extension with Plan |
Create Extension
Solicitação de exemplo
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"
}
}
}
Resposta de exemplo
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
Solicitação de exemplo
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"
}
}
Resposta de exemplo
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
}
}
Definições
Nome | Description |
---|---|
Aks |
Identidade do recurso de extensão em um cluster do AKS |
AKSIdentity |
O tipo de identidade. |
created |
O tipo de identidade que criou o recurso. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Extension |
O objeto Extension. |
Extension |
Status da extensão. |
Identity |
Identidade do recurso. |
Level |
Nível do status. |
Plan |
Planejar para o recurso. |
Provisioning |
Status da instalação dessa extensão. |
Resource |
O tipo de identidade. |
Scope |
Escopo da extensão. Pode ser cluster ou namespace; mas não os dois. |
Scope |
Especifica que o escopo da extensão é Cluster |
Scope |
Especifica que o escopo da extensão é Namespace |
system |
Metadados relativos à criação e à última modificação do recurso. |
AksAssignedIdentity
Identidade do recurso de extensão em um cluster do AKS
Nome | 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. |
AKSIdentityType
O tipo de identidade.
Nome | Tipo | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
Extension
O objeto Extension.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
Identidade do recurso de extensão |
||
name |
string |
O nome do recurso |
|
plan |
As informações do plano. |
||
properties.aksAssignedIdentity |
Identidade do recurso de extensão em um cluster do AKS |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
Sinalize para observar se essa extensão participa da atualização automática da versão secundária ou não. |
properties.configurationProtectedSettings |
object |
Configurações confidenciais, como pares nome-valor para configurar essa extensão. |
|
properties.configurationSettings |
object |
Configurações, como pares nome-valor para configurar essa extensão. |
|
properties.currentVersion |
string |
Versão atualmente instalada da extensão. |
|
properties.customLocationSettings |
object |
Propriedades de configurações de localização personalizadas. |
|
properties.errorInfo |
Informações de erro do Agent – por exemplo, erros durante a instalação. |
||
properties.extensionType |
string |
Tipo da Extensão, da qual esse recurso é uma instância do . 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 essa extensão é uma extensão do sistema |
properties.packageUri |
string |
Uri do pacote helm |
|
properties.provisioningState |
Status da instalação dessa extensão. |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain essa extensão participa da atualização automática (por exemplo, Estável, Versão Prévia etc.) – somente se autoUpgradeMinorVersion for 'true'. |
properties.scope |
Escopo no qual a extensão está instalada. |
||
properties.statuses |
Status dessa extensão. |
||
properties.version |
string |
Versão especificada pelo usuário da extensão para essa extensão para "fixar". Para usar 'version', autoUpgradeMinorVersion deve ser 'false'. |
|
systemData |
Metadados de nível superior https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
||
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ExtensionStatus
Status da extensão.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
code |
string |
Código de status fornecido pela Extensão |
|
displayStatus |
string |
Breve descrição de status da extensão. |
|
level | Information |
Nível do status. |
|
message |
string |
Mensagem detalhada do status da Extensão. |
|
time |
string |
DateLiteral (por ISO8601) observando a hora da instalação status. |
Identity
Identidade do recurso.
Nome | 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 status.
Nome | Tipo | Description |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
Planejar para o recurso.
Nome | Tipo | Description |
---|---|---|
name |
string |
Um nome definido pelo usuário do Artefato de Terceiros que está sendo adquirido. |
product |
string |
O artefato de terceiros que está sendo adquirido. Por exemplo, NewRelic. O produto é mapeado para o OfferID especificado para o artefato no momento da integração do Mercado de Dados. |
promotionCode |
string |
Um editor forneceu código de promoção conforme provisionado no Mercado de Dados para o produto/artefato dito. |
publisher |
string |
O editor do Artefato de Terceiros que está sendo comprado. Por exemplo, NewRelic |
version |
string |
A versão do produto/artefato desejado. |
ProvisioningState
Status da instalação dessa extensão.
Nome | Tipo | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
O tipo de identidade.
Nome | Tipo | Description |
---|---|---|
SystemAssigned |
string |
Scope
Escopo da extensão. Pode ser cluster ou namespace; mas não os dois.
Nome | 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
Nome | Tipo | Description |
---|---|---|
releaseNamespace |
string |
Namespace em que a versão da extensão 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
Nome | Tipo | Description |
---|---|---|
targetNamespace |
string |
Namespace em que a extensão será criada para uma extensão com escopo de namespace. Se esse namespace não existir, ele será criado |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
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 |
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. |