Microsoft.EventGrid partnerTopics 2023-12-15-preview
Bicep リソース定義
partnerTopics リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/partnerTopics@2023-12-15-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
activationState: 'string'
eventTypeInfo: {
inlineEventTypes: {
{customized property}: {
dataSchemaUrl: 'string'
description: 'string'
displayName: 'string'
documentationUrl: 'string'
}
}
kind: 'string'
}
expirationTimeIfNotActivatedUtc: 'string'
messageForActivation: 'string'
partnerRegistrationImmutableId: 'string'
partnerTopicFriendlyDescription: 'string'
source: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
EventTypeInfo
名前 | 形容 | 価値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す文字列型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベント型の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
種類 | 使用されるイベントの種類。 | 'Inline' |
EventTypeInfoInlineEventTypes
名前 | 形容 | 価値 |
---|
IdentityInfo
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | 使用されるマネージド 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
名前 | 形容 | 価値 |
---|
InlineEventProperties
名前 | 形容 | 価値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | 糸 |
形容 | インライン イベントの説明。 | 糸 |
displayName | インライン イベントの displayName。 | 糸 |
documentationUrl | インライン イベントの documentationUrl。 | 糸 |
Microsoft.EventGrid/partnerTopics
名前 | 形容 | 価値 |
---|---|---|
同一性 | パートナー トピック リソースの ID 情報。 | IdentityInfo の |
場所 | リソースの場所。 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | パートナー トピックのプロパティ。 | PartnerTopicProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
PartnerTopicProperties
名前 | 形容 | 価値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | 'Activated' '非アクティブ' 'NeverActivated' |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
糸 |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役に立つメッセージ。 | 糸 |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、パブリッシャー/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを解消するのに役立ちます。 |
糸 |
源 | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て ID のプリンシパル ID。 | 糸 |
ARM テンプレート リソース定義
partnerTopics リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/partnerTopics",
"apiVersion": "2023-12-15-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"activationState": "string",
"eventTypeInfo": {
"inlineEventTypes": {
"{customized property}": {
"dataSchemaUrl": "string",
"description": "string",
"displayName": "string",
"documentationUrl": "string"
}
},
"kind": "string"
},
"expirationTimeIfNotActivatedUtc": "string",
"messageForActivation": "string",
"partnerRegistrationImmutableId": "string",
"partnerTopicFriendlyDescription": "string",
"source": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
EventTypeInfo
名前 | 形容 | 価値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す文字列型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベント型の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
種類 | 使用されるイベントの種類。 | 'Inline' |
EventTypeInfoInlineEventTypes
名前 | 形容 | 価値 |
---|
IdentityInfo
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | 使用されるマネージド 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
名前 | 形容 | 価値 |
---|
InlineEventProperties
名前 | 形容 | 価値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | 糸 |
形容 | インライン イベントの説明。 | 糸 |
displayName | インライン イベントの displayName。 | 糸 |
documentationUrl | インライン イベントの documentationUrl。 | 糸 |
Microsoft.EventGrid/partnerTopics
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2023-12-15-preview' |
同一性 | パートナー トピック リソースの ID 情報。 | IdentityInfo の |
場所 | リソースの場所。 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | パートナー トピックのプロパティ。 | PartnerTopicProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
種類 | リソースの種類 | 'Microsoft.EventGrid/partnerTopics' |
PartnerTopicProperties
名前 | 形容 | 価値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | 'Activated' '非アクティブ' 'NeverActivated' |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
糸 |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役に立つメッセージ。 | 糸 |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、パブリッシャー/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを解消するのに役立ちます。 |
糸 |
源 | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て ID のプリンシパル ID。 | 糸 |
Terraform (AzAPI プロバイダー) リソース定義
partnerTopics リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.EventGrid/partnerTopics リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/partnerTopics@2023-12-15-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
activationState = "string"
eventTypeInfo = {
inlineEventTypes = {
{customized property} = {
dataSchemaUrl = "string"
description = "string"
displayName = "string"
documentationUrl = "string"
}
}
kind = "string"
}
expirationTimeIfNotActivatedUtc = "string"
messageForActivation = "string"
partnerRegistrationImmutableId = "string"
partnerTopicFriendlyDescription = "string"
source = "string"
}
})
}
プロパティ値
EventTypeInfo
名前 | 形容 | 価値 |
---|---|---|
inlineEventTypes | リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す文字列型です。 有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。 インライン イベント型の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。 |
EventTypeInfoInlineEventTypes |
種類 | 使用されるイベントの種類。 | 'Inline' |
EventTypeInfoInlineEventTypes
名前 | 形容 | 価値 |
---|
IdentityInfo
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | 使用されるマネージド 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
名前 | 形容 | 価値 |
---|
InlineEventProperties
名前 | 形容 | 価値 |
---|---|---|
dataSchemaUrl | インライン イベントの dataSchemaUrl。 | 糸 |
形容 | インライン イベントの説明。 | 糸 |
displayName | インライン イベントの displayName。 | 糸 |
documentationUrl | インライン イベントの documentationUrl。 | 糸 |
Microsoft.EventGrid/partnerTopics
名前 | 形容 | 価値 |
---|---|---|
同一性 | パートナー トピック リソースの ID 情報。 | IdentityInfo の |
場所 | リソースの場所。 | string (必須) |
名前 | リソース名 | string (必須) |
プロパティ | パートナー トピックのプロパティ。 | PartnerTopicProperties |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | "Microsoft.EventGrid/partnerTopics@2023-12-15-preview" |
PartnerTopicProperties
名前 | 形容 | 価値 |
---|---|---|
activationState | パートナー トピックのアクティブ化の状態。 | 'Activated' '非アクティブ' 'NeverActivated' |
eventTypeInfo | 対応するイベント チャネルからのイベントの種類の情報。 | EventTypeInfo |
expirationTimeIfNotActivatedUtc | パートナー トピックの有効期限。 パートナー トピックがまだアクティブ化されていない間にこのタイマーが期限切れになった場合、 パートナー トピックと対応するイベント チャネルが削除されます。 |
糸 |
messageForActivation | サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役に立つメッセージ。 | 糸 |
partnerRegistrationImmutableId | 対応するパートナー登録の immutableId。 | 糸 制約: 最小長 = 36 最大長 = 36 パターン = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
partnerTopicFriendlyDescription | トピックに関するわかりやすい説明。 これは、パブリッシャー/パートナーが顧客パートナー トピックのカスタム説明を表示するように設定できます。 これは、顧客のパートナー トピックの作成元のあいまいさを解消するのに役立ちます。 |
糸 |
源 | このパートナー トピックに関連付けられているソース。 これは、一意のパートナー リソースを表します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て ID のプリンシパル ID。 | 糸 |