Condividi tramite


Extensions - Create

Creare una nuova estensione del cluster Kubernetes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{clusterRp}/{clusterResourceName}/{clusterName}/providers/Microsoft.KubernetesConfiguration/extensions/{extensionName}?api-version=2023-05-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
clusterName
path True

string

Nome del cluster kubernetes.

clusterResourceName
path True

string

Nome della risorsa del cluster Kubernetes, ovvero managedClusters, connectedClusters, provisionedClusters.

clusterRp
path True

string

Rp del cluster Kubernetes, ad esempio Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

extensionName
path True

string

Nome dell'estensione.

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
identity

Identity

Identità della risorsa Estensione

plan

Plan

Informazioni sul piano.

properties.aksAssignedIdentity

AksAssignedIdentity

Identità della risorsa Estensione in un cluster del servizio Azure Kubernetes

properties.autoUpgradeMinorVersion

boolean

Contrassegnare per notare se questa estensione partecipa all'aggiornamento automatico della versione secondaria o meno.

properties.configurationProtectedSettings

object

Impostazioni di configurazione sensibili, come coppie nome-valore per la configurazione di questa estensione.

properties.configurationSettings

object

Impostazioni di configurazione, come coppie nome-valore per la configurazione di questa estensione.

properties.extensionType

string

Tipo dell'estensione, di cui questa risorsa è un'istanza di . Deve essere uno dei tipi di estensione registrati con Microsoft.KubernetesConfiguration dal server di pubblicazione dell'estensione.

properties.releaseTrain

string

ReleaseTrain questa estensione partecipa all'aggiornamento automatico (ad esempio Stabile, Anteprima e così via) - solo se autoUpgradeMinorVersion è 'true'.

properties.scope

Scope

Ambito in cui è installata l'estensione.

properties.statuses

ExtensionStatus[]

Stato da questa estensione.

properties.version

string

Versione specificata dall'utente dell'estensione per questa estensione su 'pin'. Per usare 'version', autoUpgradeMinorVersion deve essere 'false'.

Risposte

Nome Tipo Descrizione
200 OK

Extension

Richiesta ricevuta correttamente per una risorsa esistente.

201 Created

Extension

Richiesta ricevuta correttamente.

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Create Extension
Create Extension with Plan

Create Extension

Esempio di richiesta

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"
    }
  }
}

Risposta di esempio

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

Esempio di richiesta

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"
  }
}

Risposta di esempio

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
  }
}

Definizioni

Nome Descrizione
AksAssignedIdentity

Identità della risorsa Estensione in un cluster del servizio Azure Kubernetes

AKSIdentityType

Tipo di identità.

createdByType

Tipo di identità che ha creato la risorsa.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

Extension

Oggetto Extension.

ExtensionStatus

Stato dall'estensione.

Identity

Identità per la risorsa.

LevelType

Livello dello stato.

Plan

Piano per la risorsa.

ProvisioningState

Stato dell'installazione di questa estensione.

ResourceIdentityType

Tipo di identità.

Scope

Ambito dell'estensione. Può essere cluster o spazio dei nomi; ma non entrambi.

ScopeCluster

Specifica che l'ambito dell'estensione è Cluster

ScopeNamespace

Specifica che l'ambito dell'estensione è Spazio dei nomi

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

AksAssignedIdentity

Identità della risorsa Estensione in un cluster del servizio Azure Kubernetes

Nome Tipo Descrizione
principalId

string

ID principale dell'identità della risorsa.

tenantId

string

ID tenant della risorsa.

type

AKSIdentityType

Tipo di identità.

AKSIdentityType

Tipo di identità.

Nome Tipo Descrizione
SystemAssigned

string

UserAssigned

string

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

Extension

Oggetto Extension.

Nome Tipo Valore predefinito Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identità della risorsa Estensione

name

string

nome della risorsa.

plan

Plan

Informazioni sul piano.

properties.aksAssignedIdentity

AksAssignedIdentity

Identità della risorsa Estensione in un cluster del servizio Azure Kubernetes

properties.autoUpgradeMinorVersion

boolean

True

Contrassegnare per notare se questa estensione partecipa all'aggiornamento automatico della versione secondaria o meno.

