Extensions - Create
Vytvořte nové rozšíření clusteru Kubernetes.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
Název clusteru Kubernetes. |
cluster
|
path | True |
string |
Název prostředku clusteru Kubernetes – tj. managedClusters, connectedClusters, provisionedClusters. |
cluster
|
path | True |
string |
Rp clusteru Kubernetes – tj. Microsoft.ContainerService, Microsoft.Kubernetes a Microsoft.HybridContainerService. |
extension
|
path | True |
string |
Název rozšíření. |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Text požadavku
Name | Typ | Description |
---|---|---|
identity |
Identita prostředku rozšíření |
|
plan |
Informace o plánu. |
|
properties.aksAssignedIdentity |
Identita prostředku rozšíření v clusteru AKS |
|
properties.autoUpgradeMinorVersion |
boolean |
Příznak, který upozorňuje, jestli se toto rozšíření účastní automatického upgradu podverze, nebo ne. |
properties.configurationProtectedSettings |
object |
Nastavení konfigurace, která jsou citlivá jako páry název-hodnota pro konfiguraci tohoto rozšíření. |
properties.configurationSettings |
object |
Nastavení konfigurace jako páry název-hodnota pro konfiguraci tohoto rozšíření. |
properties.extensionType |
string |
Typ rozšíření, jehož je tento prostředek instancí. Musí se jednat o jeden z typů rozšíření zaregistrovaných u Microsoft.KubernetesConfiguration vydavatelem rozšíření. |
properties.releaseTrain |
string |
ReleaseTrain se toto rozšíření účastní pro automatický upgrade (např. Stable, Preview atd.) – pouze v případě, že autoUpgradeMinorVersion má hodnotu true. |
properties.scope |
Obor, ve kterém je rozšíření nainstalované. |
|
properties.statuses |
Stav z tohoto rozšíření. |
|
properties.version |
string |
Uživatelem zadaná verze rozšíření pro toto rozšíření na "připnout". Pokud chcete použít verzi, musí být hodnota autoUpgradeMinorVersion false. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Žádost o existující prostředek byla úspěšně přijata. |
|
201 Created |
Požadavek byl úspěšně přijat. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Create Extension |
Create Extension with Plan |
Create Extension
Ukázkový požadavek
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"
}
}
}
Ukázková odpověď
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
Ukázkový požadavek
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"
}
}
Ukázková odpověď
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
}
}
Definice
Name | Description |
---|---|
Aks |
Identita prostředku rozšíření v clusteru AKS |
AKSIdentity |
Typ identity. |
created |
Typ identity, která prostředek vytvořila. |
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Extension |
Objekt Extension. |
Extension |
Stav z rozšíření. |
Identity |
Identita prostředku. |
Level |
Úroveň stavu. |
Plan |
Naplánujte zdroj. |
Provisioning |
Stav instalace tohoto rozšíření |
Resource |
Typ identity. |
Scope |
Rozsah rozšíření Může to být cluster nebo obor názvů; ale ne oboje. |
Scope |
Určuje, že oborem rozšíření je Cluster. |
Scope |
Určuje, že oborem rozšíření je Obor názvů. |
system |
Metadata týkající se vytvoření a poslední změny prostředku. |
AksAssignedIdentity
Identita prostředku rozšíření v clusteru AKS
Name | Typ | Description |
---|---|---|
principalId |
string |
ID objektu zabezpečení identity prostředku. |
tenantId |
string |
ID tenanta prostředku. |
type |
Typ identity. |
AKSIdentityType
Typ identity.
Name | Typ | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
Typ identity, která prostředek vytvořila.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
Extension
Objekt Extension.
Name | Typ | Default value | Description |
---|---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
|
identity |
Identita prostředku rozšíření |
||
name |
string |
Název prostředku |
|
plan |
Informace o plánu. |
||
properties.aksAssignedIdentity |
Identita prostředku rozšíření v clusteru AKS |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
Příznak, který upozorňuje, jestli se toto rozšíření účastní automatického upgradu podverze, nebo ne. |
properties.configurationProtectedSettings |
object |
Nastavení konfigurace, která jsou citlivá jako páry název-hodnota pro konfiguraci tohoto rozšíření. |
|
properties.configurationSettings |
object |
Nastavení konfigurace jako páry název-hodnota pro konfiguraci tohoto rozšíření. |
|
properties.currentVersion |
string |
Aktuálně nainstalovaná verze rozšíření |
|
properties.customLocationSettings |
object |
Vlastnosti vlastního nastavení umístění |
|
properties.errorInfo |
Informace o chybách z agenta – například chyby během instalace. |
||
properties.extensionType |
string |
Typ rozšíření, jehož je tento prostředek instancí. Musí se jednat o jeden z typů rozšíření zaregistrovaných u Microsoft.KubernetesConfiguration vydavatelem rozšíření. |
|
properties.isSystemExtension |
boolean |
False |
Příznak pro upozornění, jestli je toto rozšíření systémovým rozšířením |
properties.packageUri |
string |
Identifikátor URI balíčku Helm |
|
properties.provisioningState |
Stav instalace tohoto rozšíření |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain se toto rozšíření účastní pro automatický upgrade (např. Stable, Preview atd.) – pouze v případě, že autoUpgradeMinorVersion má hodnotu true. |
properties.scope |
Obor, ve kterém je rozšíření nainstalované. |
||
properties.statuses |
Stav z tohoto rozšíření. |
||
properties.version |
string |
Uživatelem zadaná verze rozšíření pro toto rozšíření na "připnout". Pokud chcete použít verzi, musí být hodnota autoUpgradeMinorVersion false. |
|
systemData |
Metadata nejvyšší úrovně https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
||
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
ExtensionStatus
Stav z rozšíření.
Name | Typ | Default value | Description |
---|---|---|---|
code |
string |
Stavový kód poskytnutý rozšířením |
|
displayStatus |
string |
Stručný popis stavu rozšíření. |
|
level | Information |
Úroveň stavu. |
|
message |
string |
Podrobná zpráva o stavu z rozšíření. |
|
time |
string |
DateLiteral (podle ISO8601) se stavem instalace. |
Identity
Identita prostředku.
Name | Typ | Description |
---|---|---|
principalId |
string |
ID objektu zabezpečení identity prostředku. |
tenantId |
string |
ID tenanta prostředku. |
type |
Typ identity. |
LevelType
Úroveň stavu.
Name | Typ | Description |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
Naplánujte zdroj.
Name | Typ | Description |
---|---|---|
name |
string |
Uživatelem definovaný název artefaktu třetí strany, který je pořizován. |
product |
string |
Artefakt třetí strany, který je pořizován. Například NewRelic. Produkt se mapuje na OFFERID zadané pro artefakt v době registrace datového trhu. |
promotionCode |
string |
Vydavatel poskytl propagační kód pro daný produkt nebo artefakt zřízený na datovém trhu. |
publisher |
string |
Vydavatel artefaktu třetí strany, který se kupuje. Například NewRelic |
version |
string |
Verze požadovaného produktu nebo artefaktu. |
ProvisioningState
Stav instalace tohoto rozšíření
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
Typ identity.
Name | Typ | Description |
---|---|---|
SystemAssigned |
string |
Scope
Rozsah rozšíření Může to být cluster nebo obor názvů; ale ne oboje.
Name | Typ | Description |
---|---|---|
cluster |
Určuje, že oborem rozšíření je Cluster. |
|
namespace |
Určuje, že oborem rozšíření je Obor názvů. |
ScopeCluster
Určuje, že oborem rozšíření je Cluster.
Name | Typ | Description |
---|---|---|
releaseNamespace |
string |
Obor názvů, ve kterém musí být umístěna verze rozšíření pro rozšíření s oborem clusteru. Pokud tento obor názvů neexistuje, vytvoří se. |
ScopeNamespace
Určuje, že oborem rozšíření je Obor názvů.
Name | Typ | Description |
---|---|---|
targetNamespace |
string |
Obor názvů, ve kterém se rozšíření vytvoří pro rozšíření s oborem názvů. Pokud tento obor názvů neexistuje, vytvoří se. |
systemData
Metadata týkající se vytvoření a poslední změny prostředku.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Časové razítko vytvoření prostředku (UTC) |
createdBy |
string |
Identita, která vytvořila prostředek. |
createdByType |
Typ identity, která prostředek vytvořila. |
|
lastModifiedAt |
string |
Časové razítko poslední změny prostředku (UTC) |
lastModifiedBy |
string |
Identita, která naposledy změnila prostředek. |
lastModifiedByType |
Typ identity, která naposledy změnila prostředek. |