client_groups

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

Overview

Name	client_groups
Type	Resource
Id	azure.event_grid.client_groups

Fields

vw_client_groups

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
description	text	field from the properties object
clientGroupName	text	field from the properties object
namespaceName	text	field from the properties object
provisioning_state	text	field from the properties object
query	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

client_groups

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The properties of client group.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clientGroupName, namespaceName, resourceGroupName, subscriptionId	Get properties of a client group.
list_by_namespace	SELECT	namespaceName, resourceGroupName, subscriptionId	Get all the client groups under a namespace.
create_or_update	INSERT	clientGroupName, namespaceName, resourceGroupName, subscriptionId	Create or update a client group with the specified parameters.
delete	DELETE	clientGroupName, namespaceName, resourceGroupName, subscriptionId	Delete an existing client group.

SELECT examples

Get all the client groups under a namespace.

vw_client_groups

SELECT
id,
name,
description,
clientGroupName,
namespaceName,
provisioning_state,
query,
resourceGroupName,
subscriptionId,
system_data,
type
FROM azure.event_grid.vw_client_groups
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

client_groups

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.client_groups
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new client_groups resource.

All Properties

/*+ create */
INSERT INTO azure.event_grid.client_groups (
clientGroupName,
namespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ clientGroupName }}',
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: description
          value: string
        - name: query
          value: string
        - name: provisioningState
          value: string

DELETE example

Deletes the specified client_groups resource.

/*+ delete */
DELETE FROM azure.event_grid.client_groups
WHERE clientGroupName = '{{ clientGroupName }}'
AND namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';