Clusters - List

Service:

AVS

API Version:

2023-09-01

List Cluster resources by PrivateCloud

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

URI Parameters

Name	In	Required	Type	Description
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	ClusterListResult	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_List

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1",
      "name": "cluster1",
      "sku": {
        "name": "AV20"
      },
      "properties": {
        "clusterSize": 3,
        "hosts": [
          "fakehost22.nyc1.kubernetes.center",
          "fakehost23.nyc1.kubernetes.center",
          "fakehost24.nyc1.kubernetes.center"
        ],
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.AVS/privateClouds/clusters"
    }
  ]
}

Definitions

Name	Description
Cluster	A cluster resource
ClusterListResult	The response of a Cluster list operation.
ClusterProvisioningState	Cluster provisioning state
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
systemData	Metadata pertaining to creation and last modification of the resource.

Cluster

A cluster resource

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.clusterId	integer	The identity
properties.clusterSize	integer	The cluster size
properties.hosts	string[]	The hosts
properties.provisioningState	ClusterProvisioningState	The state of the cluster provisioning
properties.vsanDatastoreName	string	Name of the vsan datastore associated with the cluster
sku	Sku	The SKU (Stock Keeping Unit) assigned to this resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ClusterListResult

The response of a Cluster list operation.

Name	Type	Description
nextLink	string	The link to the next page of items
value	Cluster[]	The Cluster items on this page

ClusterProvisioningState

Cluster provisioning state

Name	Type	Description
Canceled	string	Resource creation was canceled.
Cancelled	string	is cancelled
Deleting	string	is deleting
Failed	string	Resource creation failed.
Succeeded	string	Resource has been created.
Updating	string	is updating

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

Sku

The resource model definition representing SKU

Name	Type	Description
capacity	integer	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. E.g. P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name	Type	Description
Basic	string
Free	string
Premium	string
Standard	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.