你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.EventGrid 命名空间/客户端 2023-06-01-preview

• 最新
• 2023-12-15-preview
• 2023-06-01-preview

Bicep 资源定义

命名空间/客户端资源类型可以使用面向以下对象的操作进行部署：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.EventGrid/namespaces/clients 资源，请将以下 Bicep 添加到模板。

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'
  }
}

属性值

namespaces/clients

名称	说明	值
name	资源名称 了解如何在 Bicep 中设置子资源的名称和类型。	字符串 (必需)
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。	类型为：命名空间的资源的符号名称
properties	客户端的属性。	ClientProperties

ClientProperties

名称	说明	值
attributes	客户端的属性。 支持的值为 int、bool、string、string[]。 例如： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] }	ClientPropertiesAttributes
身份验证	客户端的身份验证信息。	ClientAuthentication
authenticationName	客户端提供用于身份验证的名称。 默认值为资源的名称。	string
clientCertificateAuthentication	客户端证书身份验证信息。	ClientCertificateAuthentication
description	客户端资源的说明。	string
state	指示客户端是否已启用。 默认值为 Enabled。	'Disabled' 'Enabled'

ClientPropertiesAttributes

名称	说明	值
{customized property}		对于 Bicep，可以使用 any () 函数。

ClientAuthentication

名称	说明	值
certificateSubject	用于身份验证的 CA 证书使用者名称。	ClientCertificateSubjectDistinguishedName
certificateThumbprint	用于身份验证的自签名证书指纹数据。	ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

名称	说明	值
CommonName	使用者名称中的公用名字段。 允许的限制为 64 个字符，应指定它。	字符串 约束： 最大长度 = 64
countryCode	使用者名称中的国家/地区代码字段。 如果存在，则国家/地区代码应由 ISO 2166-1 (alpha-2) 中定义的双字母代码表示。 例如：“US”。	字符串 约束： 最小长度 = 2 最大长度 = 2
organization	使用者名称中的组织字段。 如果存在，允许的限制为 64 个字符。	字符串 约束： 最大长度 = 64
organizationUnit	使用者名称中的组织单位字段。 如果存在，则允许的限制为 32 个字符。	字符串 约束： 最大长度 = 32

ClientCertificateThumbprint

名称	说明	值
角色实体	用于验证的主指纹。	字符串
次要区域。	用于验证的辅助指纹。	string

ClientCertificateAuthentication

名称	说明	值
allowedThumbprints	客户端身份验证期间允许的指纹列表。 仅当 validationScheme 为“ThumbprintMatch”时，才需要此属性。	string[]
validationScheme	用于对客户端进行身份验证的验证方案。 默认值为 SubjectMatchesAuthenticationName。	'DnsMatchesAuthenticationName' 'EmailMatchesAuthenticationName' 'IpMatchesAuthenticationName' “SubjectMatchesAuthenticationName” 'ThumbprintMatch' “UriMatchesAuthenticationName”

ARM 模板资源定义

命名空间/客户端资源类型可以使用面向以下对象的操作进行部署：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.EventGrid/namespaces/clients 资源，请将以下 JSON 添加到模板。

{
  "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"
  }
}

属性值

namespaces/clients

名称	说明	Value
type	资源类型	'Microsoft.EventGrid/namespaces/clients'
apiVersion	资源 API 版本	'2023-06-01-preview'
name	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	字符串 (必需)
properties	客户端的属性。	ClientProperties

ClientProperties

名称	说明	值
attributes	客户端的属性。 支持的值为 int、bool、string、string[]。 例如： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] }	ClientPropertiesAttributes
身份验证	客户端的身份验证信息。	ClientAuthentication
authenticationName	客户端提供用于身份验证的名称。 默认值为资源的名称。	字符串
clientCertificateAuthentication	客户端证书身份验证信息。	ClientCertificateAuthentication
description	客户端资源的说明。	string
state	指示客户端是否已启用。 默认值为 Enabled。	'Disabled' 'Enabled'

ClientPropertiesAttributes

名称	说明	值
{customized property}

ClientAuthentication

名称	说明	值
certificateSubject	用于身份验证的 CA 证书使用者名称。	ClientCertificateSubjectDistinguishedName
certificateThumbprint	用于身份验证的自签名证书指纹数据。	ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

