Hyper V Cluster - Put Cluster

Service:

Azure Migrate

API Version:

2020-01-01

Method to create or update a cluster in site.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/HyperVSites/{siteName}/clusters/{clusterName}?api-version=2020-01-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	Cluster ARM name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
siteName	path	True	string	Site name.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
name	string	Name of the cluster.
properties	HyperVClusterProperties	Nested properties of the cluster.

Responses

Name	Type	Description
202 Accepted		Accepted Headers Azure-AsyncOperation: string

Examples

Add new cluster

Sample request

HTTP

PUT https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/pajindTest/providers/Microsoft.OffAzure/HyperVSites/appliance1e39site/clusters/cluster1?api-version=2020-01-01

{
  "properties": {
    "fqdn": "10.10.10.30",
    "runAsAccountId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/pajindTest/providers/Microsoft.OffAzure/HyperVSites/appliance1e39site/runasaccounts/Account1"
  }
}

Sample response

Status code:

202

Definitions

Name	Description
HealthErrorDetails	Error contract returned when some exception occurs in Rest API.
HyperVCluster	Cluster REST Resource.
HyperVClusterProperties	Class for cluster properties.

HealthErrorDetails

Object

Error contract returned when some exception occurs in Rest API.

Name	Type	Description
code	string	Error name.
id	integer (int64)	Error ID.
message	string	Error message.
messageParameters	object	Message parameters.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
severity	string	Error severity.
source	string	Error source.
summaryMessage	string	Error summary message.

HyperVCluster

Object

Cluster REST Resource.

Name	Type	Description
id	string	Resource Id.
name	string	Name of the cluster.
properties	HyperVClusterProperties	Nested properties of the cluster.
type	string	Type of resource. Type = Microsoft.OffAzure/hyperVSites/clusters.

HyperVClusterProperties

Object

Class for cluster properties.

Name	Type	Description
createdTimestamp	string	Timestamp marking Hyper-V cluster creation.
errors	HealthErrorDetails[]	Errors for Hyper-V clusters.
fqdn	string	FQDN/IPAddress of the Hyper-V cluster.
functionalLevel	integer (int32)	Functional level of the Hyper-V cluster.
hostFqdnList	string[]	List of hosts (FQDN) currently being tracked by the cluster.
runAsAccountId	string	Run as account ID of the Hyper-V cluster.
status	string	Status of the Hyper-V cluster.
updatedTimestamp	string	Timestamp marking last updated on the Hyper-V cluster.