inventory

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

Overview

Name	inventory
Type	Resource
Id	azure.hybrid_connectivity.inventory

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureResourceId	string	Gets or sets the mapped azure resource id.
cloudNativeResourceId	string	Gets or sets the cloud native resource name.
cloudNativeType	string	Gets or sets the cloud native resource type. "ec2" (ec2)
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	Gets or sets the status of the inventory. Known values are: "New", "InProgress", "Completed", and "Failed". (New, InProgress, Completed, Failed)
statusDetails	string	Gets or sets the status details.
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".

list_by_solution_configuration

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
azureResourceId	string	Gets or sets the mapped azure resource id.
cloudNativeResourceId	string	Gets or sets the cloud native resource name.
cloudNativeType	string	Gets or sets the cloud native resource type. "ec2" (ec2)
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	Gets or sets the status of the inventory. Known values are: "New", "InProgress", "Completed", and "Failed". (New, InProgress, Completed, Failed)
statusDetails	string	Gets or sets the status details.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri, solution_configuration, inventory_id		Get a InventoryResource.
list_by_solution_configuration	select	resource_uri, solution_configuration		List InventoryResource resources by SolutionConfiguration.

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_id	string	Inventory resource. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
solution_configuration	string	Represent Solution Configuration Resource. Required.

SELECT examples

get

Get a InventoryResource.

SELECT
id,
name,
azureResourceId,
cloudNativeResourceId,
cloudNativeType,
provisioningState,
status,
statusDetails,
systemData,
type
FROM azure.hybrid_connectivity.inventory
WHERE resource_uri = '{{ resource_uri }}' -- required
AND solution_configuration = '{{ solution_configuration }}' -- required
AND inventory_id = '{{ inventory_id }}' -- required
;

list_by_solution_configuration

List InventoryResource resources by SolutionConfiguration.

SELECT
id,
name,
azureResourceId,
cloudNativeResourceId,
cloudNativeType,
provisioningState,
status,
statusDetails,
systemData,
type
FROM azure.hybrid_connectivity.inventory
WHERE resource_uri = '{{ resource_uri }}' -- required
AND solution_configuration = '{{ solution_configuration }}' -- required
;