Clusters - List Zones

Service:

AVS

API Version:

2023-09-01

List hosts by zone in a cluster

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/listZones?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	Name of the cluster Regex pattern: ^[-\w\._]+$
privateCloudName	path	True	string	Name of the private cloud Regex pattern: ^[-\w\._]+$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ClusterZoneList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Clusters_ListZones

Clusters_ListZones_Stretched

Clusters_ListZones

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/listZones?api-version=2023-09-01

Sample Response

Status code:

200

{
  "zones": [
    {
      "hosts": [
        "fakehost22.nyc1.kubernetes.center",
        "fakehost23.nyc1.kubernetes.center",
        "fakehost24.nyc1.kubernetes.center"
      ],
      "zone": "2"
    }
  ]
}

Clusters_ListZones_Stretched

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/listZones?api-version=2023-09-01

Sample Response

Status code:

200

{
  "zones": [
    {
      "hosts": [
        "fakehost22.nyc1.kubernetes.center",
        "fakehost23.nyc1.kubernetes.center",
        "fakehost24.nyc1.kubernetes.center"
      ],
      "zone": "2"
    },
    {
      "hosts": [
        "fakehost74.nyc2.kubernetes.center",
        "fakehost75.nyc2.kubernetes.center",
        "fakehost76.nyc2.kubernetes.center"
      ],
      "zone": "1"
    }
  ]
}

Definitions

Name	Description
ClusterZone	Zone and associated hosts info
ClusterZoneList	List of all zones and associated hosts for a cluster
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ClusterZone

Zone and associated hosts info

Name	Type	Description
hosts	string[]	List of hosts belonging to the availability zone in a cluster
zone	string	Availability zone identifier

ClusterZoneList

List of all zones and associated hosts for a cluster

Name	Type	Description
zones	ClusterZone[]	Zone and associated hosts info

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.