Delen via


Extensions - Create

Maak een nieuwe Kubernetes-clusterextensie.

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

URI-parameters

Name In Vereist Type Description
clusterName
path True

string

De naam van het kubernetes-cluster.

clusterResourceName
path True

string

De resourcenaam van het Kubernetes-cluster: managedClusters, connectedClusters, provisionedClusters.

clusterRp
path True

string

De Kubernetes-cluster-RP, dat wil zeggen Microsoft.ContainerService, Microsoft.Kubernetes, Microsoft.HybridContainerService.

extensionName
path True

string

Naam van de extensie.

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
identity

Identity

Identiteit van de extensieresource

plan

Plan

De plangegevens.

properties.aksAssignedIdentity

AksAssignedIdentity

Identiteit van de extensieresource in een AKS-cluster

properties.autoUpgradeMinorVersion

boolean

Vlag om op te merken of deze extensie deelneemt aan automatische upgrade van secundaire versie, of niet.

properties.configurationProtectedSettings

object

Configuratie-instellingen die gevoelig zijn, als naam-waardeparen voor het configureren van deze extensie.

properties.configurationSettings

object

Configuratie-instellingen als naam-waardeparen voor het configureren van deze extensie.

properties.extensionType

string

Type van de Extensie waarvan deze resource een exemplaar is. Dit moet een van de extensietypen zijn die zijn geregistreerd bij Microsoft.KubernetesConfiguration door de extensie-uitgever.

properties.releaseTrain

string

ReleaseTrain deze extensie neemt deel aan voor automatische upgrade (bijvoorbeeld Stabiel, Preview, enzovoort) - alleen als autoUpgradeMinorVersion 'true' is.

properties.scope

Scope

Bereik waarop de extensie is geïnstalleerd.

properties.statuses

ExtensionStatus[]

Status van deze extensie.

properties.version

string

Door de gebruiker opgegeven versie van de extensie om deze extensie vast te maken. Als u versie wilt gebruiken, moet autoUpgradeMinorVersion onwaar zijn.

Antwoorden

Name Type Description
200 OK

Extension

De aanvraag is ontvangen voor een bestaande resource.

201 Created

Extension

De aanvraag is ontvangen.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Create Extension
Create Extension with Plan

Create Extension

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
AksAssignedIdentity

Identiteit van de extensieresource in een AKS-cluster

AKSIdentityType

Het identiteitstype.

createdByType

Het type identiteit waarmee de resource is gemaakt.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

Extension

Het extensieobject.

ExtensionStatus

Status van de extensie.

Identity

Identiteit voor de resource.

LevelType

Niveau van de status.

Plan

Plan voor de resource.

ProvisioningState

Status van de installatie van deze extensie.

ResourceIdentityType

Het identiteitstype.

Scope

Bereik van de extensie. Dit kan cluster of naamruimte zijn; maar niet beide.

ScopeCluster

Hiermee geeft u op dat het bereik van de extensie Cluster is

ScopeNamespace

Hiermee geeft u op dat het bereik van de extensie naamruimte is

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

AksAssignedIdentity

Identiteit van de extensieresource in een AKS-cluster

Name Type Description
principalId

string

De principal-id van resource-id.

tenantId

string

De tenant-id van de resource.

type

AKSIdentityType

Het identiteitstype.

AKSIdentityType

Het identiteitstype.

Name Type Description
SystemAssigned

string

UserAssigned

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

Extension

Het extensieobject.

Name Type Default value Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identiteit van de extensieresource

name

string

De naam van de resource

plan

Plan

De plangegevens.

properties.aksAssignedIdentity

AksAssignedIdentity

Identiteit van de extensieresource in een AKS-cluster

properties.autoUpgradeMinorVersion

boolean

True

Vlag om op te merken of deze extensie deelneemt aan automatische upgrade van secundaire versie, of niet.

properties.configurationProtectedSettings

object

Configuratie-instellingen die gevoelig zijn, als naam-waardeparen voor het configureren van deze extensie.

properties.configurationSettings

object

Configuratie-instellingen als naam-waardeparen voor het configureren van deze extensie.

