maps

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

Overview

Name	maps
Type	Resource
Id	azure.dependency_map.maps

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 Maps resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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_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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of Maps resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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_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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of Maps resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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, subscription_id		Get a MapsResource.
list_by_resource_group	select	resource_group_name, subscription_id		List MapsResource resources by resource group.
list_by_subscription	select	subscription_id		List MapsResource resources by subscription ID.
create_or_update	insert	resource_group_name, map_name, subscription_id, location		Create a MapsResource.
update	update	resource_group_name, map_name, subscription_id		Update a MapsResource.
create_or_update	replace	resource_group_name, map_name, subscription_id, location		Create a MapsResource.
delete	delete	resource_group_name, map_name, subscription_id		Delete a MapsResource.
get_dependency_view_for_focused_machine	exec	resource_group_name, map_name, subscription_id, focusedMachineId		Get dependency map of single machine.
get_connections_with_connected_machine_for_focused_machine	exec	resource_group_name, map_name, subscription_id, focusedMachineId, connectedMachineId		Get network connections between machines.
get_connections_for_process_on_focused_machine	exec	resource_group_name, map_name, subscription_id, focusedMachineId, processIdOnFocusedMachine		Get network connections of a process.
export_dependencies	exec	resource_group_name, map_name, subscription_id, focusedMachineId		Export dependencies.

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.
subscription_id	string

SELECT examples

get

Get a MapsResource.

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

list_by_resource_group

List MapsResource resources by resource group.

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

list_by_subscription

List MapsResource resources by subscription ID.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.dependency_map.maps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a MapsResource.

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

Manifest

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

UPDATE examples

update

Update a MapsResource.

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

REPLACE examples

create_or_update

Create a MapsResource.

REPLACE azure.dependency_map.maps
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND map_name = '{{ map_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 MapsResource.

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

Lifecycle Methods

get_dependency_view_for_focused_machine

Get dependency map of single machine.

EXEC azure.dependency_map.maps.get_dependency_view_for_focused_machine 
@resource_group_name='{{ resource_group_name }}' --required, 
@map_name='{{ map_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"focusedMachineId": "{{ focusedMachineId }}", 
"filters": "{{ filters }}"
}'
;

get_connections_with_connected_machine_for_focused_machine

Get network connections between machines.

EXEC azure.dependency_map.maps.get_connections_with_connected_machine_for_focused_machine 
@resource_group_name='{{ resource_group_name }}' --required, 
@map_name='{{ map_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"focusedMachineId": "{{ focusedMachineId }}", 
"connectedMachineId": "{{ connectedMachineId }}", 
"filters": "{{ filters }}"
}'
;

get_connections_for_process_on_focused_machine

Get network connections of a process.

EXEC azure.dependency_map.maps.get_connections_for_process_on_focused_machine 
@resource_group_name='{{ resource_group_name }}' --required, 
@map_name='{{ map_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"focusedMachineId": "{{ focusedMachineId }}", 
"processIdOnFocusedMachine": "{{ processIdOnFocusedMachine }}", 
"filters": "{{ filters }}"
}'
;

export_dependencies

Export dependencies.

EXEC azure.dependency_map.maps.export_dependencies 
@resource_group_name='{{ resource_group_name }}' --required, 
@map_name='{{ map_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"focusedMachineId": "{{ focusedMachineId }}", 
"filters": "{{ filters }}"
}'
;