Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The vcenters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ConnectedVMwarevSphere/vcenters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ConnectedVMwarevSphere/vcenters@2023-12-01' = {
extendedLocation: {
name: 'string'
type: 'string'
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
credentials: {
password: 'string'
username: 'string'
}
fqdn: 'string'
port: int
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.ConnectedVMwarevSphere/vcenters
| Name | Description | Value |
|---|---|---|
| extendedLocation | Gets or sets the extended location. | ExtendedLocation |
| kind | 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. | string |
| location | Gets or sets the location. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | VCenterProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string |
| type | The extended location type. | string |
VCenterProperties
| Name | Description | Value |
|---|---|---|
| credentials | Username / Password Credentials to connect to vcenter. | VICredential |
| fqdn | Gets or sets the FQDN/IPAddress of the vCenter. | string (required) |
| port | Gets or sets the port of the vCenter. | int Constraints: Min value = 1 Max value = 65535 |
VCenterTags
| Name | Description | Value |
|---|
VICredential
| Name | Description | Value |
|---|---|---|
| password | Gets or sets the password to connect with the vCenter. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| username | Gets or sets username to connect with the vCenter. | string |
ARM template resource definition
The vcenters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ConnectedVMwarevSphere/vcenters resource, add the following JSON to your template.
{
"type": "Microsoft.ConnectedVMwarevSphere/vcenters",
"apiVersion": "2023-12-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"kind": "string",
"location": "string",
"properties": {
"credentials": {
"password": "string",
"username": "string"
},
"fqdn": "string",
"port": "int"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.ConnectedVMwarevSphere/vcenters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| extendedLocation | Gets or sets the extended location. | ExtendedLocation |
| kind | 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. | string |
| location | Gets or sets the location. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | VCenterProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ConnectedVMwarevSphere/vcenters' |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string |
| type | The extended location type. | string |
VCenterProperties
| Name | Description | Value |
|---|---|---|
| credentials | Username / Password Credentials to connect to vcenter. | VICredential |
| fqdn | Gets or sets the FQDN/IPAddress of the vCenter. | string (required) |
| port | Gets or sets the port of the vCenter. | int Constraints: Min value = 1 Max value = 65535 |
VCenterTags
| Name | Description | Value |
|---|
VICredential
| Name | Description | Value |
|---|---|---|
| password | Gets or sets the password to connect with the vCenter. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| username | Gets or sets username to connect with the vCenter. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The vcenters resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ConnectedVMwarevSphere/vcenters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ConnectedVMwarevSphere/vcenters@2023-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
kind = "string"
properties = {
credentials = {
password = "string"
username = "string"
}
fqdn = "string"
port = int
}
}
}
Property Values
Microsoft.ConnectedVMwarevSphere/vcenters
| Name | Description | Value |
|---|---|---|
| extendedLocation | Gets or sets the extended location. | ExtendedLocation |
| kind | 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. | string |
| location | Gets or sets the location. | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | VCenterProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ConnectedVMwarevSphere/vcenters@2023-12-01" |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string |
| type | The extended location type. | string |
VCenterProperties
| Name | Description | Value |
|---|---|---|
| credentials | Username / Password Credentials to connect to vcenter. | VICredential |
| fqdn | Gets or sets the FQDN/IPAddress of the vCenter. | string (required) |
| port | Gets or sets the port of the vCenter. | int Constraints: Min value = 1 Max value = 65535 |
VCenterTags
| Name | Description | Value |
|---|
VICredential
| Name | Description | Value |
|---|---|---|
| password | Gets or sets the password to connect with the vCenter. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| username | Gets or sets username to connect with the vCenter. | string |