V Centers - Create

Service:: Azure Arc enabled VMware

API Version:: 2023-12-01

Implements vCenter PUT method.
Create Or Update vCenter.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The Resource Group Name.
subscriptionId	path	True	string	The Subscription ID.
vcenterName	path	True	string	Name of the vCenter.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
location	True	string	Gets or sets the location.
properties.fqdn	True	string	Gets or sets the FQDN/IPAddress of the vCenter.
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.credentials		VICredential	Username / Password Credentials to connect to vcenter.
properties.port		integer (int32) minimum: 1 maximum: 65535	Gets or sets the port of the vCenter.
tags		object	Gets or sets the Resource tags.

Responses

Name	Type	Description
200 OK	VCenter	Arm resource update successful.
201 Created	VCenter	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

CreateVCenter

PUT https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/ContosoVCenter?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": {
    "fqdn": "ContosoVMware.contoso.com",
    "port": 1234,
    "credentials": {
      "username": "tempuser",
      "password": "<password>"
    }
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ConnectedVMwarevSphere.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.ConnectedVMwarevSphere;

// Generated from example definition: specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/stable/2023-12-01/examples/CreateVCenter.json
// this example is just showing the usage of "VCenters_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "testrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this VMwareVCenterResource
VMwareVCenterCollection collection = resourceGroupResource.GetVMwareVCenters();

// invoke the operation
string vcenterName = "ContosoVCenter";
VMwareVCenterData data = new VMwareVCenterData(new AzureLocation("East US"), "ContosoVMware.contoso.com")
{
    ExtendedLocation = new ExtendedLocation
    {
        Name = "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso",
    },
    Port = 1234,
    Credentials = new VICredential
    {
        Username = "tempuser",
        Password = "<password>",
    },
};
ArmOperation<VMwareVCenterResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, vcenterName, data);
VMwareVCenterResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VMwareVCenterData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
  "name": "ContosoVCenter",
  "type": "Microsoft.ConnectedVMwarevSphere/VCenters",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "fqdn": "ContosoVMware.contoso.com",
    "port": 1234,
    "credentials": {
      "username": "tempuser"
    },
    "version": "1.0",
    "instanceUuid": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Succeeded"
  }
}

Status code:: 201

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
  "name": "ContosoVCenter",
  "type": "Microsoft.ConnectedVMwarevSphere/VCenters",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "fqdn": "ContosoVMware.contoso.com",
    "port": 1234,
    "credentials": {
      "username": "tempuser"
    },
    "version": "1.0",
    "instanceUuid": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
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.
VCenter	Defines the vCenter.
VICredential	Username / Password Credentials to connect to vcenter.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Object

The extended location.

Name	Type	Description
name	string	The extended location name.
type	string	The extended location type.

ProvisioningState

Enumeration

Gets the provisioning state.

Value	Description
Succeeded
Failed
Canceled
Provisioning
Updating
Deleting
Accepted
Created

ResourceStatus

Object

The resource status information.

Name	Type	Description
lastUpdatedAt	string (date-time)	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

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.

VCenter

Object

Defines the vCenter.

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.connectionStatus	string	Gets or sets the connection status to the vCenter.
properties.credentials	VICredential	Username / Password Credentials to connect to vcenter.
properties.customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
properties.fqdn	string	Gets or sets the FQDN/IPAddress of the vCenter.
properties.instanceUuid	string	Gets or sets the instance UUID of the vCenter.
properties.port	integer (int32) minimum: 1 maximum: 65535	Gets or sets the port of the vCenter.
properties.provisioningState	ProvisioningState	Gets the provisioning state.
properties.statuses	ResourceStatus[]	The resource status information.
properties.uuid	string	Gets or sets a unique identifier for this resource.
properties.version	string	Gets or sets the version of the vCenter.
systemData	systemData	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.

VICredential

Object

Username / Password Credentials to connect to vcenter.

Name	Type	Description
password	string	Gets or sets the password to connect with the vCenter.
username	string	Gets or sets username to connect with the vCenter.

Share via

V Centers - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

CreateVCenter

Sample request

Sample response

Definitions

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ProvisioningState

ResourceStatus

systemData

VCenter

VICredential