discovery_sources

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

Overview

Name	discovery_sources
Type	Resource
Id	azure.dependency_map.discovery_sources

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of Discovery Source resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sourceId	string	Source ArmId of Discovery Source resource. Required.
sourceType	string	Source type of Discovery Source resource. Required. "OffAzure"
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".

list_by_maps_resource

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of Discovery Source resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sourceId	string	Source ArmId of Discovery Source resource. Required.
sourceType	string	Source type of Discovery Source resource. Required. "OffAzure"
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, map_name, source_name, subscription_id		Get a DiscoverySourceResource.
list_by_maps_resource	select	resource_group_name, map_name, subscription_id		List DiscoverySourceResource resources by MapsResource.
create_or_update	insert	resource_group_name, map_name, source_name, subscription_id, location		Create a DiscoverySourceResource.
update	update	resource_group_name, map_name, source_name, subscription_id		Update a DiscoverySourceResource.
create_or_update	replace	resource_group_name, map_name, source_name, subscription_id, location		Create a DiscoverySourceResource.
delete	delete	resource_group_name, map_name, source_name, subscription_id		Delete a DiscoverySourceResource.

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
map_name	string	Maps resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
source_name	string	discovery source resource. Required.
subscription_id	string

SELECT examples

get

Get a DiscoverySourceResource.

SELECT
id,
name,
location,
provisioningState,
sourceId,
sourceType,
systemData,
tags,
type
FROM azure.dependency_map.discovery_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND map_name = '{{ map_name }}' -- required
AND source_name = '{{ source_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_maps_resource

List DiscoverySourceResource resources by MapsResource.

SELECT
id,
name,
location,
provisioningState,
sourceId,
sourceType,
systemData,
tags,
type
FROM azure.dependency_map.discovery_sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND map_name = '{{ map_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DiscoverySourceResource.

INSERT INTO azure.dependency_map.discovery_sources (
tags,
location,
properties,
resource_group_name,
map_name,
source_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ map_name }}',
'{{ source_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: discovery_sources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the discovery_sources resource.
  - name: map_name
    value: "{{ map_name }}"
    description: Required parameter for the discovery_sources resource.
  - name: source_name
    value: "{{ source_name }}"
    description: Required parameter for the discovery_sources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the discovery_sources 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 }}"
      sourceType: "{{ sourceType }}"
      sourceId: "{{ sourceId }}"

UPDATE examples

update

Update a DiscoverySourceResource.

UPDATE azure.dependency_map.discovery_sources
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND map_name = '{{ map_name }}' --required
AND source_name = '{{ source_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a DiscoverySourceResource.

REPLACE azure.dependency_map.discovery_sources
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND map_name = '{{ map_name }}' --required
AND source_name = '{{ source_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 DiscoverySourceResource.

DELETE FROM azure.dependency_map.discovery_sources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND map_name = '{{ map_name }}' --required
AND source_name = '{{ source_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;