Microsoft.EventGrid namespaces/clients 2023-06-01-preview
Bicep resource definition
The namespaces/clients resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-06-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
attributes: {
{customized property}: any()
}
authentication: {
certificateSubject: {
commonName: 'string'
countryCode: 'string'
organization: 'string'
organizationUnit: 'string'
}
certificateThumbprint: {
primary: 'string'
secondary: 'string'
}
}
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 |
| authentication | Authentication information for the client. | ClientAuthentication |
| 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. |
ClientAuthentication
| Name | Description | Value |
|---|---|---|
| certificateSubject | The CA certificate subject name used for authentication. | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | The self signed certificate's thumbprints data used for authentication. | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| Name | Description | Value |
|---|---|---|
| commonName | The common name field in the subject name. The allowed limit is 64 characters and it should be specified. | string Constraints: Max length = 64 |
| countryCode | The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'. | string Constraints: Min length = 2 Max length = 2 |
| organization | The organization field in the subject name. If present, the allowed limit is 64 characters. | string Constraints: Max length = 64 |
| organizationUnit | The organization unit field in the subject name. If present, the allowed limit is 32 characters. | string Constraints: Max length = 32 |
ClientCertificateThumbprint
| Name | Description | Value |
|---|---|---|
| primary | The primary thumbprint used for validation. | string |
| secondary | The secondary thumbprint used for validation. | string |
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:
- Resource groups - See resource group deployment commands
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-06-01-preview",
"name": "string",
"properties": {
"attributes": {
"{customized property}": {}
},
"authentication": {
"certificateSubject": {
"commonName": "string",
"countryCode": "string",
"organization": "string",
"organizationUnit": "string"
},
"certificateThumbprint": {
"primary": "string",
"secondary": "string"
}
},
"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-06-01-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 |
| authentication | Authentication information for the client. | ClientAuthentication |
| 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} |
ClientAuthentication
| Name | Description | Value |
|---|---|---|
| certificateSubject | The CA certificate subject name used for authentication. | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | The self signed certificate's thumbprints data used for authentication. | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| Name | Description | Value |
|---|---|---|
| commonName | The common name field in the subject name. The allowed limit is 64 characters and it should be specified. | string Constraints: Max length = 64 |
| countryCode | The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'. | string Constraints: Min length = 2 Max length = 2 |
| organization | The organization field in the subject name. If present, the allowed limit is 64 characters. | string Constraints: Max length = 64 |
| organizationUnit | The organization unit field in the subject name. If present, the allowed limit is 32 characters. | string Constraints: Max length = 32 |
ClientCertificateThumbprint
| Name | Description | Value |
|---|---|---|
| primary | The primary thumbprint used for validation. | string |
| secondary | The secondary thumbprint used for validation. | string |
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-06-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
attributes = {}
authentication = {
certificateSubject = {
commonName = "string"
countryCode = "string"
organization = "string"
organizationUnit = "string"
}
certificateThumbprint = {
primary = "string"
secondary = "string"
}
}
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-06-01-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 |
| authentication | Authentication information for the client. | ClientAuthentication |
| 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} |
ClientAuthentication
| Name | Description | Value |
|---|---|---|
| certificateSubject | The CA certificate subject name used for authentication. | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | The self signed certificate's thumbprints data used for authentication. | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| Name | Description | Value |
|---|---|---|
| commonName | The common name field in the subject name. The allowed limit is 64 characters and it should be specified. | string Constraints: Max length = 64 |
| countryCode | The country code field in the subject name. If present, the country code should be represented by two-letter code defined in ISO 2166-1 (alpha-2). For example: 'US'. | string Constraints: Min length = 2 Max length = 2 |
| organization | The organization field in the subject name. If present, the allowed limit is 64 characters. | string Constraints: Max length = 64 |
| organizationUnit | The organization unit field in the subject name. If present, the allowed limit is 32 characters. | string Constraints: Max length = 32 |
ClientCertificateThumbprint
| Name | Description | Value |
|---|---|---|
| primary | The primary thumbprint used for validation. | string |
| secondary | The secondary thumbprint used for validation. | string |
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" |