Clusters - Create

Implements cluster PUT method.
Create Or Update cluster.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/clusters/{clusterName}?api-version=2023-12-01

URI Parameters

Name In Required Type Description
clusterName
path True

string

Name of the cluster.

resourceGroupName
path True

string

The Resource Group Name.

subscriptionId
path True

string

The Subscription ID.

api-version
query True

string

Client Api Version.

Request Body

Name Required Type Description
location True

string

Gets or sets the location.

extendedLocation

ExtendedLocation

Gets or sets the extended location.

kind

string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

properties.inventoryItemId

string

Gets or sets the inventory Item ID for the cluster.

properties.moRefId

string

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.

properties.vCenterId

string

Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

tags

object

Gets or sets the Resource tags.

Responses

Name Type Description
200 OK

Cluster

Arm resource update successful.

201 Created

Cluster

Created

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

CreateCluster

Sample request

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/clusters/HRCluster?api-version=2023-12-01

{
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "vCenterId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
    "moRefId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  }
}

Sample response

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/Clusters/HRCluster",
  "name": "HRCluster",
  "type": "Microsoft.ConnectedVMwarevSphere/Clusters",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "vCenterId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
    "moRefId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Succeeded"
  }
}
{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/Clusters/ContosoAgent",
  "name": "ContosoAgent",
  "type": "Microsoft.ConnectedVMwarevSphere/Clusters",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "vCenterId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
    "moRefId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Created"
  }
}

Definitions

Name Description
Cluster

Define the cluster.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ExtendedLocation

The extended location.

ProvisioningState

Gets the provisioning state.

ResourceStatus

The resource status information.

systemData

Metadata pertaining to creation and last modification of the resource.

Cluster

Define the cluster.

Name Type Description
extendedLocation

ExtendedLocation

Gets or sets the extended location.

id

string

Gets or sets the Id.

kind

string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location

string

Gets or sets the location.

name

string

Gets or sets the name.

properties.customResourceName

string

Gets the name of the corresponding resource in Kubernetes.

properties.datastoreIds

string[]

Gets the datastore ARM ids.

properties.inventoryItemId

string

Gets or sets the inventory Item ID for the cluster.

properties.moName

string

Gets or sets the vCenter Managed Object name for the cluster.

properties.moRefId

string

Gets or sets the vCenter MoRef (Managed Object Reference) ID for the cluster.

properties.networkIds

string[]

Gets the network ARM ids.

properties.provisioningState

ProvisioningState

Gets the provisioning state.

properties.statuses

ResourceStatus[]

The resource status information.

properties.totalCpuMHz

integer

Gets the max CPU usage across all cores on the cluster in MHz.

properties.totalMemoryGB

integer

Gets the total amount of physical memory on the cluster in GB.

properties.usedCpuMHz

integer

Gets the used CPU usage across all cores on the cluster in MHz.

properties.usedMemoryGB

integer

Gets the used physical memory on the cluster in GB.

properties.uuid

string

Gets or sets a unique identifier for this resource.

properties.vCenterId

string

Gets or sets the ARM Id of the vCenter resource in which this cluster resides.

systemData

systemData

The system data.

tags

object

Gets or sets the Resource tags.

type

string

Gets or sets the type of the resource.

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.

ExtendedLocation

The extended location.

Name Type Description
name

string

The extended location name.

type

string

The extended location type.

ProvisioningState

Gets the provisioning state.

Name Type Description
Accepted

string

Canceled

string

Created

string

Deleting

string

Failed

string

Provisioning

string

Succeeded

string

Updating

string

ResourceStatus

The resource status information.

Name Type Description
lastUpdatedAt

string

The last update time for this condition.

message

string

A human readable message indicating details about the status.

reason

string

The reason for the condition's status.

severity

string

Severity with which to treat failures of this type of condition.

status

string

Status of the condition.

type

string

The type of the condition.

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.