Microsoft.EventGrid 名前空間/クライアント 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 で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
型のリソースのシンボル名: 名前空間 |
| properties | クライアントのプロパティ。 | ClientProperties |
ClientProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 属性 | クライアントの属性。 サポートされている値は、int、bool、string、string[]です。 例: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } |
ClientPropertiesAttributes |
| 認証 | クライアントの認証情報。 | ClientAuthentication |
| authenticationName | 認証用にクライアントによって表示される名前。 既定値はリソースの名前です。 | string |
| clientCertificateAuthentication | クライアント証明書の認証情報。 | ClientCertificateAuthentication |
| description | クライアント リソースの説明。 | string |
| state | クライアントが有効かどうかを示します。 既定値は [有効] です。 | 'Disabled' 'Enabled' |
ClientPropertiesAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Bicep の場合は、 any() 関数を使用できます。 |
ClientAuthentication
| 名前 | 説明 | 値 |
|---|---|---|
| certificateSubject | 認証に使用される CA 証明書のサブジェクト名。 | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | 認証に使用される自己署名証明書の拇印データ。 | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| 名前 | 説明 | 値 |
|---|---|---|
| commonName | サブジェクト名の共通名フィールド。 使用できる制限は 64 文字で、指定する必要があります。 | string 制約: 最大長 = 64 |
| countryCode | サブジェクト名の国コード フィールド。 存在する場合、国コードは ISO 2166-1 (alpha-2) で定義された 2 文字のコードで表す必要があります。 たとえば、'US' です。 | string 制約: 最小長 = 2 最大長 = 2 |
| organization | サブジェクト名のorganization フィールド。 存在する場合、使用できる制限は 64 文字です。 | string 制約: 最大長 = 64 |
| organizationUnit | サブジェクト名のorganization単位フィールド。 存在する場合、使用できる制限は 32 文字です。 | string 制約: 最大長 = 32 |
ClientCertificateThumbprint
| 名前 | 説明 | 値 |
|---|---|---|
| 更新 | 検証に使用されるプライマリ拇印。 | string |
| レプリケートされる | 検証に使用されるセカンダリ拇印。 | 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
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.EventGrid/namespaces/clients' |
| apiVersion | リソース API のバージョン | '2023-06-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| properties | クライアントのプロパティ。 | ClientProperties |
ClientProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 属性 | クライアントの属性。 サポートされている値は、int、bool、string、string[]です。 例: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } |
ClientPropertiesAttributes |
| 認証 | クライアントの認証情報。 | ClientAuthentication |
| authenticationName | 認証用にクライアントによって表示される名前。 既定値はリソースの名前です。 | string |
| clientCertificateAuthentication | クライアント証明書の認証情報。 | ClientCertificateAuthentication |
| description | クライアント リソースの説明。 | string |
| state | クライアントが有効かどうかを示します。 既定値は [有効] です。 | 'Disabled' 'Enabled' |
ClientPropertiesAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} |
ClientAuthentication
| 名前 | 説明 | 値 |
|---|---|---|
| certificateSubject | 認証に使用される CA 証明書のサブジェクト名。 | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | 認証に使用される自己署名証明書の拇印データ。 | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| 名前 | 説明 | 値 |
|---|---|---|
| commonName | サブジェクト名の共通名フィールド。 使用できる制限は 64 文字で、指定する必要があります。 | string 制約: 最大長 = 64 |
| countryCode | サブジェクト名の国コード フィールド。 存在する場合は、ISO 2166-1 (alpha-2) で定義された 2 文字のコードで国コードを表す必要があります。 たとえば、'US' です。 | string 制約: 最小長 = 2 最大長 = 2 |
| organization | サブジェクト名のorganization フィールド。 存在する場合、許可される制限は 64 文字です。 | string 制約: 最大長 = 64 |
| organizationUnit | サブジェクト名のorganization単位フィールド。 存在する場合、許可される制限は 32 文字です。 | string 制約: 最大長 = 32 |
ClientCertificateThumbprint
| 名前 | 説明 | 値 |
|---|---|---|
| 更新 | 検証に使用される主な拇印。 | string |
| レプリケートされる | 検証に使用されるセカンダリ拇印。 | 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
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.EventGrid/namespaces/clients@2023-06-01-preview" |
| name | リソース名 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 型のリソースの ID: 名前空間 |
| properties | クライアントのプロパティ。 | ClientProperties |
ClientProperties
| 名前 | 説明 | 値 |
|---|---|---|
| 属性 | クライアントの属性。 サポートされている値は、int、bool、string、string[]です。 例: "attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] } |
ClientPropertiesAttributes |
| 認証 | クライアントの認証情報。 | ClientAuthentication |
| authenticationName | 認証のためにクライアントによって提示される名前。 既定値はリソースの名前です。 | string |
| clientCertificateAuthentication | クライアント証明書の認証情報。 | ClientCertificateAuthentication |
| description | クライアント リソースの説明。 | string |
| state | クライアントが有効かどうかを示します。 既定値は [有効] です。 | "無効" "有効" |
ClientPropertiesAttributes
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} |
ClientAuthentication
| 名前 | 説明 | 値 |
|---|---|---|
| certificateSubject | 認証に使用される CA 証明書のサブジェクト名。 | ClientCertificateSubjectDistinguishedName |
| certificateThumbprint | 認証に使用される自己署名証明書の拇印データ。 | ClientCertificateThumbprint |
ClientCertificateSubjectDistinguishedName
| 名前 | 説明 | 値 |
|---|---|---|
| commonName | サブジェクト名の共通名フィールド。 使用できる制限は 64 文字で、指定する必要があります。 | string 制約: 最大長 = 64 |
| countryCode | サブジェクト名の国コード フィールド。 存在する場合は、ISO 2166-1 (alpha-2) で定義された 2 文字のコードで国コードを表す必要があります。 たとえば、'US' です。 | string 制約: 最小長 = 2 最大長 = 2 |
| organization | サブジェクト名のorganization フィールド。 存在する場合、許可される制限は 64 文字です。 | string 制約: 最大長 = 64 |
| organizationUnit | サブジェクト名のorganization単位フィールド。 存在する場合、許可される制限は 32 文字です。 | string 制約: 最大長 = 32 |
ClientCertificateThumbprint
| 名前 | 説明 | 値 |
|---|---|---|
| 更新 | 検証に使用される主な拇印。 | string |
| レプリケートされる | 検証に使用されるセカンダリ拇印。 | string |
ClientCertificateAuthentication
| 名前 | 説明 | 値 |
|---|---|---|
| allowedThumbprints | クライアント認証中に許可される拇印の一覧。 このプロパティは、validationScheme が 'ThumbprintMatch' の場合にのみ必要です。 | string[] |
| validationScheme | クライアントの認証に使用される検証スキーム。 既定値は SubjectMatchesAuthenticationName です。 | "DnsMatchesAuthenticationName" "EmailMatchesAuthenticationName" "IpMatchesAuthenticationName" "SubjectMatchesAuthenticationName" "ThumbprintMatch" "UriMatchesAuthenticationName" |