clouds

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

Overview

Name	clouds
Type	Resource
Id	azure.scvmm.clouds

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.
cloudCapacity	object	Capacity of the cloud.
cloudName	string	Name of the cloud in VmmServer.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
storageQoSPolicies	array	List of QoS policies available for the cloud.
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 the cloud.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource resides.

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.
cloudCapacity	object	Capacity of the cloud.
cloudName	string	Name of the cloud in VmmServer.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
storageQoSPolicies	array	List of QoS policies available for the cloud.
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 the cloud.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource resides.

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.
cloudCapacity	object	Capacity of the cloud.
cloudName	string	Name of the cloud in VmmServer.
extendedLocation	object	The extended location. Required.
inventoryItemId	string	Gets or sets the inventory Item ID for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
storageQoSPolicies	array	List of QoS policies available for the cloud.
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 the cloud.
vmmServerId	string	ARM Id of the vmmServer resource in which this resource resides.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cloud_resource_name, subscription_id		Gets a Cloud. Implements Cloud GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET Clouds in a resource group. List of Clouds in a resource group.
list_by_subscription	select	subscription_id		Implements GET Clouds in a subscription. List of Clouds in a subscription.
create_or_update	insert	resource_group_name, cloud_resource_name, subscription_id, location, extendedLocation		Implements Clouds PUT method. Onboards the ScVmm fabric cloud as an Azure cloud resource.
update	update	resource_group_name, cloud_resource_name, subscription_id		Implements the Clouds PATCH method. Updates the Clouds resource.
create_or_update	replace	resource_group_name, cloud_resource_name, subscription_id, location, extendedLocation		Implements Clouds PUT method. Onboards the ScVmm fabric cloud as an Azure cloud resource.
delete	delete	resource_group_name, cloud_resource_name, subscription_id	force	Implements Cloud resource DELETE method. Deregisters the ScVmm fabric cloud 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
cloud_resource_name	string	Name of the Cloud. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
force	string	Forces the resource to be deleted. Known values are: "true" and "false". Default value is None.

SELECT examples

get

Gets a Cloud. Implements Cloud GET method.

SELECT
id,
name,
cloudCapacity,
cloudName,
extendedLocation,
inventoryItemId,
location,
provisioningState,
storageQoSPolicies,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.clouds
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloud_resource_name = '{{ cloud_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
cloudCapacity,
cloudName,
extendedLocation,
inventoryItemId,
location,
provisioningState,
storageQoSPolicies,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.clouds
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
cloudCapacity,
cloudName,
extendedLocation,
inventoryItemId,
location,
provisioningState,
storageQoSPolicies,
systemData,
tags,
type,
uuid,
vmmServerId
FROM azure.scvmm.clouds
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Implements Clouds PUT method. Onboards the ScVmm fabric cloud as an Azure cloud resource.

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

Manifest

# Description fields are for documentation purposes
- name: clouds
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clouds resource.
  - name: cloud_resource_name
    value: "{{ cloud_resource_name }}"
    description: Required parameter for the clouds resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clouds 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:
      inventoryItemId: "{{ inventoryItemId }}"
      uuid: "{{ uuid }}"
      vmmServerId: "{{ vmmServerId }}"
      cloudName: "{{ cloudName }}"
      cloudCapacity:
        cpuCount: {{ cpuCount }}
        memoryMB: {{ memoryMB }}
        vmCount: {{ vmCount }}
      storageQoSPolicies:
        - name: "{{ name }}"
          id: "{{ id }}"
          iopsMaximum: {{ iopsMaximum }}
          iopsMinimum: {{ iopsMinimum }}
          bandwidthLimit: {{ bandwidthLimit }}
          policyId: "{{ policyId }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location. Required.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Implements the Clouds PATCH method. Updates the Clouds resource.

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

REPLACE examples

create_or_update

Implements Clouds PUT method. Onboards the ScVmm fabric cloud as an Azure cloud resource.

REPLACE azure.scvmm.clouds
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cloud_resource_name = '{{ cloud_resource_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 Cloud resource DELETE method. Deregisters the ScVmm fabric cloud from Azure.

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