Compartilhar via


Cluster Pools - Create Or Update

Cria ou atualiza um pool de clusters.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
clusterPoolName
path True

string

O nome do pool de clusters.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

uuid

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

A localização geográfica em que o recurso reside

properties.computeProfile True

ComputeProfile

Perfil de computação do pool do CLuster.

properties.clusterPoolProfile

ClusterPoolProfile

Perfil do pool do CLuster.

properties.logAnalyticsProfile

LogAnalyticsProfile

Perfil de análise de log do pool de clusters para habilitar o agente do OMS para o cluster do AKS.

properties.managedResourceGroupName

string

Um grupo de recursos criado pelo RP para manter os recursos criados pelo RP em nome dos clientes. Ele também será usado para gerar aksManagedResourceGroupName por padrão: MC_{managedResourceGroupName}{clusterPoolName}{region}. Verifique se ele atende à restrição de nome do grupo de recursos.

properties.networkProfile

NetworkProfile

Perfil de rede do pool de clusters.

tags

object

Marcas de recurso.

Respostas

Nome Tipo Description
200 OK

ClusterPool

Atualização bem-sucedida.

201 Created

ClusterPool

ClusterPool é criado.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ClusterPoolPut
ClusterPoolPutWithPrivateAks
ClusterPoolPutWithUDRAks

ClusterPoolPut

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AksClusterAgentPoolIdentityProfile

Propriedades de identidade do MSI do pool de agentes de cluster do AKS

AksClusterProfile

Propriedades do cluster do AKS subjacente.

ClusterPool

Pool de clusters.

ClusterPoolProfile

Perfil do pool do CLuster.

ComputeProfile

Perfil de computação do pool do CLuster.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

LogAnalyticsProfile

Perfil de análise de log do pool de clusters para habilitar o agente do OMS para o cluster do AKS.

NetworkProfile

Perfil de rede do pool de clusters.

outboundType

O método de roteamento de saída (saída).

ProvisioningStatus

Estado de provisionamento do recurso.

systemData

Metadados relativos à criação e à última modificação do recurso.

AksClusterAgentPoolIdentityProfile

Propriedades de identidade do MSI do pool de agentes de cluster do AKS

Nome Tipo Description
msiClientId

string

ClientId do MSI.

msiObjectId

string

ObjectId do MSI.

msiResourceId

string

ResourceId do MSI.

AksClusterProfile

Propriedades do cluster do AKS subjacente.

Nome Tipo Description
aksClusterAgentPoolIdentityProfile

AksClusterAgentPoolIdentityProfile

Propriedades de identidade do MSI do pool de agentes de cluster do AKS

aksClusterResourceId

string

ID de recurso do ARM do cluster do AKS

aksVersion

string

Plano de controle do AKS e versão padrão do pool de nós deste ClusterPool

ClusterPool

Pool de clusters.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

A localização geográfica em que o recurso reside

name

string

O nome do recurso

properties.aksClusterProfile

AksClusterProfile

Propriedades do cluster do AKS subjacente.

properties.aksManagedResourceGroupName

string

Um grupo de recursos criado pelo AKS para manter os recursos de infraestrutura criados pelo AKS em nome dos clientes. Ele é gerado pelo nome do pool de clusters e pelo nome do grupo de recursos gerenciados por padrão: MC_{managedResourceGroupName}{clusterPoolName}{region}

properties.clusterPoolProfile

ClusterPoolProfile

Perfil do pool do CLuster.

properties.computeProfile

ComputeProfile

Perfil de computação do pool do CLuster.

properties.deploymentId

string

Uma ID exclusiva gerada pelo RP para identificar o recurso.

properties.logAnalyticsProfile

LogAnalyticsProfile

Perfil de análise de log do pool de clusters para habilitar o agente do OMS para o cluster do AKS.

properties.managedResourceGroupName

string

Um grupo de recursos criado pelo RP para manter os recursos criados pelo RP em nome dos clientes. Ele também será usado para gerar aksManagedResourceGroupName por padrão: MC_{managedResourceGroupName}{clusterPoolName}{region}. Verifique se ele atende à restrição de nome do grupo de recursos.

properties.networkProfile

NetworkProfile

Perfil de rede do pool de clusters.

properties.provisioningState

ProvisioningStatus

Estado de provisionamento do recurso.

properties.status

string

Status comercial do recurso.

systemData

systemData

SystemData do pool de clusters.

tags

object

Marcas de recurso.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ClusterPoolProfile

Perfil do pool do CLuster.

Nome Tipo Description
clusterPoolVersion

string

A versão do pool de clusters é uma versão de duas partes.

ComputeProfile

Perfil de computação do pool do CLuster.

Nome Tipo Description
count

integer

O número de máquinas virtuais.

vmSize

string

O SKU da máquina virtual.

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

LogAnalyticsProfile

Perfil de análise de log do pool de clusters para habilitar o agente do OMS para o cluster do AKS.

Nome Tipo Description
enabled

boolean

True se o Log Analytics estiver habilitado para o pool de clusters; caso contrário, false.

workspaceId

string

Workspace do Log Analytics a ser associado ao agente do OMS.

NetworkProfile

Perfil de rede do pool de clusters.

Nome Tipo Valor padrão Description
apiServerAuthorizedIpRanges

string[]

Os intervalos de IP autorizados a acessar o servidor de API do AKS.
Os intervalos de IP são especificados no formato CIDR, por exemplo, 137.117.106.88/29. Esse recurso não é compatível com clusters do AKS privados. Portanto, não é possível definir enablePrivateApiServer como true e apiServerAuthorizedIpRanges ao mesmo tempo. Atualmente, não há suporte para essa propriedade e não a use.

enablePrivateApiServer

boolean

ClusterPool é baseado no cluster do AKS. O cluster do AKS expõe o servidor de API à Internet pública por padrão. Se você definir essa propriedade como true, um cluster do AKS privado será criado e ele usará o apiserver privado, que não é exposto à Internet pública.

outboundType

outboundType

loadBalancer

O método de roteamento de saída (saída).
Isso só pode ser definido no momento da criação do pool de clusters e não pode ser alterado posteriormente.

subnetId

string

ID do recurso de sub-rede do pool de clusters.

outboundType

O método de roteamento de saída (saída).

Nome Tipo Description
loadBalancer

string

O balanceador de carga é usado para saída por meio de um IP público atribuído por AKS. Isso dá suporte aos serviços do Kubernetes do tipo 'loadBalancer'.

userDefinedRouting

string

Os caminhos de saída devem ser definidos pelo usuário. Esse é um cenário avançado e requer a configuração de rede adequada.

ProvisioningStatus

Estado de provisionamento do recurso.

Nome Tipo Description
Accepted

string

Canceled

string

Failed

string

Succeeded

string

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.