tools

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

Overview

Name	tools
Type	Resource
Id	azure.discovery.tools

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.
definitionContent	object	The JSON content for defining a resource. Required.
environmentVariables	object	Environment variables to make available.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
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".
version	string	The version of a resource definition. Required.

list_by_resource_group

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.
definitionContent	object	The JSON content for defining a resource. Required.
environmentVariables	object	Environment variables to make available.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
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".
version	string	The version of a resource definition. Required.

list_by_subscription

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.
definitionContent	object	The JSON content for defining a resource. Required.
environmentVariables	object	Environment variables to make available.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
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".
version	string	The version of a resource definition. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, tool_name, subscription_id		Get a Tool.
list_by_resource_group	select	resource_group_name, subscription_id		List Tool resources by resource group.
list_by_subscription	select	subscription_id		List Tool resources by subscription ID.
create_or_update	insert	resource_group_name, tool_name, subscription_id, location		Create a Tool.
update	update	resource_group_name, tool_name, subscription_id, location		Update a Tool.
create_or_update	replace	resource_group_name, tool_name, subscription_id, location		Create a Tool.
delete	delete	resource_group_name, tool_name, subscription_id		Delete a Tool.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
tool_name	string	The name of the Tool. Required.

SELECT examples

get

Get a Tool.

SELECT
id,
name,
definitionContent,
environmentVariables,
location,
provisioningState,
systemData,
tags,
type,
version
FROM azure.discovery.tools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND tool_name = '{{ tool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Tool resources by resource group.

SELECT
id,
name,
definitionContent,
environmentVariables,
location,
provisioningState,
systemData,
tags,
type,
version
FROM azure.discovery.tools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Tool resources by subscription ID.

SELECT
id,
name,
definitionContent,
environmentVariables,
location,
provisioningState,
systemData,
tags,
type,
version
FROM azure.discovery.tools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Tool.

INSERT INTO azure.discovery.tools (
tags,
location,
properties,
resource_group_name,
tool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ tool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: tools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the tools resource.
  - name: tool_name
    value: "{{ tool_name }}"
    description: Required parameter for the tools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the tools 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:
      provisioningState: "{{ provisioningState }}"
      version: "{{ version }}"
      environmentVariables: "{{ environmentVariables }}"
      definitionContent: "{{ definitionContent }}"

UPDATE examples

update

Update a Tool.

UPDATE azure.discovery.tools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND tool_name = '{{ tool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Tool.

REPLACE azure.discovery.tools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND tool_name = '{{ tool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Tool.

DELETE FROM azure.discovery.tools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND tool_name = '{{ tool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;