service_group_member_relationships

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

Overview

Name	service_group_member_relationships
Type	Resource
Id	azure.relationships.service_group_member_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.
metadata	object	Metadata about the relationship. Required.
originInformation	object	Information about the origin of the relationship. Required.
provisioningState	string	The provisioning state of the relationship. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
sourceId	string	The relationship source resource id. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetId	string	The relationship target resource id. Required.
targetTenant	string	The relationship target tenant id.
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, name		Get a ServiceGroupMemberRelationship.
create_or_update	insert	resource_uri, name		Create a ServiceGroupMemberRelationship.
create_or_update	replace	resource_uri, name		Create a ServiceGroupMemberRelationship.
delete	delete	resource_uri, name		Delete a ServiceGroupMemberRelationship.

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
name	string	Name of ServiceGroupMember relationship. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get a ServiceGroupMemberRelationship.

SELECT
id,
name,
metadata,
originInformation,
provisioningState,
sourceId,
systemData,
targetId,
targetTenant,
type
FROM azure.relationships.service_group_member_relationships
WHERE resource_uri = '{{ resource_uri }}' -- required
AND name = '{{ name }}' -- required
;

INSERT examples

create_or_update

Create a ServiceGroupMemberRelationship.

INSERT INTO azure.relationships.service_group_member_relationships (
properties,
resource_uri,
name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: service_group_member_relationships
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the service_group_member_relationships resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the service_group_member_relationships resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      sourceId: "{{ sourceId }}"
      targetId: "{{ targetId }}"
      targetTenant: "{{ targetTenant }}"
      originInformation:
        relationshipOriginType: "{{ relationshipOriginType }}"
        discoveryEngine: "{{ discoveryEngine }}"
      metadata:
        sourceType: "{{ sourceType }}"
        targetType: "{{ targetType }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create a ServiceGroupMemberRelationship.

REPLACE azure.relationships.service_group_member_relationships
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND name = '{{ name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a ServiceGroupMemberRelationship.

DELETE FROM azure.relationships.service_group_member_relationships
WHERE resource_uri = '{{ resource_uri }}' --required
AND name = '{{ name }}' --required
;