vmm_servers

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

Overview

Name	vmm_servers
Type	Resource
Id	azure.system_center_vm_manager.vmm_servers

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vmmServerName		Implements VmmServer GET method.
list_by_resource_group	select	subscriptionId, resourceGroupName		List of VmmServers in a resource group.
list_by_subscription	select	subscriptionId		List of VmmServers in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, vmmServerName, data__extendedLocation		Onboards the SCVmm fabric as an Azure VmmServer resource.
update	update	subscriptionId, resourceGroupName, vmmServerName		Updates the VmmServers resource.
delete	delete	subscriptionId, resourceGroupName, vmmServerName	force	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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vmmServerName	string	Name of the VmmServer.
force	string	Forces the resource to be deleted.

SELECT examples

get

Implements VmmServer GET method.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.vmm_servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vmmServerName = '{{ vmmServerName }}' -- required
;

list_by_resource_group

List of VmmServers in a resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.vmm_servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List of VmmServers in a subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.system_center_vm_manager.vmm_servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Onboards the SCVmm fabric as an Azure VmmServer resource.

INSERT INTO azure.system_center_vm_manager.vmm_servers (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
vmmServerName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vmmServerName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: vmm_servers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vmm_servers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vmm_servers resource.
    - name: vmmServerName
      value: string
      description: Required parameter for the vmm_servers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the VmmServers resource.

UPDATE azure.system_center_vm_manager.vmm_servers
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vmmServerName = '{{ vmmServerName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Removes the SCVmm fabric from Azure.

DELETE FROM azure.system_center_vm_manager.vmm_servers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vmmServerName = '{{ vmmServerName }}' --required
AND force = '{{ force }}'
;