Udostępnij za pośrednictwem


Extensions - Create

Utwórz nowe rozszerzenie klastra 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 identyfikatora URI

Nazwa W Wymagane Typ Opis
clusterName
path True

string

Nazwa klastra kubernetes.

clusterResourceName
path True

string

Nazwa zasobu klastra Kubernetes — tj. managedClusters, connectedClusters, provisionedClusters.

clusterRp
path True

string

Dostawca usługi rp klastra Kubernetes — tj. Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

extensionName
path True

string

Nazwa rozszerzenia.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

subscriptionId
path True

string

minLength: 1

Identyfikator subskrypcji docelowej.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Typ Opis
identity

Identity

Tożsamość zasobu Rozszerzenia

plan

Plan

Informacje o planie.

properties.aksAssignedIdentity

AksAssignedIdentity

Tożsamość zasobu Rozszerzenia w klastrze usługi AKS

properties.autoUpgradeMinorVersion

boolean

Flaga do zanotowania, czy to rozszerzenie uczestniczy w automatycznym uaktualnieniu wersji pomocniczej, czy nie.

properties.configurationProtectedSettings

object

Ustawienia konfiguracji, które są poufne, jako pary nazwa-wartość na potrzeby konfigurowania tego rozszerzenia.

properties.configurationSettings

object

Ustawienia konfiguracji jako pary nazwa-wartość do konfigurowania tego rozszerzenia.

properties.extensionType

string

Typ rozszerzenia, którego wystąpieniem jest ten zasób. Musi to być jeden z typów rozszerzeń zarejestrowanych w programie Microsoft.KubernetesConfiguration przez wydawcę rozszerzeń.

properties.releaseTrain

string

ReleaseTrain to rozszerzenie uczestniczy w procesie automatycznego uaktualniania (np. Stabilne, Wersja zapoznawcza itp.) — tylko wtedy, gdy autoUpgradeMinorVersion ma wartość "true".

properties.scope

Scope

Zakres, w którym zainstalowano rozszerzenie.

properties.statuses

ExtensionStatus[]

Stan z tego rozszerzenia.

properties.version

string

Określona przez użytkownika wersja rozszerzenia dla tego rozszerzenia na "pin". Aby użyć polecenia "version", autoUpgradeMinorVersion musi mieć wartość "false".

Odpowiedzi

Nazwa Typ Opis
200 OK

Extension

Żądanie odebrane pomyślnie dla istniejącego zasobu.

201 Created

Extension

Żądanie zostało odebrane pomyślnie.

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create Extension
Create Extension with Plan

Create Extension

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AksAssignedIdentity

Tożsamość zasobu Rozszerzenia w klastrze usługi AKS

AKSIdentityType

Typ tożsamości.

createdByType

Typ tożsamości, która utworzyła zasób.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

Extension

Obiekt Extension.

ExtensionStatus

Stan z rozszerzenia.

Identity

Tożsamość zasobu.

LevelType

Poziom stanu.

Plan

Zaplanuj zasób.

ProvisioningState

Stan instalacji tego rozszerzenia.

ResourceIdentityType

Typ tożsamości.

Scope

Zakres rozszerzenia. Może to być klaster lub przestrzeń nazw; ale nie oba.

ScopeCluster

Określa, że zakres rozszerzenia to Klaster

ScopeNamespace

Określa, że zakres rozszerzenia to przestrzeń nazw

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

AksAssignedIdentity

Tożsamość zasobu Rozszerzenia w klastrze usługi AKS

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId

string

Identyfikator dzierżawy zasobu.

type

AKSIdentityType

Typ tożsamości.

AKSIdentityType

Typ tożsamości.

Wartość Opis
SystemAssigned
UserAssigned

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

Extension

Obiekt Extension.

Nazwa Typ Domyślna wartość Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Tożsamość zasobu Rozszerzenia

name

string

Nazwa zasobu

plan

Plan

Informacje o planie.

properties.aksAssignedIdentity

AksAssignedIdentity

Tożsamość zasobu Rozszerzenia w klastrze usługi AKS

properties.autoUpgradeMinorVersion

boolean

True

Flaga do zanotowania, czy to rozszerzenie uczestniczy w automatycznym uaktualnieniu wersji pomocniczej, czy nie.

properties.configurationProtectedSettings

object

