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(...)
}
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 個字元，而且應該指定。 | 字串 約束： 最大長度 = 64 |
| countryCode | 主體名稱中的國家/地區代碼欄位。 如果有的話，國家/地區代碼應該以 ISO 2166-1 （alpha-2） 中定義的兩個字母代碼來表示。 例如：『US』。 | 字串 約束： 最小長度 = 2 最大長度 = 2 |
| 組織 | 主體名稱中的組織欄位。 如果存在，允許的限制為64個字元。 | 字串 約束： 最大長度 = 64 |
| organizationUnit | 主體名稱中的組織單位欄位。 如果存在，允許的限制為32個字元。 | 字串 約束： 最大長度 = 32 |
ClientCertificateThumbprint
| 名字 | 描述 | 價值 |
|---|---|---|
| 主要 | 用於驗證的主要指紋。 | 字串 |
| 二 次 | 用於驗證的次要指紋。 | 字串 |
ClientProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 屬性 | 用戶端的屬性。 支援的值為 int、bool、string、string[]。 例： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] } |
ClientPropertiesAttributes |
| 認證 | 用戶端的驗證資訊。 | ClientAuthentication |
| authenticationName | 用戶端用來驗證的名稱。 預設值是資源的名稱。 | 字串 |
| clientCertificateAuthentication | 用戶端憑證驗證資訊。 | ClientCertificateAuthentication |
| 描述 | 用戶端資源的描述。 | 字串 |
| 州 | 指出用戶端是否已啟用。 預設值為 Enabled。 | 'Disabled' 'Enabled' |
ClientPropertiesAttributes
| 名字 | 描述 | 價值 |
|---|
Microsoft.EventGrid/namespaces/clients
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 128 模式 = ^[-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 個字元，而且應該指定。 | 字串 約束： 最大長度 = 64 |
| countryCode | 主體名稱中的國家/地區代碼欄位。 如果有的話，國家/地區代碼應該以 ISO 2166-1 （alpha-2） 中定義的兩個字母代碼來表示。 例如：『US』。 | 字串 約束： 最小長度 = 2 最大長度 = 2 |
| 組織 | 主體名稱中的組織欄位。 如果存在，允許的限制為64個字元。 | 字串 約束： 最大長度 = 64 |
| organizationUnit | 主體名稱中的組織單位欄位。 如果存在，允許的限制為32個字元。 | 字串 約束： 最大長度 = 32 |
ClientCertificateThumbprint
| 名字 | 描述 | 價值 |
|---|---|---|
| 主要 | 用於驗證的主要指紋。 | 字串 |
| 二 次 | 用於驗證的次要指紋。 | 字串 |
ClientProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 屬性 | 用戶端的屬性。 支援的值為 int、bool、string、string[]。 例： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] } |
ClientPropertiesAttributes |
| 認證 | 用戶端的驗證資訊。 | ClientAuthentication |
| authenticationName | 用戶端用來驗證的名稱。 預設值是資源的名稱。 | 字串 |
| clientCertificateAuthentication | 用戶端憑證驗證資訊。 | ClientCertificateAuthentication |
| 描述 | 用戶端資源的描述。 | 字串 |
| 州 | 指出用戶端是否已啟用。 預設值為 Enabled。 | 'Disabled' 'Enabled' |
ClientPropertiesAttributes
| 名字 | 描述 | 價值 |
|---|
Microsoft.EventGrid/namespaces/clients
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2023-06-01-preview' |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 128 模式 = ^[-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 個字元，而且應該指定。 | 字串 約束： 最大長度 = 64 |
| countryCode | 主體名稱中的國家/地區代碼欄位。 如果有的話，國家/地區代碼應該以 ISO 2166-1 （alpha-2） 中定義的兩個字母代碼來表示。 例如：『US』。 | 字串 約束： 最小長度 = 2 最大長度 = 2 |
| 組織 | 主體名稱中的組織欄位。 如果存在，允許的限制為64個字元。 | 字串 約束： 最大長度 = 64 |
| organizationUnit | 主體名稱中的組織單位欄位。 如果存在，允許的限制為32個字元。 | 字串 約束： 最大長度 = 32 |
ClientCertificateThumbprint
| 名字 | 描述 | 價值 |
|---|---|---|
| 主要 | 用於驗證的主要指紋。 | 字串 |
| 二 次 | 用於驗證的次要指紋。 | 字串 |
ClientProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 屬性 | 用戶端的屬性。 支援的值為 int、bool、string、string[]。 例： “attributes”： { “room”： “345”， “floor”： 12， “deviceTypes”： [“Fan”， “Light”] } |
ClientPropertiesAttributes |
| 認證 | 用戶端的驗證資訊。 | ClientAuthentication |
| authenticationName | 用戶端用來驗證的名稱。 預設值是資源的名稱。 | 字串 |
| clientCertificateAuthentication | 用戶端憑證驗證資訊。 | ClientCertificateAuthentication |
| 描述 | 用戶端資源的描述。 | 字串 |
| 州 | 指出用戶端是否已啟用。 預設值為 Enabled。 | 'Disabled' 'Enabled' |
ClientPropertiesAttributes
| 名字 | 描述 | 價值 |
|---|
Microsoft.EventGrid/namespaces/clients
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 128 模式 = ^[-a-zA-Z0-9:\._]*$ （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：命名空間 |
| 性能 | 用戶端的屬性。 | ClientProperties |
| 類型 | 資源類型 | “Microsoft.EventGrid/namespaces/clients@2023-06-01-preview” |