Topics - Get

トピックを取得します。
トピックのプロパティを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}?api-version=2022-06-15

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

ユーザーのサブスクリプション内のリソース グループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

topicName
path True
  • string

トピックの名前。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

応答

Name Type Description
200 OK

OK

Other Status Codes

エラー応答: ***

  • 400 無効な要求。

  • 500 内部サーバー エラー :

Topics_Get

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2?api-version=2022-06-15

Sample Response

{
  "properties": {
    "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2",
  "location": "westcentralus",
  "name": "exampletopic2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/topics"
}

定義

ConnectionState

ConnectionState 情報。

createdByType

リソースを作成した ID の種類。

DataResidencyBoundary

リソースの境界をData Residencyします。

IdentityInfo

リソースの ID 情報。

IdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は ID を削除します。

InboundIpRule
InputSchema

これにより、Event Grid ドメイン リソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。

IpActionType

IpMask の一致または一致に基づいて実行するアクション。

JsonField

これは、Event Grid イベント スキーマ内の単一のターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'id'、'topic'、および 'eventtime' プロパティのマッピングで使用されています。 これは、入力イベント スキーマのフィールドを表します。

JsonFieldWithDefault

これは、Event Grid イベント スキーマ内の単一のターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'subject'、'eventtype'、および 'dataversion' プロパティのマッピングで使用されています。 これは、入力イベント スキーマ内のフィールドと使用される既定値を表し、これら 2 つのプロパティのうち少なくとも 1 つを指定する必要があります。

JsonInputSchemaMapping

これにより、カスタム入力スキーマを使用して Event Grid に発行できます。 これを使用して、カスタム入力 JSON スキーマのプロパティを Event Grid イベント スキーマにマップできます。

PersistedConnectionStatus

接続の状態。

PrivateEndpoint

PrivateEndpoint 情報。

PrivateEndpointConnection
PublicNetworkAccess

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。

ResourceProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

systemData

リソースの作成と最後の変更に関するメタデータ。

Topic

EventGrid トピック

TopicProvisioningState

トピックのプロビジョニング状態。

UserIdentityProperties

ユーザー ID に関する情報。

ConnectionState

ConnectionState 情報。

Name Type Description
actionsRequired
  • string

必要なアクション (存在する場合)。

description
  • string

接続状態の説明。

status

接続の状態。

createdByType

リソースを作成した ID の種類。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DataResidencyBoundary

リソースの境界をData Residencyします。

Name Type Description
WithinGeopair
  • string
WithinRegion
  • string

IdentityInfo

リソースの ID 情報。

Name Type Description
principalId
  • string

リソース ID のプリンシパル ID。

tenantId
  • string

リソースのテナント ID。

type

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は ID を削除します。

userAssignedIdentities

リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 このプロパティは現在使用されておらず、将来の使用のために予約されています。

IdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は ID を削除します。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

InboundIpRule

Name Type Description
action

IpMask の一致または一致に基づいて実行するアクション。

ipMask
  • string

CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InputSchema

これにより、Event Grid ドメイン リソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。

Name Type Description
CloudEventSchemaV1_0
  • string
CustomEventSchema
  • string
EventGridSchema
  • string

IpActionType

IpMask の一致または一致に基づいて実行するアクション。

Name Type Description
Allow
  • string

JsonField

これは、Event Grid イベント スキーマ内の単一のターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'id'、'topic'、および 'eventtime' プロパティのマッピングで使用されています。 これは、入力イベント スキーマのフィールドを表します。

Name Type Description
sourceField
  • string

マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonFieldWithDefault

これは、Event Grid イベント スキーマ内の単一のターゲット フィールドの入力スキーマ マッピングのソースを表すために使用されます。 これは現在、'subject'、'eventtype'、および 'dataversion' プロパティのマッピングで使用されています。 これは、入力イベント スキーマ内のフィールドと使用される既定値を表し、これら 2 つのプロパティのうち少なくとも 1 つを指定する必要があります。

Name Type Description
defaultValue
  • string

SourceField が指定されていない場合、または発行された JSON イベント ペイロードに指定された名前のプロパティがない場合にマッピングに使用される既定値。

sourceField
  • string

マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonInputSchemaMapping

これにより、カスタム入力スキーマを使用して Event Grid に発行できます。 これを使用して、カスタム入力 JSON スキーマのプロパティを Event Grid イベント スキーマにマップできます。

Name Type Description
inputSchemaMappingType string:
  • Json

カスタム マッピングの種類

properties.dataVersion

Event Grid イベントの DataVersion プロパティのマッピング情報。

properties.eventTime

Event Grid イベントの EventTime プロパティのマッピング情報。

properties.eventType

Event Grid イベントの EventType プロパティのマッピング情報。

properties.id

Event Grid イベントの Id プロパティのマッピング情報。

properties.subject

Event Grid イベントの Subject プロパティのマッピング情報。

properties.topic

Event Grid イベントの Topic プロパティのマッピング情報。

PersistedConnectionStatus

接続の状態。

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

PrivateEndpoint 情報。

Name Type Description
id
  • string

プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

Name Type Description
id
  • string

リソースの完全修飾識別子。

name
  • string

リソースの名前。

properties.groupIds
  • string[]

プライベート リンク サービス リソースの GroupId。

properties.privateEndpoint

この接続のプライベート エンドポイント リソース。

properties.privateLinkServiceConnectionState

接続の状態の詳細。

properties.provisioningState

プライベート エンドポイント接続のプロビジョニング状態。

type
  • string

リソースの種類。

PublicNetworkAccess

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

systemData

リソースの作成と最後の変更に関するメタデータ。

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

リソースを作成した ID の種類。

lastModifiedAt
  • string

リソースの最終変更 (UTC) のタイムスタンプ

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。

Topic

EventGrid トピック

Name Type Default Value Description
id
  • string

リソースの完全修飾識別子。

identity

リソースの ID 情報。

location
  • string

リソースの場所。

name
  • string

リソースの名前。

properties.dataResidencyBoundary

リソースの境界をData Residencyします。

properties.disableLocalAuth
  • boolean
False

このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。 プロパティが true に設定されている場合、ユーザーがトピックへの発行を許可されている場合は、AAD トークンのみが認証に使用されます。

properties.endpoint
  • string

トピックのエンドポイント。

properties.inboundIpRules

これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。

properties.inputSchema EventGridSchema

これにより、トピックに発行された受信イベントに対して Event Grid で想定される形式が決まります。

properties.inputSchemaMapping InputSchemaMapping:

これにより、カスタム イベント スキーマを使用した発行が可能になります。 InputSchemaMapping を指定して、ソース スキーマのさまざまなプロパティを EventGridEvent スキーマのさまざまな必須プロパティにマップできます。

properties.metricResourceId
  • string

トピックのメトリック リソース ID。

properties.privateEndpointConnections
properties.provisioningState

トピックのプロビジョニング状態。

properties.publicNetworkAccess Enabled

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。

systemData

トピック リソースに関連するシステム メタデータ。

tags
  • object

リソースのタグ。

type
  • string

リソースの種類。

TopicProvisioningState

トピックのプロビジョニング状態。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

UserIdentityProperties

ユーザー ID に関する情報。

Name Type Description
clientId
  • string

ユーザー割り当て ID のクライアント ID。

principalId
  • string

ユーザー割り当て ID のプリンシパル ID。