Ustawienia konfiguracji, które są poufne, jako pary nazwa-wartość na potrzeby konfigurowania tego rozszerzenia.

properties.configurationSettings

object

Ustawienia konfiguracji jako pary nazwa-wartość do konfigurowania tego rozszerzenia.

properties.currentVersion

string

Obecnie zainstalowana wersja rozszerzenia.

properties.customLocationSettings

object

Właściwości ustawień lokalizacji niestandardowej.

properties.errorInfo

ErrorDetail

Informacje o błędzie agenta — np. błędy podczas instalacji.

properties.extensionType

string

Typ rozszerzenia, którego wystąpieniem jest ten zasób. Musi to być jeden z typów rozszerzeń zarejestrowanych w programie Microsoft.KubernetesConfiguration przez wydawcę rozszerzeń.

properties.isSystemExtension

boolean

False

Flaga do zanotowania, jeśli to rozszerzenie jest rozszerzeniem systemowym

properties.packageUri

string

Identyfikator URI pakietu Helm

properties.provisioningState

ProvisioningState

Stan instalacji tego rozszerzenia.

properties.releaseTrain

string

Stable

ReleaseTrain to rozszerzenie uczestniczy w procesie automatycznego uaktualniania (np. Stabilne, Wersja zapoznawcza itp.) — tylko wtedy, gdy autoUpgradeMinorVersion ma wartość "true".

properties.scope

Scope

Zakres, w którym zainstalowano rozszerzenie.

properties.statuses

ExtensionStatus[]

Stan z tego rozszerzenia.

properties.version

string

Określona przez użytkownika wersja rozszerzenia dla tego rozszerzenia na "pin". Aby użyć polecenia "version", autoUpgradeMinorVersion musi mieć wartość "false".

systemData

systemData

https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources metadanych najwyższego poziomu

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ExtensionStatus

Stan z rozszerzenia.

Nazwa Typ Domyślna wartość Opis
code

string

Kod stanu dostarczony przez rozszerzenie

displayStatus

string

Krótki opis stanu rozszerzenia.

level

LevelType

Information

Poziom stanu.

message

string

Szczegółowy komunikat o stanie rozszerzenia.

time

string

DateLiteral (na ISO8601) zauważa czas instalacji.

Identity

Tożsamość zasobu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

tenantId

string

Identyfikator dzierżawy zasobu.

type

ResourceIdentityType

Typ tożsamości.

LevelType

Poziom stanu.

Wartość Opis
Error
Information
Warning

Plan

Zaplanuj zasób.

Nazwa Typ Opis
name

string

Zdefiniowana przez użytkownika nazwa artefaktu innej firmy, który jest pozyskiwany.

product

string

Artefakt innej firmy, który jest pozyskiwany. Np. NewRelic. Produkt jest mapowy na wartość OfferID określoną dla artefaktu podczas dołączania do usługi Data Market.

promotionCode

string

Wydawca dostarczył kod podwyższania poziomu jako zaaprowizowany w usłudze Data Market dla podanego produktu/artefaktu.

publisher

string

Wydawca zakupionego artefaktu innej firmy. Np. NewRelic

version

string

Wersja żądanego produktu/artefaktu.

ProvisioningState

Stan instalacji tego rozszerzenia.

Wartość Opis
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Typ tożsamości.

Wartość Opis
SystemAssigned

Scope

Zakres rozszerzenia. Może to być klaster lub przestrzeń nazw; ale nie oba.

Nazwa Typ Opis
cluster

ScopeCluster

Określa, że zakres rozszerzenia to Klaster

namespace

ScopeNamespace

Określa, że zakres rozszerzenia to przestrzeń nazw

ScopeCluster

Określa, że zakres rozszerzenia to Klaster

Nazwa Typ Opis
releaseNamespace

string

Przestrzeń nazw, w której należy umieścić rozszerzenie Wydanie, dla rozszerzenia o zakresie klastra. Jeśli ta przestrzeń nazw nie istnieje, zostanie utworzona

ScopeNamespace

Określa, że zakres rozszerzenia to przestrzeń nazw

Nazwa Typ Opis
targetNamespace

string

Przestrzeń nazw, w której zostanie utworzone rozszerzenie dla rozszerzenia o zakresie przestrzeni nazw. Jeśli ta przestrzeń nazw nie istnieje, zostanie utworzona

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.