inventory_items

Creates, updates, deletes, gets or lists an inventory_items resource.

Overview

Name	inventory_items
Type	Resource
Id	azure.scvmm.inventory_items

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.
inventoryItemName	string	Gets the Managed Object name in Vmm for the inventory item.
inventoryType	string	They inventory type. Required. Known values are: "Cloud", "VirtualNetwork", "VirtualMachine", and "VirtualMachineTemplate".
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.
managedResourceId	string	Gets the tracked resource id corresponding to the inventory resource.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Gets the UUID (which is assigned by Vmm) for the inventory item.

list_by_vmm_server

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.
inventoryItemName	string	Gets the Managed Object name in Vmm for the inventory item.
inventoryType	string	They inventory type. Required. Known values are: "Cloud", "VirtualNetwork", "VirtualMachine", and "VirtualMachineTemplate".
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.
managedResourceId	string	Gets the tracked resource id corresponding to the inventory resource.
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.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Gets the UUID (which is assigned by Vmm) for the inventory item.

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, inventory_item_resource_name, subscription_id		Implements GET InventoryItem method. Shows an inventory item.
list_by_vmm_server	select	resource_group_name, vmm_server_name, subscription_id		Implements GET for the list of Inventory Items in the VMMServer. Returns the list of inventoryItems in the given VmmServer.
create	insert	resource_group_name, vmm_server_name, inventory_item_resource_name, subscription_id		Implements InventoryItem PUT method. Create Or Update InventoryItem.
delete	delete	resource_group_name, vmm_server_name, inventory_item_resource_name, subscription_id		Implements inventoryItem DELETE method. Deletes an inventoryItem.

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
inventory_item_resource_name	string	Name of the inventoryItem. Required.
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.

SELECT examples

get

Implements GET InventoryItem method. Shows an inventory item.

SELECT
id,
name,
inventoryItemName,
inventoryType,
kind,
managedResourceId,
provisioningState,
systemData,
type,
uuid
FROM azure.scvmm.inventory_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vmm_server_name = '{{ vmm_server_name }}' -- required
AND inventory_item_resource_name = '{{ inventory_item_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_vmm_server

Implements GET for the list of Inventory Items in the VMMServer. Returns the list of inventoryItems in the given VmmServer.

SELECT
id,
name,
inventoryItemName,
inventoryType,
kind,
managedResourceId,
provisioningState,
systemData,
type,
uuid
FROM azure.scvmm.inventory_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vmm_server_name = '{{ vmm_server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements InventoryItem PUT method. Create Or Update InventoryItem.

INSERT INTO azure.scvmm.inventory_items (
properties,
kind,
resource_group_name,
vmm_server_name,
inventory_item_resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ vmm_server_name }}',
'{{ inventory_item_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: inventory_items
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the inventory_items resource.
  - name: vmm_server_name
    value: "{{ vmm_server_name }}"
    description: Required parameter for the inventory_items resource.
  - name: inventory_item_resource_name
    value: "{{ inventory_item_resource_name }}"
    description: Required parameter for the inventory_items resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the inventory_items resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      inventoryType: "{{ inventoryType }}"
      managedResourceId: "{{ managedResourceId }}"
      uuid: "{{ uuid }}"
      inventoryItemName: "{{ inventoryItemName }}"
      provisioningState: "{{ provisioningState }}"
  - 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.

DELETE examples

delete

Implements inventoryItem DELETE method. Deletes an inventoryItem.

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