properties.currentVersion

string

Momenteel geïnstalleerde versie van de extensie.

properties.customLocationSettings

object

Eigenschappen van aangepaste locatie-instellingen.

properties.errorInfo

ErrorDetail

Foutinformatie van de agent, bijvoorbeeld fouten tijdens de installatie.

properties.extensionType

string

Type van de Extensie waarvan deze resource een exemplaar is. Dit moet een van de extensietypen zijn die zijn geregistreerd bij Microsoft.KubernetesConfiguration door de extensie-uitgever.

properties.isSystemExtension

boolean

False

Vlag om op te merken als deze extensie een systeemextensie is

properties.packageUri

string

URI van het Helm-pakket

properties.provisioningState

ProvisioningState

Status van de installatie van deze extensie.

properties.releaseTrain

string

Stable

ReleaseTrain deze extensie neemt deel aan voor automatische upgrade (bijvoorbeeld Stabiel, Preview, enzovoort) - alleen als autoUpgradeMinorVersion 'true' is.

properties.scope

Scope

Bereik waarop de extensie is geïnstalleerd.

properties.statuses

ExtensionStatus[]

Status van deze extensie.

properties.version

string

Door de gebruiker opgegeven versie van de extensie om deze extensie vast te maken. Als u versie wilt gebruiken, moet autoUpgradeMinorVersion onwaar zijn.

systemData

systemData

Metagegevens op het hoogste niveau https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ExtensionStatus

Status van de extensie.

Name Type Default value Description
code

string

Statuscode die wordt geleverd door de extensie

displayStatus

string

Korte beschrijving van de status van de extensie.

level

LevelType

Information

Niveau van de status.

message

string

Gedetailleerd bericht van de status van de extensie.

time

string

DateLiteral (per ISO8601) met de tijd van de installatiestatus.

Identity

Identiteit voor de resource.

Name Type Description
principalId

string

De principal-id van resource-id.

tenantId

string

De tenant-id van de resource.

type

ResourceIdentityType

Het identiteitstype.

LevelType

Niveau van de status.

Name Type Description
Error

string

Information

string

Warning

string

Plan

Plan voor de resource.

Name Type Description
name

string

Een door de gebruiker gedefinieerde naam van het artefact van derden dat wordt aangeschaft.

product

string

Het artefact van derden dat wordt aangeschaft. Bijvoorbeeld NewRelic. Product wordt toegewezen aan de OfferID die is opgegeven voor het artefact op het moment van onboarding van de gegevensmarkt.

promotionCode

string

Een uitgever heeft promotiecode opgegeven zoals ingericht in Gegevensmarkt voor het genoemde product/artefact.

publisher

string

De uitgever van het artefact van derden dat wordt gekocht. Bijvoorbeeld NewRelic

version

string

De versie van het gewenste product/artefact.

ProvisioningState

Status van de installatie van deze extensie.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ResourceIdentityType

Het identiteitstype.

Name Type Description
SystemAssigned

string

Scope

Bereik van de extensie. Dit kan cluster of naamruimte zijn; maar niet beide.

Name Type Description
cluster

ScopeCluster

Hiermee geeft u op dat het bereik van de extensie Cluster is

namespace

ScopeNamespace

Hiermee geeft u op dat het bereik van de extensie naamruimte is

ScopeCluster

Hiermee geeft u op dat het bereik van de extensie Cluster is

Name Type Description
releaseNamespace

string

Naamruimte waar de extensierelease moet worden geplaatst voor een extensie met clusterbereik. Als deze naamruimte niet bestaat, wordt deze gemaakt

ScopeNamespace

Hiermee geeft u op dat het bereik van de extensie naamruimte is

Name Type Description
targetNamespace

string

Naamruimte waar de extensie wordt gemaakt voor een extensie met een naamruimtebereik. Als deze naamruimte niet bestaat, wordt deze gemaakt

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

De tijdstempel van het maken van resources (UTC).

createdBy

string

De identiteit die de resource heeft gemaakt.

createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.

lastModifiedAt

string

Het tijdstempel van de laatste wijziging van de resource (UTC)

lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.

lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.