Bagikan melalui


Cluster Pools - Create Or Update

Membuat atau memperbarui kumpulan kluster.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
clusterPoolName
path True

string

Nama kumpulan kluster.

resourceGroupName
path True

string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

subscriptionId
path True

string

uuid

ID langganan target. Nilai harus UUID.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
location True

string

Lokasi geografis tempat sumber daya berada

properties.computeProfile True

ComputeProfile

Profil komputasi kumpulan CLuster.

properties.clusterPoolProfile

ClusterPoolProfile

Profil kumpulan CLuster.

properties.logAnalyticsProfile

LogAnalyticsProfile

Profil analitik log kumpulan kluster untuk mengaktifkan agen OMS untuk kluster AKS.

properties.managedResourceGroupName

string

Grup sumber daya yang dibuat oleh RP, untuk menyimpan sumber daya yang dibuat oleh RP atas nama pelanggan. Ini juga akan digunakan untuk menghasilkan aksManagedResourceGroupName berdasarkan pola: MC_{managedResourceGroupName}{clusterPoolName}{region}. Pastikan memenuhi batasan nama grup sumber daya.

properties.networkProfile

NetworkProfile

Profil jaringan kumpulan kluster.

tags

object

Tag sumber daya.

Respons

Nama Jenis Deskripsi
200 OK

ClusterPool

Pembaruan berhasil.

201 Created

ClusterPool

ClusterPool dibuat.

Other Status Codes

ErrorResponse

Respons Kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ClusterPoolPut
ClusterPoolPutWithPrivateAks
ClusterPoolPutWithUDRAks

ClusterPoolPut

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
AksClusterAgentPoolIdentityProfile

Properti identitas MSI agentpool kluster AKS

AksClusterProfile

Properti kluster AKS yang mendasar.

ClusterPool

Kumpulan kluster.

ClusterPoolProfile

Profil kumpulan CLuster.

ComputeProfile

Profil komputasi kumpulan CLuster.

createdByType

Jenis identitas yang membuat sumber daya.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan

LogAnalyticsProfile

Profil analitik log kumpulan kluster untuk mengaktifkan agen OMS untuk kluster AKS.

NetworkProfile

Profil jaringan kumpulan kluster.

outboundType

Metode perutean keluar (keluar).

ProvisioningStatus

Status penyediaan sumber daya.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AksClusterAgentPoolIdentityProfile

Properti identitas MSI agentpool kluster AKS

Nama Jenis Deskripsi
msiClientId

string

ClientId dari MSI.

msiObjectId

string

ObjectId dari MSI.

msiResourceId

string

ResourceId dari MSI.

AksClusterProfile

Properti kluster AKS yang mendasar.

Nama Jenis Deskripsi
aksClusterAgentPoolIdentityProfile

AksClusterAgentPoolIdentityProfile

Properti identitas MSI agentpool kluster AKS

aksClusterResourceId

string

ID Sumber Daya ARM dari kluster AKS

aksVersion

string

Sarana kontrol AKS dan versi kumpulan simpul default dari ClusterPool ini

ClusterPool

Kumpulan kluster.

Nama Jenis Deskripsi
id

string

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

Lokasi geografis tempat sumber daya berada

name

string

Nama sumber daya.

properties.aksClusterProfile

AksClusterProfile

Properti kluster AKS yang mendasar.

properties.aksManagedResourceGroupName

string

Grup sumber daya yang dibuat oleh AKS, untuk menyimpan sumber daya infrastruktur yang dibuat oleh AKS atas nama pelanggan. Ini dihasilkan oleh nama kumpulan kluster dan nama grup sumber daya terkelola berdasarkan pola: MC_{managedResourceGroupName}{clusterPoolName}{region}

properties.clusterPoolProfile

ClusterPoolProfile

Profil kumpulan CLuster.

properties.computeProfile

ComputeProfile

Profil komputasi kumpulan CLuster.

properties.deploymentId

string

Id unik yang dihasilkan oleh RP untuk mengidentifikasi sumber daya.

properties.logAnalyticsProfile

LogAnalyticsProfile

Profil analitik log kumpulan kluster untuk mengaktifkan agen OMS untuk kluster AKS.

properties.managedResourceGroupName

string

Grup sumber daya yang dibuat oleh RP, untuk menyimpan sumber daya yang dibuat oleh RP atas nama pelanggan. Ini juga akan digunakan untuk menghasilkan aksManagedResourceGroupName berdasarkan pola: MC_{managedResourceGroupName}{clusterPoolName}{region}. Pastikan memenuhi batasan nama grup sumber daya.

properties.networkProfile

NetworkProfile

Profil jaringan kumpulan kluster.

properties.provisioningState

ProvisioningStatus

Status penyediaan sumber daya.

properties.status

string

Status bisnis sumber daya.

systemData

systemData

SystemData kumpulan kluster.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ClusterPoolProfile

Profil kumpulan CLuster.

Nama Jenis Deskripsi
clusterPoolVersion

string

Versi kumpulan kluster adalah versi 2 bagian.

ComputeProfile

Profil komputasi kumpulan CLuster.

Nama Jenis Deskripsi
count

integer

Jumlah komputer virtual.

vmSize

string

SKU komputer virtual.

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

LogAnalyticsProfile

Profil analitik log kumpulan kluster untuk mengaktifkan agen OMS untuk kluster AKS.

Nama Jenis Deskripsi
enabled

boolean

Benar jika analitik log diaktifkan untuk kumpulan kluster, jika tidak salah.

workspaceId

string

Ruang kerja analitik log untuk dikaitkan dengan agen OMS.

NetworkProfile

Profil jaringan kumpulan kluster.

Nama Jenis Nilai default Deskripsi
apiServerAuthorizedIpRanges

string[]

Rentang IP diotorisasi untuk mengakses server API AKS.
Rentang IP ditentukan dalam format CIDR, misalnya 137.117.106.88/29. Fitur ini tidak kompatibel dengan kluster AKS privat. Jadi Anda tidak dapat mengatur enablePrivateApiServer ke true dan apiServerAuthorizedIpRanges secara bersamaan. Saat ini, properti ini tidak didukung dan jangan gunakan.

enablePrivateApiServer

boolean

ClusterPool didasarkan pada kluster AKS. Kluster AKS mengekspos server API ke internet publik secara default. Jika Anda mengatur properti ini ke true, kluster AKS privat akan dibuat, dan akan menggunakan apiserver privat, yang tidak terekspos ke internet publik.

outboundType

outboundType

loadBalancer

Metode perutean keluar (keluar).
Ini hanya dapat diatur pada waktu pembuatan kumpulan kluster dan tidak dapat diubah nanti.

subnetId

string

Id sumber daya subnet kumpulan kluster.

outboundType

Metode perutean keluar (keluar).

Nama Jenis Deskripsi
loadBalancer

string

Load balancer digunakan untuk keluar melalui IP publik yang ditetapkan AKS. Ini mendukung layanan Kubernetes jenis 'loadBalancer'.

userDefinedRouting

string

Jalur keluar harus ditentukan oleh pengguna. Ini adalah skenario lanjutan dan memerlukan konfigurasi jaringan yang tepat.

ProvisioningStatus

Status penyediaan sumber daya.

Nama Jenis Deskripsi
Accepted

string

Canceled

string

Failed

string

Succeeded

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.