Microsoft.EventGrid partnerTopics
Bicep リソース定義
partnerTopics リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/partnerTopics@2023-12-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
activationState: 'string'
eventTypeInfo: {
inlineEventTypes: {
{customized property}: {
dataSchemaUrl: 'string'
description: 'string'
displayName: 'string'
documentationUrl: 'string'
}
}
kind: 'Inline'
}
expirationTimeIfNotActivatedUtc: 'string'
messageForActivation: 'string'
partnerRegistrationImmutableId: 'string'
partnerTopicFriendlyDescription: 'string'
source: 'string'
}
}
プロパティ値
partnerTopics
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) |
location | リソースの場所。 | string (必須) |
tags | リソースのタグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
identity | パートナー トピック リソースの ID 情報。 | IdentityInfo |
properties | パートナー トピックのプロパティ。 | PartnerTopicProperties |
IdentityInfo
名前 | 説明 | 値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | string |
tenantId | リソースのテナント ID。 | string |
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | 'None' 'SystemAssigned' 'SystemAssigned、UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' このプロパティは現在使用されておらず、今後の使用のために予約されています。 |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
名前 | 説明 | 値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | string |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
PartnerTopicProperties
名前 | 説明 | 値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | 'Activated' '非アクティブ化' 'NeverActivated' |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
string |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 | string |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、発行元/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを取り除くために役立ちます。 |
string |
source | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | string |
EventTypeInfo
名前 | 説明 | 値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
kind | 使用されるイベントの種類。 | 'Inline' |
EventTypeInfoInlineEventTypes
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | InlineEventProperties |
InlineEventProperties
名前 | 説明 | 値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | string |
description | インライン イベントの説明。 | string |
displayName | インライン イベントの displayName。 | string |
documentationUrl | インライン イベントの documentationUrl。 | string |
ARM テンプレート リソース定義
partnerTopics リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/partnerTopics",
"apiVersion": "2023-12-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"activationState": "string",
"eventTypeInfo": {
"inlineEventTypes": {
"{customized property}": {
"dataSchemaUrl": "string",
"description": "string",
"displayName": "string",
"documentationUrl": "string"
}
},
"kind": "Inline"
},
"expirationTimeIfNotActivatedUtc": "string",
"messageForActivation": "string",
"partnerRegistrationImmutableId": "string",
"partnerTopicFriendlyDescription": "string",
"source": "string"
}
}
プロパティ値
partnerTopics
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.EventGrid/partnerTopics' |
apiVersion | リソース API のバージョン | '2023-12-15-preview' |
name | リソース名 | string (必須) |
location | リソースの場所。 | string (必須) |
tags | リソースのタグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
identity | パートナー トピック リソースの ID 情報。 | IdentityInfo |
properties | パートナー トピックのプロパティ。 | PartnerTopicProperties |
IdentityInfo
名前 | 説明 | 値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | string |
tenantId | リソースのテナント ID。 | string |
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' このプロパティは現在使用されておらず、今後の使用のために予約されています。 |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
名前 | 説明 | 値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | string |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
PartnerTopicProperties
名前 | 説明 | 値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | 'Activated' '非アクティブ化' 'NeverActivated' |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
string |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 | string |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、発行元/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを解消するのに役立ちます。 |
string |
source | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | string |
EventTypeInfo
名前 | 説明 | 値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
kind | 使用されるイベントの種類。 | 'Inline' |
EventTypeInfoInlineEventTypes
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | InlineEventProperties |
InlineEventProperties
名前 | 説明 | 値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | string |
description | インライン イベントの説明。 | string |
displayName | インライン イベントの displayName。 | string |
documentationUrl | インライン イベントの documentationUrl。 | string |
Terraform (AzAPI プロバイダー) リソース定義
partnerTopics リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/partnerTopics@2023-12-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
activationState = "string"
eventTypeInfo = {
inlineEventTypes = {
{customized property} = {
dataSchemaUrl = "string"
description = "string"
displayName = "string"
documentationUrl = "string"
}
}
kind = "Inline"
}
expirationTimeIfNotActivatedUtc = "string"
messageForActivation = "string"
partnerRegistrationImmutableId = "string"
partnerTopicFriendlyDescription = "string"
source = "string"
}
})
}
プロパティ値
partnerTopics
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.EventGrid/partnerTopics@2023-12-15-preview" |
name | リソース名 | string (必須) |
location | リソースの場所。 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソースのタグ。 | タグ名と値のディクショナリ。 |
identity | パートナー トピック リソースの ID 情報。 | IdentityInfo |
properties | パートナー トピックのプロパティ。 | PartnerTopicProperties |
IdentityInfo
名前 | 説明 | 値 |
---|---|---|
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | "SystemAssigned" "SystemAssigned、UserAssigned" "UserAssigned" |
identity_ids | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' このプロパティは現在使用されておらず、将来の使用のために予約されています。 |
ユーザー ID ID の配列。 |
IdentityInfoUserAssignedIdentities
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | UserIdentityProperties |
UserIdentityProperties
名前 | 説明 | 値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | string |
principalId | ユーザー割り当て ID のプリンシパル ID。 | string |
PartnerTopicProperties
名前 | 説明 | 値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | "アクティブ化済み" "非アクティブ化" "NeverActivated" |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
string |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 | string |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、発行元/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを取り除くために役立ちます。 |
string |
source | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | string |
EventTypeInfo
名前 | 説明 | 値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
kind | 使用されるイベントの種類。 | "インライン" |
EventTypeInfoInlineEventTypes
名前 | 説明 | 値 |
---|---|---|
{カスタマイズされたプロパティ} | InlineEventProperties |
InlineEventProperties
名前 | 説明 | 値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | string |
description | インライン イベントの説明。 | string |
displayName | インライン イベントの displayName。 | string |
documentationUrl | インライン イベントの documentationUrl。 | string |