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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	The properties of client group.
systemData	object	The system metadata relating to the ClientGroup resource.
type	string	Type of the resource.

list_by_namespace

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	The properties of client group.
systemData	object	The system metadata relating to the ClientGroup resource.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

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

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
clientGroupName	string	Name of the client group.
namespaceName	string	Name of the namespace.
resourceGroupName	string	The name of the resource group within the user's subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.
$top	integer (int32)	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

SELECT examples

get

Get properties of a client group.

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

list_by_namespace

Get all the client groups under a namespace.

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

INSERT examples

create_or_update

Create or update a client group with the specified parameters.

INSERT INTO azure.event_grid.client_groups (
data__properties,
subscriptionId,
resourceGroupName,
namespaceName,
clientGroupName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ clientGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: client_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the client_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the client_groups resource.
    - name: namespaceName
      value: string
      description: Required parameter for the client_groups resource.
    - name: clientGroupName
      value: string
      description: Required parameter for the client_groups resource.
    - name: properties
      value: object
      description: |
        The properties of client group.

DELETE examples

delete

Delete an existing client group.

DELETE FROM azure.event_grid.client_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND clientGroupName = '{{ clientGroupName }}' --required
;