clients

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

Overview

Name	clients
Type	Resource
Id	azure.event_grid.clients

Fields

vw_clients

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
attributes	text	field from the properties object
authentication_name	text	field from the properties object
clientName	text	field from the properties object
client_certificate_authentication	text	field from the properties object
namespaceName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
state	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"

clients

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.
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	clientName, namespaceName, resourceGroupName, subscriptionId	Get properties of a client.
list_by_namespace	SELECT	namespaceName, resourceGroupName, subscriptionId	Get all the permission bindings under a namespace.
create_or_update	INSERT	clientName, namespaceName, resourceGroupName, subscriptionId	Create or update a client with the specified parameters.
delete	DELETE	clientName, namespaceName, resourceGroupName, subscriptionId	Delete an existing client.

SELECT examples

Get all the permission bindings under a namespace.

vw_clients

SELECT
id,
name,
description,
attributes,
authentication_name,
clientName,
client_certificate_authentication,
namespaceName,
provisioning_state,
resourceGroupName,
state,
subscriptionId,
system_data,
type
FROM azure.event_grid.vw_clients
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

clients

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.event_grid.clients (
clientName,
namespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ clientName }}',
'{{ 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: authenticationName
          value: string
        - name: clientCertificateAuthentication
          value:
            - name: validationScheme
              value: string
            - name: allowedThumbprints
              value:
                - string
        - name: state
          value: string
        - name: attributes
          value: object
        - name: provisioningState
          value: string

DELETE example

Deletes the specified clients resource.

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