Extensions - Create
Skapa ett nytt Kubernetes-klustertillägg.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
cluster
|
path | True |
string |
Namnet på kubernetes-klustret. |
cluster
|
path | True |
string |
Kubernetes-klustrets resursnamn, dvs. managedClusters, connectedClusters, provisionedClusters. |
cluster
|
path | True |
string |
Kubernetes-klustrets RP – dvs. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. |
extension
|
path | True |
string |
Namnet på tillägget. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Typ | Description |
---|---|---|
identity |
Tilläggsresursens identitet |
|
plan |
Planinformationen. |
|
properties.aksAssignedIdentity |
Identitet för tilläggsresursen i ett AKS-kluster |
|
properties.autoUpgradeMinorVersion |
boolean |
Flagga för att notera om det här tillägget deltar i automatisk uppgradering av delversion eller inte. |
properties.configurationProtectedSettings |
object |
Konfigurationsinställningar som är känsliga, som namn/värde-par för att konfigurera det här tillägget. |
properties.configurationSettings |
object |
Konfigurationsinställningar, som namn/värde-par för att konfigurera det här tillägget. |
properties.extensionType |
string |
Typ av tillägg, som resursen är en instans av. Det måste vara en av de tilläggstyper som registrerats med Microsoft.KubernetesConfiguration av tilläggets utgivare. |
properties.releaseTrain |
string |
ReleaseTrain det här tillägget deltar för automatisk uppgradering (t.ex. stabil, förhandsversion osv.) – endast om autoUpgradeMinorVersion är "sant". |
properties.scope |
Omfång där tillägget är installerat. |
|
properties.statuses |
Status från det här tillägget. |
|
properties.version |
string |
Användardefinerad version av tillägget för det här tillägget till "pin". Om du vill använda "version" måste autoUpgradeMinorVersion vara "false". |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Begäran har tagits emot för en befintlig resurs. |
|
201 Created |
Begäran har tagits emot. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Create Extension |
Create Extension with Plan |
Create Extension
Exempelbegäran
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"
}
}
}
Exempelsvar
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
Exempelbegäran
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"
}
}
Exempelsvar
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
}
}
Definitioner
Name | Description |
---|---|
Aks |
Identitet för tilläggsresursen i ett AKS-kluster |
AKSIdentity |
Identitetstypen. |
created |
Den typ av identitet som skapade resursen. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Extension |
Tilläggsobjektet. |
Extension |
Status från tillägget. |
Identity |
Identitet för resursen. |
Level |
Statusnivå. |
Plan |
Planera för resursen. |
Provisioning |
Status för installationen av det här tillägget. |
Resource |
Identitetstypen. |
Scope |
Omfånget för tillägget. Det kan vara antingen kluster eller namnområde. men inte båda. |
Scope |
Anger att tilläggets omfång är Kluster |
Scope |
Anger att tilläggets omfång är Namnområde |
system |
Metadata som rör skapande och senaste ändring av resursen. |
AksAssignedIdentity
Identitet för tilläggsresursen i ett AKS-kluster
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID för resursidentitet. |
tenantId |
string |
Resursens klientorganisations-ID. |
type |
Identitetstypen. |
AKSIdentityType
Identitetstypen.
Name | Typ | Description |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
Extension
Tilläggsobjektet.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
Tilläggsresursens identitet |
||
name |
string |
Namnet på resursen |
|
plan |
Planinformationen. |
||
properties.aksAssignedIdentity |
Identitet för tilläggsresursen i ett AKS-kluster |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
Flagga för att notera om det här tillägget deltar i automatisk uppgradering av delversion eller inte. |
properties.configurationProtectedSettings |
object |
Konfigurationsinställningar som är känsliga, som namn/värde-par för att konfigurera det här tillägget. |
|
properties.configurationSettings |
object |
Konfigurationsinställningar, som namn/värde-par för att konfigurera det här tillägget. |
|
properties.currentVersion |
string |
För närvarande installerad version av tillägget. |
|
properties.customLocationSettings |
object |
Egenskaper för anpassade platsinställningar. |
|
properties.errorInfo |
Felinformation från agenten – t.ex. fel under installationen. |
||
properties.extensionType |
string |
Typ av tillägg, som resursen är en instans av. Det måste vara en av de tilläggstyper som registrerats med Microsoft.KubernetesConfiguration av tilläggets utgivare. |
|
properties.isSystemExtension |
boolean |
False |
Flagga för att notera om det här tillägget är ett systemtillägg |
properties.packageUri |
string |
Uri för Helm-paketet |
|
properties.provisioningState |
Status för installationen av det här tillägget. |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain det här tillägget deltar för automatisk uppgradering (t.ex. stabil, förhandsversion osv.) – endast om autoUpgradeMinorVersion är "sant". |
properties.scope |
Omfång där tillägget är installerat. |
||
properties.statuses |
Status från det här tillägget. |
||
properties.version |
string |
Användardefinerad version av tillägget för det här tillägget till "pin". Om du vill använda "version" måste autoUpgradeMinorVersion vara "false". |
|
systemData |
Metadata på toppnivå https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
||
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
ExtensionStatus
Status från tillägget.
Name | Typ | Standardvärde | Description |
---|---|---|---|
code |
string |
Statuskod som tillhandahålls av tillägget |
|
displayStatus |
string |
Kort beskrivning av status för tillägget. |
|
level | Information |
Statusnivå. |
|
message |
string |
Detaljerat meddelande om statusen från tillägget. |
|
time |
string |
DateLiteral (per ISO8601) som noterar tidpunkten för installationens status. |
Identity
Identitet för resursen.
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID för resursidentitet. |
tenantId |
string |
Resursens klientorganisations-ID. |
type |
Identitetstypen. |
LevelType
Statusnivå.
Name | Typ | Description |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
Planera för resursen.
Name | Typ | Description |
---|---|---|
name |
string |
Ett användardefinierat namn på den artefakt från tredje part som införskaffas. |
product |
string |
Artefakten från tredje part som införskaffas. Till exempel NewRelic. Produkten mappar till OfferID som angetts för artefakten vid tidpunkten för datamarknadsregistreringen. |
promotionCode |
string |
En utgivare tillhandahöll kampanjkod som etablerats på datamarknaden för den nämnda produkten/artefakten. |
publisher |
string |
Utgivaren av den tredjepartsartefakt som köps. Till exempel NewRelic |
version |
string |
Versionen av önskad produkt/artefakt. |
ProvisioningState
Status för installationen av det här tillägget.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
Identitetstypen.
Name | Typ | Description |
---|---|---|
SystemAssigned |
string |
Scope
Omfånget för tillägget. Det kan vara antingen kluster eller namnområde. men inte båda.
Name | Typ | Description |
---|---|---|
cluster |
Anger att tilläggets omfång är Kluster |
|
namespace |
Anger att tilläggets omfång är Namnområde |
ScopeCluster
Anger att tilläggets omfång är Kluster
Name | Typ | Description |
---|---|---|
releaseNamespace |
string |
Namnområde där tillägget Release måste placeras för ett klusteromfångstillägg. Om det här namnområdet inte finns skapas det |
ScopeNamespace
Anger att tilläggets omfång är Namnområde
Name | Typ | Description |
---|---|---|
targetNamespace |
string |
Namnområde där tillägget kommer att skapas för ett namnområdesomfångstillägg. Om det här namnområdet inte finns skapas det |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |