clients

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

Overview

Name	clients
Type	Resource
Id	azure.event_grid.clients

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.
attributes	object	Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }.
authenticationName	string	The name presented by the client for authentication. The default value is the name of the resource.
clientCertificateAuthentication	object	The client certificate authentication information.
description	string	Description for the Client resource.
provisioningState	string	Provisioning state of the Client resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "Deleted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted)
state	string	Indicates if the client is enabled or not. Default value is Enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_namespace

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.
attributes	object	Attributes for the client. Supported values are int, bool, string, string[]. Example: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }.
authenticationName	string	The name presented by the client for authentication. The default value is the name of the resource.
clientCertificateAuthentication	object	The client certificate authentication information.
description	string	Description for the Client resource.
provisioningState	string	Provisioning state of the Client resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "Deleted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted)
state	string	Indicates if the client is enabled or not. Default value is Enabled. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, namespace_name, client_name, subscription_id		Get a client. Get properties of a client.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id	$filter, $top	List all permission bindings under a namespace. Get all the permission bindings under a namespace.
create_or_update	insert	resource_group_name, namespace_name, client_name, subscription_id		Create or update a client. Create or update a client with the specified parameters.
create_or_update	replace	resource_group_name, namespace_name, client_name, subscription_id		Create or update a client. Create or update a client with the specified parameters.
delete	delete	resource_group_name, namespace_name, client_name, subscription_id		Delete a client. Delete an existing client.

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
client_name	string	Name of the client. Required.
namespace_name	string	Name of the namespace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$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'. Default value is None.
$top	integer	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. Default value is None.

SELECT examples

get

Get a client. Get properties of a client.

SELECT
id,
name,
attributes,
authenticationName,
clientCertificateAuthentication,
description,
provisioningState,
state,
systemData,
type
FROM azure.event_grid.clients
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND client_name = '{{ client_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

List all permission bindings under a namespace. Get all the permission bindings under a namespace.

SELECT
id,
name,
attributes,
authenticationName,
clientCertificateAuthentication,
description,
provisioningState,
state,
systemData,
type
FROM azure.event_grid.clients
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a client. Create or update a client with the specified parameters.

INSERT INTO azure.event_grid.clients (
properties,
resource_group_name,
namespace_name,
client_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ client_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: clients
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the clients resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the clients resource.
  - name: client_name
    value: "{{ client_name }}"
    description: Required parameter for the clients resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the clients resource.
  - name: properties
    description: |
      The properties of client.
    value:
      description: "{{ description }}"
      authenticationName: "{{ authenticationName }}"
      clientCertificateAuthentication:
        validationScheme: "{{ validationScheme }}"
        allowedThumbprints:
          - "{{ allowedThumbprints }}"
      state: "{{ state }}"
      attributes: "{{ attributes }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create or update a client. Create or update a client with the specified parameters.

REPLACE azure.event_grid.clients
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND client_name = '{{ client_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a client. Delete an existing client.

DELETE FROM azure.event_grid.clients
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND client_name = '{{ client_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;