relationships

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

Overview

Name	relationships
Type	Resource
Id	azure.cloud_health.relationships

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.
childEntityName	string	Resource name of the child entity. Required.
discoveredBy	string	Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
displayName	string	Display name.
parentEntityName	string	Resource name of the parent entity. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Optional set of tags (key-value pairs).
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_health_model

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.
childEntityName	string	Resource name of the child entity. Required.
discoveredBy	string	Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
displayName	string	Display name.
parentEntityName	string	Resource name of the parent entity. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Optional set of tags (key-value pairs).
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, health_model_name, relationship_name, subscription_id		Get a Relationship.
list_by_health_model	select	resource_group_name, health_model_name, subscription_id	timestamp	List Relationship resources by HealthModel.
create_or_update	insert	resource_group_name, health_model_name, relationship_name, subscription_id		Create a Relationship.
create_or_update	replace	resource_group_name, health_model_name, relationship_name, subscription_id		Create a Relationship.
delete	delete	resource_group_name, health_model_name, relationship_name, subscription_id		Delete a Relationship.

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
health_model_name	string	Name of health model resource. Required.
relationship_name	string	Name of the relationship. Must be unique within a health model. For example, a concatenation of parentEntityName and childEntityName can be used as the name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
timestamp	string (date-time)	Timestamp to use for the operation. When specified, the version of the resource at this point in time is retrieved. If not specified, the latest version is used. Default value is None.

SELECT examples

get

Get a Relationship.

SELECT
id,
name,
childEntityName,
discoveredBy,
displayName,
parentEntityName,
provisioningState,
systemData,
tags,
type
FROM azure.cloud_health.relationships
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND health_model_name = '{{ health_model_name }}' -- required
AND relationship_name = '{{ relationship_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_health_model

List Relationship resources by HealthModel.

SELECT
id,
name,
childEntityName,
discoveredBy,
displayName,
parentEntityName,
provisioningState,
systemData,
tags,
type
FROM azure.cloud_health.relationships
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND health_model_name = '{{ health_model_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND timestamp = '{{ timestamp }}'
;

INSERT examples

create_or_update

Create a Relationship.

INSERT INTO azure.cloud_health.relationships (
properties,
resource_group_name,
health_model_name,
relationship_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ health_model_name }}',
'{{ relationship_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: relationships
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the relationships resource.
  - name: health_model_name
    value: "{{ health_model_name }}"
    description: Required parameter for the relationships resource.
  - name: relationship_name
    value: "{{ relationship_name }}"
    description: Required parameter for the relationships resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the relationships resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      displayName: "{{ displayName }}"
      parentEntityName: "{{ parentEntityName }}"
      childEntityName: "{{ childEntityName }}"
      tags: "{{ tags }}"
      discoveredBy: "{{ discoveredBy }}"

REPLACE examples

create_or_update

Create a Relationship.

REPLACE azure.cloud_health.relationships
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND health_model_name = '{{ health_model_name }}' --required
AND relationship_name = '{{ relationship_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Relationship.

DELETE FROM azure.cloud_health.relationships
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND health_model_name = '{{ health_model_name }}' --required
AND relationship_name = '{{ relationship_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;