名称	说明	值
CommonName	使用者名称中的公用名字段。 允许的限制为 64 个字符，应指定该限制。	字符串 约束： 最大长度 = 64
countryCode	使用者名称中的国家/地区代码字段。 如果存在，国家/地区代码应由 ISO 2166-1 (alpha-2) 中定义的双字母代码表示。 例如：“US”。	string 约束： 最小长度 = 2 最大长度 = 2
organization	使用者名称中的组织字段。 如果存在，则允许的限制为 64 个字符。	string 约束： 最大长度 = 64
organizationUnit	使用者名称中的组织单位字段。 如果存在，则允许的限制为 32 个字符。	字符串 约束： 最大长度 = 32

ClientCertificateThumbprint

名称	说明	值
角色实体	用于验证的主要指纹。	字符串
次要区域。	用于验证的辅助指纹。	string

ClientCertificateAuthentication

名称	说明	值
allowedThumbprints	客户端身份验证期间允许的指纹列表。 仅当 validationScheme 为“ThumbprintMatch”时，才需要此属性。	string[]
validationScheme	用于对客户端进行身份验证的验证方案。 默认值为 SubjectMatchesAuthenticationName。	“DnsMatchesAuthenticationName” “EmailMatchesAuthenticationName” “IpMatchesAuthenticationName” “SubjectMatchesAuthenticationName” “ThumbprintMatch” “UriMatchesAuthenticationName”

Terraform (AzAPI 提供程序) 资源定义

命名空间/客户端资源类型可以使用面向以下对象的操作进行部署：

• 资源组

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.EventGrid/namespaces/clients 资源，请将以下 Terraform 添加到模板。

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"
    }
  })
}

属性值

namespaces/clients

名称	说明	Value
type	资源类型	“Microsoft.EventGrid/namespaces/clients@2023-06-01-preview”
name	资源名称	字符串 (必需)
parent_id	此资源的父资源 ID。	类型为资源的 ID： 命名空间
properties	客户端的属性。	ClientProperties

ClientProperties

名称	说明	值
attributes	客户端的属性。 支持的值为 int、bool、string、string[]。 例如： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] }	ClientPropertiesAttributes
身份验证	客户端的身份验证信息。	ClientAuthentication
authenticationName	客户端提供的用于身份验证的名称。 默认值为资源的名称。	字符串
clientCertificateAuthentication	客户端证书身份验证信息。	ClientCertificateAuthentication
description	客户端资源的说明。	string
state	指示客户端是否已启用。 默认值为 Enabled。	“Disabled” “Enabled”

ClientPropertiesAttributes

名称	说明	值
{customized property}

ClientAuthentication

名称	说明	值
certificateSubject	用于身份验证的 CA 证书使用者名称。	ClientCertificateSubjectDistinguishedName
certificateThumbprint	用于身份验证的自签名证书指纹数据。	ClientCertificateThumbprint

ClientCertificateSubjectDistinguishedName

名称	说明	值
CommonName	使用者名称中的公用名字段。 允许的限制为 64 个字符，应指定它。	string 约束： 最大长度 = 64
countryCode	使用者名称中的国家/地区代码字段。 如果存在，则国家/地区代码应由 ISO 2166-1 (alpha-2) 中定义的双字母代码表示。 例如：“US”。	字符串 约束： 最小长度 = 2 最大长度 = 2
organization	使用者名称中的组织字段。 如果存在，允许的限制为 64 个字符。	string 约束： 最大长度 = 64
organizationUnit	使用者名称中的组织单位字段。 如果存在，则允许的限制为 32 个字符。	字符串 约束： 最大长度 = 32

ClientCertificateThumbprint

名称	说明	值
角色实体	用于验证的主指纹。	字符串
次要区域。	用于验证的辅助指纹。	字符串

ClientCertificateAuthentication

名称	说明	值
allowedThumbprints	客户端身份验证期间允许的指纹列表。 仅当 validationScheme 为“ThumbprintMatch”时，才需要此属性。	string[]
validationScheme	用于对客户端进行身份验证的验证方案。 默认值为 SubjectMatchesAuthenticationName。	“DnsMatchesAuthenticationName” “EmailMatchesAuthenticationName” “IpMatchesAuthenticationName” “SubjectMatchesAuthenticationName” “ThumbprintMatch” “UriMatchesAuthenticationName”