inventory_items

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

Overview

Name	inventory_items
Type	Resource
Id	azure_isv.connected_vsphere.inventory_items

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
properties	object	Resource properties.

list_by_v_center

Name	Datatype	Description
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.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vcenterName, inventoryItemName	api-version	Implements InventoryItem GET method.
list_by_v_center	select	subscriptionId, resourceGroupName, vcenterName	api-version	Returns the list of inventoryItems of the given vCenter.
create	insert	subscriptionId, resourceGroupName, vcenterName, inventoryItemName, data__properties	api-version	Create Or Update InventoryItem.
delete	delete	subscriptionId, resourceGroupName, vcenterName, inventoryItemName	api-version	Implements inventoryItem 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
inventoryItemName	string	Name of the inventoryItem.
resourceGroupName	string	The Resource Group Name.
subscriptionId	string	The Subscription ID.
vcenterName	string	Name of the vCenter.
api-version	string	Client Api Version.

SELECT examples

get

Implements InventoryItem GET method.

SELECT
kind,
properties
FROM azure_isv.connected_vsphere.inventory_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vcenterName = '{{ vcenterName }}' -- required
AND inventoryItemName = '{{ inventoryItemName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_v_center

Returns the list of inventoryItems of the given vCenter.

SELECT
kind,
properties
FROM azure_isv.connected_vsphere.inventory_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vcenterName = '{{ vcenterName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Create Or Update InventoryItem.

INSERT INTO azure_isv.connected_vsphere.inventory_items (
data__properties,
data__kind,
subscriptionId,
resourceGroupName,
vcenterName,
inventoryItemName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ kind }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vcenterName }}',
'{{ inventoryItemName }}',
'{{ api-version }}'
RETURNING
kind,
properties
;

Manifest

# Description fields are for documentation purposes
- name: inventory_items
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the inventory_items resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the inventory_items resource.
    - name: vcenterName
      value: string
      description: Required parameter for the inventory_items resource.
    - name: inventoryItemName
      value: string
      description: Required parameter for the inventory_items resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: kind
      value: string
      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: api-version
      value: string
      description: Client Api Version.

DELETE examples

delete

Implements inventoryItem DELETE method.

DELETE FROM azure_isv.connected_vsphere.inventory_items
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vcenterName = '{{ vcenterName }}' --required
AND inventoryItemName = '{{ inventoryItemName }}' --required
AND api-version = '{{ api-version }}'
;