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

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

Bicep 资源定义

可以使用目标操作部署命名空间/客户端资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.EventGrid/namespaces/clients@2023-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: {
      {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    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'
  }
}

属性值

ClientAuthentication

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

ClientCertificateAuthentication

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

ClientCertificateSubjectDistinguishedName

名字 描述 价值
commonName 主题名称中的公用名字段。 允许的限制为 64 个字符,应指定。 字符串

约束:
最大长度 =
countryCode 主题名称中的国家/地区代码字段。 如果存在,则国家/地区代码应由 ISO 2166-1(alpha-2)中定义的双字母代码表示。 例如:“US”。 字符串

约束:
最小长度 = 2
最大长度 = 2
组织 主题名称中的组织字段。 如果存在,则允许的限制为 64 个字符。 字符串

约束:
最大长度 =
organizationUnit 主题名称中的组织单位字段。 如果存在,则允许的限制为 32 个字符。 字符串

约束:
最大长度 =

ClientCertificateThumbprint

名字 描述 价值
主要 用于验证的主要指纹。 字符串
二 次 用于验证的辅助指纹。 字符串

ClientProperties

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

ClientPropertiesAttributes

名字 描述 价值

Microsoft.EventGrid/namespaces/clients

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[-a-zA-Z0-9:\._]*$ (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:命名空间
性能 客户端的属性。 ClientProperties

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

属性值

ClientAuthentication

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

ClientCertificateAuthentication

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

ClientCertificateSubjectDistinguishedName

名字 描述 价值
commonName 主题名称中的公用名字段。 允许的限制为 64 个字符,应指定。 字符串

约束:
最大长度 =
countryCode 主题名称中的国家/地区代码字段。 如果存在,则国家/地区代码应由 ISO 2166-1(alpha-2)中定义的双字母代码表示。 例如:“US”。 字符串

约束:
最小长度 = 2
最大长度 = 2
组织 主题名称中的组织字段。 如果存在,则允许的限制为 64 个字符。 字符串

约束:
最大长度 =
organizationUnit 主题名称中的组织单位字段。 如果存在,则允许的限制为 32 个字符。 字符串

约束:
最大长度 =

ClientCertificateThumbprint

名字 描述 价值
主要 用于验证的主要指纹。 字符串
二 次 用于验证的辅助指纹。 字符串

ClientProperties

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

ClientPropertiesAttributes

名字 描述 价值

Microsoft.EventGrid/namespaces/clients

名字 描述 价值
apiVersion API 版本 '2023-06-01-preview'
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[-a-zA-Z0-9:\._]*$ (必需)
性能 客户端的属性。 ClientProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/clients”

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

可以使用目标操作部署命名空间/客户端资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/clients@2023-06-01-preview"
  name = "string"
  body = jsonencode({
    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"
    }
  })
}

属性值

ClientAuthentication

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

ClientCertificateAuthentication

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

ClientCertificateSubjectDistinguishedName

名字 描述 价值
commonName 主题名称中的公用名字段。 允许的限制为 64 个字符,应指定。 字符串

约束:
最大长度 =
countryCode 主题名称中的国家/地区代码字段。 如果存在,则国家/地区代码应由 ISO 2166-1(alpha-2)中定义的双字母代码表示。 例如:“US”。 字符串

约束:
最小长度 = 2
最大长度 = 2
组织 主题名称中的组织字段。 如果存在,则允许的限制为 64 个字符。 字符串

约束:
最大长度 =
organizationUnit 主题名称中的组织单位字段。 如果存在,则允许的限制为 32 个字符。 字符串

约束:
最大长度 =

ClientCertificateThumbprint

名字 描述 价值
主要 用于验证的主要指纹。 字符串
二 次 用于验证的辅助指纹。 字符串

ClientProperties

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

ClientPropertiesAttributes

名字 描述 价值

Microsoft.EventGrid/namespaces/clients

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1
模式 = ^[-a-zA-Z0-9:\._]*$ (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:命名空间
性能 客户端的属性。 ClientProperties
类型 资源类型 “Microsoft.EventGrid/namespaces/clients@2023-06-01-preview”