Method: projects.locations.azureClusters.azureNodePools.list

Stay organized with collections Save and categorize content based on your preferences.

Lists all AzureNodePool resources on a given AzureCluster.

HTTP request

GET https://{endpoint}/v1/{parent=projects/*/locations/*/azureClusters/*}/azureNodePools

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent AzureCluster which owns this collection of AzureNodePool resources.

AzureCluster names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>.

See Resource Names for more details on Google Cloud resource names.

Query parameters

Parameters
pageSize

integer

The maximum number of items to return.

If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.

pageToken

string

The nextPageToken value returned from a previous azureNodePools.list request, if any.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for AzureClusters.ListAzureNodePools method.

JSON representation
{
  "azureNodePools": [
    {
      object (AzureNodePool)
    }
  ],
  "nextPageToken": string
}
Fields
azureNodePools[]

object (AzureNodePool)

A list of AzureNodePool resources in the specified AzureCluster.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • gkemulticloud.azureNodePools.list

For more information, see the IAM documentation.