v_centers

Creates, updates, deletes, gets or lists a v_centers resource.

Overview

Name	v_centers
Type	Resource
Id	azure_isv.connectedvmware.v_centers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
connectionStatus	string	Gets or sets the connection status to the vCenter.
credentials	object	Username / Password Credentials to connect to vcenter.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
fqdn	string	Gets or sets the FQDN/IPAddress of the vCenter. Required.
instanceUuid	string	Gets or sets the instance UUID of the vCenter.
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. Required.
port	integer	Gets or sets the port of the vCenter.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
version	string	Gets or sets the version of the vCenter.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
connectionStatus	string	Gets or sets the connection status to the vCenter.
credentials	object	Username / Password Credentials to connect to vcenter.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
fqdn	string	Gets or sets the FQDN/IPAddress of the vCenter. Required.
instanceUuid	string	Gets or sets the instance UUID of the vCenter.
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. Required.
port	integer	Gets or sets the port of the vCenter.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
version	string	Gets or sets the version of the vCenter.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
connectionStatus	string	Gets or sets the connection status to the vCenter.
credentials	object	Username / Password Credentials to connect to vcenter.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
fqdn	string	Gets or sets the FQDN/IPAddress of the vCenter. Required.
instanceUuid	string	Gets or sets the instance UUID of the vCenter.
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. Required.
port	integer	Gets or sets the port of the vCenter.
provisioningState	string	Gets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
version	string	Gets or sets the version of the vCenter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vcenter_name, subscription_id		Gets a vCenter. Implements vCenter GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET vCenters in a resource group. List of vCenters in a resource group.
list	select	subscription_id		Implements GET vCenters in a subscription. List of vCenters in a subscription.
create	insert	resource_group_name, vcenter_name, subscription_id, location, properties		Implements vCenter PUT method. Create Or Update vCenter.
update	update	resource_group_name, vcenter_name, subscription_id		Updates a vCenter. API to update certain properties of the vCenter resource.
delete	delete	resource_group_name, vcenter_name, subscription_id	force	Deletes an vCenter. Implements vCenter DELETE method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
vcenter_name	string	Name of the vCenter. Required.
force	boolean	Whether force delete was specified. Default value is None.

SELECT examples

get

Gets a vCenter. Implements vCenter GET method.

SELECT
id,
name,
connectionStatus,
credentials,
customResourceName,
extendedLocation,
fqdn,
instanceUuid,
kind,
location,
port,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
version
FROM azure_isv.connectedvmware.v_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vcenter_name = '{{ vcenter_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements GET vCenters in a resource group. List of vCenters in a resource group.

SELECT
id,
name,
connectionStatus,
credentials,
customResourceName,
extendedLocation,
fqdn,
instanceUuid,
kind,
location,
port,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
version
FROM azure_isv.connectedvmware.v_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements GET vCenters in a subscription. List of vCenters in a subscription.

SELECT
id,
name,
connectionStatus,
credentials,
customResourceName,
extendedLocation,
fqdn,
instanceUuid,
kind,
location,
port,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
version
FROM azure_isv.connectedvmware.v_centers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements vCenter PUT method. Create Or Update vCenter.

INSERT INTO azure_isv.connectedvmware.v_centers (
location,
extendedLocation,
tags,
kind,
properties,
resource_group_name,
vcenter_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ vcenter_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: v_centers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the v_centers resource.
  - name: vcenter_name
    value: "{{ vcenter_name }}"
    description: Required parameter for the v_centers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the v_centers resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location. Required.
  - name: extendedLocation
    description: |
      Gets or sets the extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      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.
  - name: properties
    value:
      fqdn: "{{ fqdn }}"
      port: {{ port }}
      credentials:
        username: "{{ username }}"
        password: "{{ password }}"

UPDATE examples

update

Updates a vCenter. API to update certain properties of the vCenter resource.

UPDATE azure_isv.connectedvmware.v_centers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vcenter_name = '{{ vcenter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes an vCenter. Implements vCenter DELETE method.

DELETE FROM azure_isv.connectedvmware.v_centers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vcenter_name = '{{ vcenter_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;