vmm_servers

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

Overview

Name	vmm_servers
Type	Resource
Id	azure.scvmm.vmm_servers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
connectionStatus	string	Gets the connection status to the vmmServer.
credentials	object	Credentials to connect to VmmServer.
errorMessage	string	Gets any error message if connection to vmmServer is having any issue.
extendedLocation	object	The extended location. Required.
fqdn	string	Fqdn is the hostname/ip of the vmmServer. Required.
location	string	The geo-location where the resource lives. Required.
port	integer	Port is the port on which the vmmServer is listening.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Unique ID of vmmServer.
version	string	Version is the version of the vmmSever.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
connectionStatus	string	Gets the connection status to the vmmServer.
credentials	object	Credentials to connect to VmmServer.
errorMessage	string	Gets any error message if connection to vmmServer is having any issue.
extendedLocation	object	The extended location. Required.
fqdn	string	Fqdn is the hostname/ip of the vmmServer. Required.
location	string	The geo-location where the resource lives. Required.
port	integer	Port is the port on which the vmmServer is listening.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Unique ID of vmmServer.
version	string	Version is the version of the vmmSever.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
connectionStatus	string	Gets the connection status to the vmmServer.
credentials	object	Credentials to connect to VmmServer.
errorMessage	string	Gets any error message if connection to vmmServer is having any issue.
extendedLocation	object	The extended location. Required.
fqdn	string	Fqdn is the hostname/ip of the vmmServer. Required.
location	string	The geo-location where the resource lives. Required.
port	integer	Port is the port on which the vmmServer is listening.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Unique ID of vmmServer.
version	string	Version is the version of the vmmSever.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vmm_server_name, subscription_id		Gets a VMMServer. Implements VmmServer GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET VmmServers in a resource group. List of VmmServers in a resource group.
list_by_subscription	select	subscription_id		Implements GET VmmServers in a subscription. List of VmmServers in a subscription.
create_or_update	insert	resource_group_name, vmm_server_name, subscription_id, location, extendedLocation		Implements VmmServers PUT method. Onboards the SCVmm fabric as an Azure VmmServer resource.
update	update	resource_group_name, vmm_server_name, subscription_id		Implements VmmServers PATCH method. Updates the VmmServers resource.
create_or_update	replace	resource_group_name, vmm_server_name, subscription_id, location, extendedLocation		Implements VmmServers PUT method. Onboards the SCVmm fabric as an Azure VmmServer resource.
delete	delete	resource_group_name, vmm_server_name, subscription_id	force	Implements VmmServers DELETE method. Removes the SCVmm fabric from Azure.

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 name of the resource group. The name is case insensitive. Required.
subscription_id	string
vmm_server_name	string	Name of the VmmServer. Required.
force	string	Forces the resource to be deleted. Known values are: "true" and "false". Default value is None.

SELECT examples

get

Gets a VMMServer. Implements VmmServer GET method.

SELECT
id,
name,
connectionStatus,
credentials,
errorMessage,
extendedLocation,
fqdn,
location,
port,
provisioningState,
systemData,
tags,
type,
uuid,
version
FROM azure.scvmm.vmm_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vmm_server_name = '{{ vmm_server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
connectionStatus,
credentials,
errorMessage,
extendedLocation,
fqdn,
location,
port,
provisioningState,
systemData,
tags,
type,
uuid,
version
FROM azure.scvmm.vmm_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
connectionStatus,
credentials,
errorMessage,
extendedLocation,
fqdn,
location,
port,
provisioningState,
systemData,
tags,
type,
uuid,
version
FROM azure.scvmm.vmm_servers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Implements VmmServers PUT method. Onboards the SCVmm fabric as an Azure VmmServer resource.

INSERT INTO azure.scvmm.vmm_servers (
tags,
location,
properties,
extendedLocation,
resource_group_name,
vmm_server_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ vmm_server_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vmm_servers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vmm_servers resource.
  - name: vmm_server_name
    value: "{{ vmm_server_name }}"
    description: Required parameter for the vmm_servers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vmm_servers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      credentials:
        username: "{{ username }}"
        password: "{{ password }}"
      fqdn: "{{ fqdn }}"
      port: {{ port }}
      connectionStatus: "{{ connectionStatus }}"
      errorMessage: "{{ errorMessage }}"
      uuid: "{{ uuid }}"
      version: "{{ version }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location. Required.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Implements VmmServers PATCH method. Updates the VmmServers resource.

UPDATE azure.scvmm.vmm_servers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vmm_server_name = '{{ vmm_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Implements VmmServers PUT method. Onboards the SCVmm fabric as an Azure VmmServer resource.

REPLACE azure.scvmm.vmm_servers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vmm_server_name = '{{ vmm_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Implements VmmServers DELETE method. Removes the SCVmm fabric from Azure.

DELETE FROM azure.scvmm.vmm_servers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vmm_server_name = '{{ vmm_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;