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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
O nome do cluster kubernetes. |
cluster
|
path | True |
string |
O nome do recurso do cluster do Kubernetes , ou seja, managedClusters, connectedClusters, provisionedClusters. |
cluster
|
path | True |
string |
O RP do cluster do 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 não é sensível a maiúsculas e minúsculas. |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Tipo | Description |
---|---|---|
identity |
Identidade do recurso da Extensão |
|
plan |
As informações do plano. |
|
properties.aksAssignedIdentity |
Identidade do recurso de Extensão num cluster do AKS |
|
properties.autoUpgradeMinorVersion |
boolean |
Sinalizar para ter em atenção se esta extensão participa ou não na atualização automática da versão secundária. |
properties.configurationProtectedSettings |
object |
Definições de configuração sensíveis, 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 da Extensão, da qual este recurso é uma instância. Tem de ser um dos Tipos de Extensão registados no Microsoft.KubernetesConfiguration pelo Editor de extensões. |
properties.releaseTrain |
string |
ReleaseTrain esta extensão participa na atualização automática (por exemplo, Estável, Pré-visualização, etc.) - apenas se autoUpgradeMinorVersion for "true". |
properties.scope |
Âmbito no qual a extensão está instalada. |
|
properties.statuses |
Estado desta extensão. |
|
properties.version |
string |
Versão especificada pelo utilizador da extensão para esta extensão para "afixar". Para utilizar a "versão", autoUpgradeMinorVersion tem de ser "falso". |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Pedido recebido com êxito para um recurso existente. |
|
201 Created |
Pedido recebido com êxito. |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
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 | representar 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=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 da amostra
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
Pedido de amostra
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 da amostra
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
Name | Description |
---|---|
Aks |
Identidade do recurso de Extensão num cluster do AKS |
AKSIdentity |
O tipo de identidade. |
created |
O tipo de identidade que criou o recurso. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Extension |
O objeto Extensão. |
Extension |
Estado da extensão. |
Identity |
Identidade do recurso. |
Level |
Nível do estado. |
Plan |
Planeie o recurso. |
Provisioning |
Estado da instalação desta extensão. |
Resource |
O tipo de identidade. |
Scope |
Âmbito da extensão. Pode ser Cluster ou Espaço de Nomes; mas não ambos. |
Scope |
Especifica que o âmbito da extensão é Cluster |
Scope |
Especifica que o âmbito da extensão é Espaço de Nomes |
system |
Metadados relativos à criação e última modificação do recurso. |
AksAssignedIdentity
Identidade do recurso de Extensão num cluster do AKS
Name | Tipo | Description |
---|---|---|
principalId |
string |
O ID principal da identidade de recurso. |
tenantId |
string |
O ID do inquilino do recurso. |
type |
O tipo de identidade. |
AKSIdentityType
O tipo de identidade.
Name | Tipo | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
O tipo de identidade que criou o recurso.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
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 |
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 a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
Extension
O objeto Extensão.
Name | Tipo | Default value | Description |
---|---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
Identidade do recurso da Extensão |
||
name |
string |
O nome do recurso |
|
plan |
As informações do plano. |
||
properties.aksAssignedIdentity |
Identidade do recurso de Extensão num cluster do AKS |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
Sinalizar para ter em atenção se esta extensão participa ou não na atualização automática da versão secundária. |
properties.configurationProtectedSettings |
object |
Definições de configuração sensíveis, 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 definições de Localização Personalizada. |
|
properties.errorInfo |
Informações de erro do Agente – por exemplo, erros durante a instalação. |
||
properties.extensionType |
string |
Tipo da Extensão, da qual este recurso é uma instância. Tem de ser um dos Tipos de Extensão registados no Microsoft.KubernetesConfiguration pelo Editor de extensões. |
|
properties.isSystemExtension |
boolean |
False |
Sinalizar para notar se esta extensão é uma extensão do sistema |
properties.packageUri |
string |
Uri do pacote Helm |
|
properties.provisioningState |
Estado da instalação desta extensão. |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain esta extensão participa na atualização automática (por exemplo, Estável, Pré-visualização, etc.) - apenas se autoUpgradeMinorVersion for "true". |
properties.scope |
Âmbito no qual a extensão está instalada. |
||
properties.statuses |
Estado desta extensão. |
||
properties.version |
string |
Versão especificada pelo utilizador da extensão para esta extensão para "afixar". Para utilizar a "versão", autoUpgradeMinorVersion tem de ser "falso". |
|
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 |
O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ExtensionStatus
Estado da extensão.
Name | Tipo | Default value | Description |
---|---|---|---|
code |
string |
Código de estado fornecido pela Extensão |
|
displayStatus |
string |
Breve descrição do estado da extensão. |
|
level | Information |
Nível do estado. |
|
message |
string |
Mensagem detalhada do estado da Extensão. |
|
time |
string |
DateLiteral (por ISO8601) a observar a hora do estado de instalação. |
Identity
Identidade do recurso.
Name | Tipo | Description |
---|---|---|
principalId |
string |
O ID principal da identidade de recurso. |
tenantId |
string |
O ID do inquilino do recurso. |
type |
O tipo de identidade. |
LevelType
Nível do estado.
Name | Tipo | Description |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
Planeie o recurso.
Name | Tipo | Description |
---|---|---|
name |
string |
Um nome definido pelo utilizador do Artefacto de Terceiros que está a ser adquirido. |
product |
string |
O artefacto de terceiros que está a ser adquirido. Por exemplo, NewRelic. O produto mapeia para o OfferID especificado para o artefacto no momento da integração do Mercado de Dados. |
promotionCode |
string |
Um fabricante forneceu código de promoção conforme aprovisionado no Mercado de Dados para o referido produto/artefacto. |
publisher |
string |
O editor do Artefacto de Terceiros que está a ser comprado. Por exemplo, NewRelic |
version |
string |
A versão do produto/artefacto pretendido. |
ProvisioningState
Estado da instalação desta extensão.
Name | Tipo | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
O tipo de identidade.
Name | Tipo | Description |
---|---|---|
SystemAssigned |
string |
Scope
Âmbito da extensão. Pode ser Cluster ou Espaço de Nomes; mas não ambos.
Name | Tipo | Description |
---|---|---|
cluster |
Especifica que o âmbito da extensão é Cluster |
|
namespace |
Especifica que o âmbito da extensão é Espaço de Nomes |
ScopeCluster
Especifica que o âmbito da extensão é Cluster
Name | Tipo | Description |
---|---|---|
releaseNamespace |
string |
Espaço de nomes onde a versão da extensão tem de ser colocada, para uma extensão com âmbito de cluster. Se este espaço de nomes não existir, será criado |
ScopeNamespace
Especifica que o âmbito da extensão é Espaço de Nomes
Name | Tipo | Description |
---|---|---|
targetNamespace |
string |
Espaço de nomes onde a extensão será criada para uma extensão no âmbito do Espaço de Nomes. Se este espaço de nomes não existir, será criado |
systemData
Metadados relativos à criação e última modificação do recurso.
Name | 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. |