properties.configurationProtectedSettings

object

Impostazioni di configurazione sensibili, come coppie nome-valore per la configurazione di questa estensione.

properties.configurationSettings

object

Impostazioni di configurazione, come coppie nome-valore per la configurazione di questa estensione.

properties.currentVersion

string

Versione attualmente installata dell'estensione.

properties.customLocationSettings

object

Proprietà delle impostazioni percorso personalizzate.

properties.errorInfo

ErrorDetail

Informazioni sugli errori dell'agente, ad esempio errori durante l'installazione.

properties.extensionType

string

Tipo dell'estensione, di cui questa risorsa è un'istanza di . Deve essere uno dei tipi di estensione registrati con Microsoft.KubernetesConfiguration dal server di pubblicazione dell'estensione.

properties.isSystemExtension

boolean

False

Contrassegno da notare se questa estensione è un'estensione di sistema

properties.packageUri

string

Uri del pacchetto Helm

properties.provisioningState

ProvisioningState

Stato dell'installazione di questa estensione.

properties.releaseTrain

string

Stable

ReleaseTrain questa estensione partecipa all'aggiornamento automatico (ad esempio Stabile, Anteprima e così via) - solo se autoUpgradeMinorVersion è 'true'.

properties.scope

Scope

Ambito in cui è installata l'estensione.

properties.statuses

ExtensionStatus[]

Stato da questa estensione.

properties.version

string

Versione specificata dall'utente dell'estensione per questa estensione su 'pin'. Per usare 'version', autoUpgradeMinorVersion deve essere 'false'.

systemData

systemData

Metadati di primo livello 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 di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ExtensionStatus

Stato dall'estensione.

Nome Tipo Valore predefinito Descrizione
code

string

Codice di stato fornito dall'estensione

displayStatus

string

Breve descrizione dello stato dell'estensione.

level

LevelType

Information

Livello dello stato.

message

string

Messaggio dettagliato dello stato dell'estensione.

time

string

DateLiteral (per ISO8601) che nota l'ora di stato di installazione.

Identity

Identità per la risorsa.

Nome Tipo Descrizione
principalId

string

ID principale dell'identità della risorsa.

tenantId

string

ID tenant della risorsa.

type

ResourceIdentityType

Tipo di identità.

LevelType

Livello dello stato.

Nome Tipo Descrizione
Error

string

Information

string

Warning

string

Plan

Piano per la risorsa.

Nome Tipo Descrizione
name

string

Nome definito dall'utente dell'artefatto di terze parti che viene acquistato.

product

string

L'artefatto 3rd Party che viene acquistato. Ad esempio NewRelic. Il mapping dei prodotti all'oggetto OfferID specificato per l'artefatto al momento dell'onboarding di Data Market.

promotionCode

string

Un editore ha fornito codice promozionale come eseguito il provisioning in Data Market per il prodotto/artefatto specificato.

publisher

string

Autore dell'artefatto di terze parti acquistato. Ad esempio NewRelic

version

string

Versione del prodotto/artefatto desiderato.

ProvisioningState

Stato dell'installazione di questa estensione.

Nome Tipo Descrizione
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

Tipo di identità.

Nome Tipo Descrizione
SystemAssigned

string

Scope

Ambito dell'estensione. Può essere cluster o spazio dei nomi; ma non entrambi.

Nome Tipo Descrizione
cluster

ScopeCluster

Specifica che l'ambito dell'estensione è Cluster

namespace

ScopeNamespace

Specifica che l'ambito dell'estensione è Spazio dei nomi

ScopeCluster

Specifica che l'ambito dell'estensione è Cluster

Nome Tipo Descrizione
releaseNamespace

string

Spazio dei nomi in cui deve essere posizionato il rilascio dell'estensione per un'estensione con ambito cluster. Se questo spazio dei nomi non esiste, verrà creato

ScopeNamespace

Specifica che l'ambito dell'estensione è Spazio dei nomi

Nome Tipo Descrizione
targetNamespace

string

Spazio dei nomi in cui verrà creata l'estensione per un'estensione con ambito spazio dei nomi. Se questo spazio dei nomi non esiste, verrà creato

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.