Extensions - Create
Erstellen Sie eine neue Kubernetes-Clustererweiterung.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
cluster
|
path | True |
string |
Der Name des Kubernetes-Clusters. |
cluster
|
path | True |
string |
Der Name der Kubernetes-Clusterressource– d. h. managedClusters, connectedClusters, provisionedClusters. |
cluster
|
path | True |
string |
Der Kubernetes-Cluster RP – d. h. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService. |
extension
|
path | True |
string |
Name der Erweiterung. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
identity |
Identität der Erweiterungsressource |
|
plan |
Die Planinformationen. |
|
properties.aksAssignedIdentity |
Identität der Erweiterungsressource in einem AKS-Cluster |
|
properties.autoUpgradeMinorVersion |
boolean |
Kennzeichnen Sie, um zu beachten, ob diese Erweiterung am automatischen Upgrade der Nebenversion teilnimmt oder nicht. |
properties.configurationProtectedSettings |
object |
Konfigurationseinstellungen, die vertraulich sind, als Name-Wert-Paare zum Konfigurieren dieser Erweiterung. |
properties.configurationSettings |
object |
Konfigurationseinstellungen als Name-Wert-Paare zum Konfigurieren dieser Erweiterung. |
properties.extensionType |
string |
Typ der Erweiterung, von der diese Ressource eine instance ist. Es muss sich um einen der Erweiterungstypen handeln, die vom Erweiterungsherausgeber bei Microsoft.KubernetesConfiguration registriert wurden. |
properties.releaseTrain |
string |
ReleaseTrain diese Erweiterung für automatische Upgrades (z. B. Stable, Preview usw.) – nur, wenn autoUpgradeMinorVersion "true" ist. |
properties.scope |
Bereich, in dem die Erweiterung installiert ist. |
|
properties.statuses |
Status dieser Erweiterung. |
|
properties.version |
string |
Vom Benutzer angegebene Version der Erweiterung für diese Erweiterung auf "anheften". Um "version" verwenden zu können, muss autoUpgradeMinorVersion "false" sein. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderung wurde erfolgreich für eine vorhandene Ressource empfangen. |
|
201 Created |
Die Anforderung wurde erfolgreich empfangen. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Create Extension |
Create Extension with Plan |
Create Extension
Beispielanforderung
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"
}
}
}
Beispiel für eine Antwort
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
Beispielanforderung
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"
}
}
Beispiel für eine Antwort
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
}
}
Definitionen
Name | Beschreibung |
---|---|
Aks |
Identität der Erweiterungsressource in einem AKS-Cluster |
AKSIdentity |
Der Identitätstyp. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Extension |
Das Extension-Objekt. |
Extension |
Status der Erweiterung. |
Identity |
Identität für die Ressource. |
Level |
Ebene des status. |
Plan |
Plant für die Ressource. |
Provisioning |
Status der Installation dieser Erweiterung. |
Resource |
Der Identitätstyp. |
Scope |
Bereich der Erweiterung. Dabei kann es sich um einen Cluster oder einen Namespace handeln. aber nicht beides. |
Scope |
Gibt an, dass der Bereich der Erweiterung Cluster ist. |
Scope |
Gibt an, dass der Bereich der Erweiterung Namespace ist. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
AksAssignedIdentity
Identität der Erweiterungsressource in einem AKS-Cluster
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die Prinzipal-ID der Ressourcenidentität. |
tenantId |
string |
Die Mandanten-ID der Ressource. |
type |
Der Identitätstyp. |
AKSIdentityType
Der Identitätstyp.
Name | Typ | Beschreibung |
---|---|---|
SystemAssigned |
string |
|
UserAssigned |
string |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
Extension
Das Extension-Objekt.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
Identität der Erweiterungsressource |
||
name |
string |
Der Name der Ressource |
|
plan |
Die Planinformationen. |
||
properties.aksAssignedIdentity |
Identität der Erweiterungsressource in einem AKS-Cluster |
||
properties.autoUpgradeMinorVersion |
boolean |
True |
Kennzeichnen Sie, um zu beachten, ob diese Erweiterung am automatischen Upgrade der Nebenversion teilnimmt oder nicht. |
properties.configurationProtectedSettings |
object |
Konfigurationseinstellungen, die vertraulich sind, als Name-Wert-Paare zum Konfigurieren dieser Erweiterung. |
|
properties.configurationSettings |
object |
Konfigurationseinstellungen als Name-Wert-Paare zum Konfigurieren dieser Erweiterung. |
|
properties.currentVersion |
string |
Derzeit installierte Version der Erweiterung. |
|
properties.customLocationSettings |
object |
Eigenschaften von benutzerdefinierten Standorteinstellungen. |
|
properties.errorInfo |
Fehlerinformationen vom Agent, z. B. Fehler während der Installation. |
||
properties.extensionType |
string |
Typ der Erweiterung, von der diese Ressource eine instance ist. Es muss sich um einen der Erweiterungstypen handeln, die vom Erweiterungsherausgeber bei Microsoft.KubernetesConfiguration registriert wurden. |
|
properties.isSystemExtension |
boolean |
False |
Kennzeichnung, um zu beachten, ob es sich bei dieser Erweiterung um eine Systemerweiterung handelt |
properties.packageUri |
string |
URI des Helm-Pakets |
|
properties.provisioningState |
Status der Installation dieser Erweiterung. |
||
properties.releaseTrain |
string |
Stable |
ReleaseTrain diese Erweiterung für automatische Upgrades (z. B. Stable, Preview usw.) – nur, wenn autoUpgradeMinorVersion "true" ist. |
properties.scope |
Bereich, in dem die Erweiterung installiert ist. |
||
properties.statuses |
Status dieser Erweiterung. |
||
properties.version |
string |
Vom Benutzer angegebene Version der Erweiterung für diese Erweiterung auf "anheften". Um "version" verwenden zu können, muss autoUpgradeMinorVersion "false" sein. |
|
systemData |
Metadaten der obersten Ebene https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources |
||
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
ExtensionStatus
Status der Erweiterung.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
code |
string |
Von der Erweiterung bereitgestellter Statuscode |
|
displayStatus |
string |
Kurze Beschreibung der status der Erweiterung. |
|
level | Information |
Ebene des status. |
|
message |
string |
Ausführliche Meldung der status aus der Erweiterung. |
|
time |
string |
DateLiteral (pro ISO8601) mit Angabe des Zeitpunkts der Installation status. |
Identity
Identität für die Ressource.
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die Prinzipal-ID der Ressourcenidentität. |
tenantId |
string |
Die Mandanten-ID der Ressource. |
type |
Der Identitätstyp. |
LevelType
Ebene des status.
Name | Typ | Beschreibung |
---|---|---|
Error |
string |
|
Information |
string |
|
Warning |
string |
Plan
Plant für die Ressource.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Ein benutzerdefinierter Name des Drittanbieterartefakts, das beschafft wird. |
product |
string |
Das Artefakt der Dritten Partei, das beschafft wird. Beispiel: NewRelic. Das Produkt wird der OfferID zugeordnet, die zum Zeitpunkt des Data Market-Onboardings für das Artefakt angegeben wurde. |
promotionCode |
string |
Ein Herausgeber hat den Im Datenmarkt bereitgestellten Promotioncode für das entsprechende Produkt/Artefakt bereitgestellt. |
publisher |
string |
Der Herausgeber des Drittanbieterartefakts, das gekauft wird. Beispiel: NewRelic |
version |
string |
Die Version des gewünschten Produkts/Artefakts. |
ProvisioningState
Status der Installation dieser Erweiterung.
Name | Typ | Beschreibung |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
Der Identitätstyp.
Name | Typ | Beschreibung |
---|---|---|
SystemAssigned |
string |
Scope
Bereich der Erweiterung. Dabei kann es sich um einen Cluster oder einen Namespace handeln. aber nicht beides.
Name | Typ | Beschreibung |
---|---|---|
cluster |
Gibt an, dass der Bereich der Erweiterung Cluster ist. |
|
namespace |
Gibt an, dass der Bereich der Erweiterung Namespace ist. |
ScopeCluster
Gibt an, dass der Bereich der Erweiterung Cluster ist.
Name | Typ | Beschreibung |
---|---|---|
releaseNamespace |
string |
Namespace, in dem das Erweiterungsrelease für eine Clusterbereichserweiterung platziert werden muss. Wenn dieser Namespace nicht vorhanden ist, wird er erstellt. |
ScopeNamespace
Gibt an, dass der Bereich der Erweiterung Namespace ist.
Name | Typ | Beschreibung |
---|---|---|
targetNamespace |
string |
Namespace, in dem die Erweiterung für eine Namespacebereichserweiterung erstellt wird. Wenn dieser Namespace nicht vorhanden ist, wird er erstellt. |
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |