Freigeben über


Cluster Pools - Create Or Update

Erstellt oder aktualisiert einen Clusterpool.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}?api-version=2023-11-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
clusterPoolName
path True

string

Der Name des Clusterpools.

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Der geografische Standort, an dem sich die Ressource befindet

properties.computeProfile True

ComputeProfile

Computeprofil des CLuster-Pools.

properties.clusterPoolProfile

ClusterPoolProfile

CLuster-Poolprofil.

properties.logAnalyticsProfile

LogAnalyticsProfile

Log Analytics-Profil des Clusterpools zum Aktivieren des OMS-Agents für den AKS-Cluster.

properties.managedResourceGroupName

string

Eine Ressourcengruppe, die von RP erstellt wurde, um die ressourcen aufzunehmen, die von RP im Auftrag von Kunden erstellt wurden. Es wird auch verwendet, um aksManagedResourceGroupName nach Muster zu generieren: MC_{managedResourceGroupName}{clusterPoolName}{region}. Stellen Sie sicher, dass die Einschränkung des Ressourcengruppennamens erfüllt ist.

properties.networkProfile

NetworkProfile

Netzwerkprofil des Clusterpools.

tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

ClusterPool

Aktualisierung erfolgreich.

201 Created

ClusterPool

ClusterPool wird erstellt.

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

ClusterPoolPut
ClusterPoolPutWithPrivateAks
ClusterPoolPutWithUDRAks

ClusterPoolPut

Beispielanforderung

PUT https://management.azure.com/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1?api-version=2023-11-01-preview

{
  "location": "West US 2",
  "properties": {
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2"
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}
{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Accepted",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}

ClusterPoolPutWithPrivateAks

Beispielanforderung

PUT https://management.azure.com/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1?api-version=2023-11-01-preview

{
  "location": "West US 2",
  "properties": {
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "enablePrivateApiServer": true
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "enablePrivateApiServer": true
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}
{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Accepted",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "enablePrivateApiServer": true
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}

ClusterPoolPutWithUDRAks

Beispielanforderung

PUT https://management.azure.com/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1?api-version=2023-11-01-preview

{
  "location": "West US 2",
  "properties": {
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "outboundType": "userDefinedRouting"
    }
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "outboundType": "userDefinedRouting"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}
{
  "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1",
  "name": "clusterpool1",
  "type": "Microsoft.HDInsight/clusterPools",
  "properties": {
    "provisioningState": "Accepted",
    "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36",
    "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36",
    "clusterPoolProfile": {
      "clusterPoolVersion": "1.2"
    },
    "computeProfile": {
      "vmSize": "Standard_D3_v2",
      "count": 3
    },
    "aksClusterProfile": {
      "aksVersion": "1.24",
      "aksClusterAgentPoolIdentityProfile": {
        "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool",
        "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb",
        "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9"
      },
      "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1"
    },
    "networkProfile": {
      "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
      "outboundType": "userDefinedRouting"
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "location": "West US 2"
}

Definitionen

Name Beschreibung
AksClusterAgentPoolIdentityProfile

Identitätseigenschaften des AKS-Cluster-Agentpools MSI

AksClusterProfile

Eigenschaften des zugrunde liegenden AKS-Clusters.

ClusterPool

Clusterpool.

ClusterPoolProfile

CLuster-Poolprofil.

ComputeProfile

Computeprofil des CLuster-Pools.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

LogAnalyticsProfile

Log Analytics-Profil des Clusterpools zum Aktivieren des OMS-Agents für den AKS-Cluster.

NetworkProfile

Netzwerkprofil des Clusterpools.

outboundType

Die ausgehende (ausgehende) Routingmethode.

ProvisioningStatus

Bereitstellungsstatus der Ressource.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

AksClusterAgentPoolIdentityProfile

Identitätseigenschaften des AKS-Cluster-Agentpools MSI

Name Typ Beschreibung
msiClientId

string

ClientId der MSI.

msiObjectId

string

ObjectId der MSI.

msiResourceId

string

ResourceId der MSI.

AksClusterProfile

Eigenschaften des zugrunde liegenden AKS-Clusters.

Name Typ Beschreibung
aksClusterAgentPoolIdentityProfile

AksClusterAgentPoolIdentityProfile

Identitätseigenschaften des AKS-Cluster-Agentpools MSI

aksClusterResourceId

string

ARM-Ressourcen-ID des AKS-Clusters

aksVersion

string

AKS-Steuerungsebene und Standardknotenpoolversion dieses ClusterPools

ClusterPool

Clusterpool.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Der geografische Standort, an dem sich die Ressource befindet

name

string

Der Name der Ressource

properties.aksClusterProfile

AksClusterProfile

Eigenschaften des zugrunde liegenden AKS-Clusters.

properties.aksManagedResourceGroupName

string

Eine Ressourcengruppe, die von AKS erstellt wurde, um die von AKS im Auftrag von Kunden erstellten Infrastrukturressourcen zu enthalten. Es wird durch den Clusterpoolnamen und den Namen der verwalteten Ressourcengruppe nach Muster generiert: MC_{managedResourceGroupName}{clusterPoolName}{region}

properties.clusterPoolProfile

ClusterPoolProfile

CLuster-Poolprofil.

properties.computeProfile

ComputeProfile

Computeprofil des CLuster-Pools.

properties.deploymentId

string

Eine eindeutige ID, die vom RP generiert wird, um die Ressource zu identifizieren.

properties.logAnalyticsProfile

LogAnalyticsProfile

Log Analytics-Profil des Clusterpools zum Aktivieren des OMS-Agents für den AKS-Cluster.

properties.managedResourceGroupName

string

Eine Ressourcengruppe, die von RP erstellt wurde, um die ressourcen aufzunehmen, die von RP im Auftrag von Kunden erstellt wurden. Es wird auch verwendet, um aksManagedResourceGroupName nach Muster zu generieren: MC_{managedResourceGroupName}{clusterPoolName}{region}. Stellen Sie sicher, dass die Einschränkung des Ressourcengruppennamens erfüllt ist.

properties.networkProfile

NetworkProfile

Netzwerkprofil des Clusterpools.

properties.provisioningState

ProvisioningStatus

Bereitstellungsstatus der Ressource.

properties.status

string

Geschäftsstatus der Ressource.

systemData

systemData

SystemDaten des Clusterpools.

tags

object

Ressourcentags.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ClusterPoolProfile

CLuster-Poolprofil.

Name Typ Beschreibung
clusterPoolVersion

string

Die Clusterpoolversion ist eine 2-teilige Version.

ComputeProfile

Computeprofil des CLuster-Pools.

Name Typ Beschreibung
count

integer

Die Anzahl der virtuellen Computer.

vmSize

string

Die SKU des virtuellen Computers.

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

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

LogAnalyticsProfile

Log Analytics-Profil des Clusterpools zum Aktivieren des OMS-Agents für den AKS-Cluster.

Name Typ Beschreibung
enabled

boolean

True, wenn die Protokollanalyse für den Clusterpool aktiviert ist, andernfalls false.

workspaceId

string

Log Analytics-Arbeitsbereich, der dem OMS-Agent zugeordnet werden soll.

NetworkProfile

Netzwerkprofil des Clusterpools.

Name Typ Standardwert Beschreibung
apiServerAuthorizedIpRanges

string[]

Die IP-Bereiche, die für den Zugriff auf den AKS-API-Server autorisiert sind.
IP-Bereiche werden im CIDR-Format angegeben, z. B. 137.117.106.88/29. Dieses Feature ist nicht mit privaten AKS-Clustern kompatibel. Daher können Sie enablePrivateApiServer nicht gleichzeitig auf true und apiServerAuthorizedIpRanges festlegen. Derzeit wird diese Eigenschaft nicht unterstützt, und verwenden Sie sie bitte nicht.

enablePrivateApiServer

boolean

ClusterPool basiert auf AKS-Clustern. Der AKS-Cluster macht den API-Server standardmäßig für das öffentliche Internet verfügbar. Wenn Sie diese Eigenschaft auf true festlegen, wird ein privater AKS-Cluster erstellt, und er verwendet den privaten API-Server, der nicht für das öffentliche Internet verfügbar gemacht wird.

outboundType

outboundType

loadBalancer

Die ausgehende (ausgehende) Routingmethode.
Dies kann nur zur Erstellungszeit des Clusterpools festgelegt werden und kann später nicht geändert werden.

subnetId

string

Subnetzressourcen-ID des Clusterpools.

outboundType

Die ausgehende (ausgehende) Routingmethode.

Name Typ Beschreibung
loadBalancer

string

Ein Lastenausgleich wird für ausgehenden Datenverkehr über eine von AKS zugewiesene öffentliche IP-Adresse verwendet. Dies unterstützt Kubernetes-Dienste vom Typ "loadBalancer".

userDefinedRouting

string

Ausgehende Pfade müssen vom Benutzer definiert werden. Dies ist ein erweitertes Szenario und erfordert eine ordnungsgemäße Netzwerkkonfiguration.

ProvisioningStatus

Bereitstellungsstatus der Ressource.

Name Typ Beschreibung
Accepted

string

Canceled

string

Failed

string

Succeeded

string

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

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

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.