Share via

Microsoft.EventGrid namespaces/clients 2023-12-15-preview

  • Article

Bicep resource definition

The namespaces/clients resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/namespaces/clients resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.EventGrid/namespaces/clients@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    attributes: {
      {customized property}: any()
    }
    authenticationName: 'string'
    clientCertificateAuthentication: {
      allowedThumbprints: [
        'string'
      ]
      validationScheme: 'string'
    }
    description: 'string'
    state: 'string'
  }
}

Property values

namespaces/clients

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: namespaces
properties The properties of client. ClientProperties

ClientProperties

Name Description Value
attributes Attributes for the client. Supported values are int, bool, string, string[].
Example:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authenticationName The name presented by the client for authentication. The default value is the name of the resource. string
clientCertificateAuthentication The client certificate authentication information. ClientCertificateAuthentication
description Description for the Client resource. string
state Indicates if the client is enabled or not. Default value is Enabled. 'Disabled'
'Enabled'

ClientPropertiesAttributes

Name Description Value
{customized property} For Bicep, you can use the any() function.

ClientCertificateAuthentication

Name Description Value
allowedThumbprints The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. string[]
validationScheme The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. 'DnsMatchesAuthenticationName'
'EmailMatchesAuthenticationName'
'IpMatchesAuthenticationName'
'SubjectMatchesAuthenticationName'
'ThumbprintMatch'
'UriMatchesAuthenticationName'

ARM template resource definition

The namespaces/clients resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/namespaces/clients resource, add the following JSON to your template.

{
  "type": "Microsoft.EventGrid/namespaces/clients",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "attributes": {
      "{customized property}": {}
    },
    "authenticationName": "string",
    "clientCertificateAuthentication": {
      "allowedThumbprints": [ "string" ],
      "validationScheme": "string"
    },
    "description": "string",
    "state": "string"
  }
}

Property values

namespaces/clients

Name Description Value
type The resource type 'Microsoft.EventGrid/namespaces/clients'
apiVersion The resource api version '2023-12-15-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The properties of client. ClientProperties

ClientProperties

Name Description Value
attributes Attributes for the client. Supported values are int, bool, string, string[].
Example:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authenticationName The name presented by the client for authentication. The default value is the name of the resource. string
clientCertificateAuthentication The client certificate authentication information. ClientCertificateAuthentication
description Description for the Client resource. string
state Indicates if the client is enabled or not. Default value is Enabled. 'Disabled'
'Enabled'

ClientPropertiesAttributes

Name Description Value
{customized property}

ClientCertificateAuthentication

Name Description Value
allowedThumbprints The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. string[]
validationScheme The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. 'DnsMatchesAuthenticationName'
'EmailMatchesAuthenticationName'
'IpMatchesAuthenticationName'
'SubjectMatchesAuthenticationName'
'ThumbprintMatch'
'UriMatchesAuthenticationName'

Terraform (AzAPI provider) resource definition

The namespaces/clients resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.EventGrid/namespaces/clients resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/clients@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      attributes = {}
      authenticationName = "string"
      clientCertificateAuthentication = {
        allowedThumbprints = [
          "string"
        ]
        validationScheme = "string"
      }
      description = "string"
      state = "string"
    }
  })
}

Property values

namespaces/clients

Name Description Value
type The resource type "Microsoft.EventGrid/namespaces/clients@2023-12-15-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties The properties of client. ClientProperties

ClientProperties

Name Description Value
attributes Attributes for the client. Supported values are int, bool, string, string[].
Example:
"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }		 ClientPropertiesAttributes
authenticationName The name presented by the client for authentication. The default value is the name of the resource. string
clientCertificateAuthentication The client certificate authentication information. ClientCertificateAuthentication
description Description for the Client resource. string
state Indicates if the client is enabled or not. Default value is Enabled. "Disabled"
"Enabled"

ClientPropertiesAttributes

Name Description Value
{customized property}

ClientCertificateAuthentication

Name Description Value
allowedThumbprints The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. string[]
validationScheme The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. "DnsMatchesAuthenticationName"
"EmailMatchesAuthenticationName"
"IpMatchesAuthenticationName"
"SubjectMatchesAuthenticationName"
"ThumbprintMatch"
"UriMatchesAuthenticationName"