Domains - Create Or Update

リファレンス

サービス:: Event Grid

API バージョン:: 2025-02-15

ドメインを作成または更新します。
指定したパラメーターを使用して、新しいドメインを非同期に作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2025-02-15

URI パラメーター

名前	/	必須	型	説明
domainName	path	True	string	ドメインの名前。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント要求で使用する API のバージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
identity		IdentityInfo	Event Grid ドメインリソースの ID 情報。
properties.autoCreateTopicWithFirstSubscription		boolean	このブール値は、この Event Grid ドメインリソースに関連付けられている Event Grid ドメイントピックの作成メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイントピックの作成は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。このプロパティの既定値は true です。このプロパティが null または true に設定されている場合、Event Grid は、ドメイントピックのスコープで最初のイベントサブスクリプションが作成されるときに、ドメイントピックを自動的に作成します。このプロパティが false に設定されている場合、最初のイベントサブスクリプションを作成するには、ユーザーがドメイントピックを作成する必要があります。自己管理モードは、ユーザーがドメイントピックを作成するタイミングを完全に制御する必要がある場合に使用できますが、自動管理モードでは、実行する操作を減らし、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。また、自動管理作成モードでは、必要に応じてユーザーが必要に応じてドメイントピックを作成できます。
properties.autoDeleteTopicWithLastSubscription		boolean	このブール値は、この Event Grid ドメインリソースに関連付けられている Event Grid ドメイントピックの削除メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイントピックの削除は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。このプロパティの既定値は true です。このプロパティが true に設定されている場合、Event Grid は、ドメイントピックのスコープにある最後のイベントサブスクリプションが削除されたときに、ドメイントピックを自動的に削除します。このプロパティが false に設定されている場合、ユーザーは必要なくなったときにドメイントピックを手動で削除する必要があります (たとえば、最後のイベントサブスクリプションが削除され、リソースをクリーンアップする必要がある場合)。自己管理モードは、ユーザーがドメイントピックを削除する必要があるタイミングを完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。
properties.dataResidencyBoundary		DataResidencyBoundary	リソースのデータ所在地の境界。
properties.disableLocalAuth		boolean	このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。プロパティが true に設定されている場合、ユーザーがドメインへの発行を許可されている場合は、AAD トークンのみが認証に使用されます。
properties.eventTypeInfo		EventTypeInfo	ドメインのイベントの種類情報。この情報はパブリッシャーによって提供され、サブスクライバーが公開されているさまざまな種類のイベントを表示するために使用できます。
properties.inboundIpRules		InboundIpRule[]	これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。
properties.inputSchema		InputSchema	これにより、Event Grid ドメインリソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	マッピングイベントペイロードに関する情報を指定した InputSchemaMapping に関する情報。
properties.minimumTlsVersionAllowed		TlsVersion	このドメインへの発行が許可されている発行元の最小 TLS バージョン
properties.publicNetworkAccess		PublicNetworkAccess	これにより、パブリックネットワーク経由でトラフィックが許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。
tags		object	リソースのタグ。

応答

名前	型	説明
201 Created	Domain	作成
Other Status Codes		エラー応答: *** 400 無効な要求。 500 内部サーバーエラー。

名前

型

説明

201 Created

Domain

作成

Other Status Codes

エラー応答: ***

400 無効な要求。
500 内部サーバーエラー。

例

Domains_CreateOrUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1?api-version=2025-02-15

{
  "location": "westus2",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  }
}

応答のサンプル

状態コード:: 201

{
  "properties": {
    "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled",
    "inboundIpRules": [
      {
        "ipMask": "12.18.30.15",
        "action": "Allow"
      },
      {
        "ipMask": "12.18.176.1",
        "action": "Allow"
      }
    ]
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
  "location": "westus2",
  "name": "exampledomain1",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "type": "Microsoft.EventGrid/domains"
}

定義

名前	説明
ConnectionState	ConnectionState 情報。
createdByType	リソースを作成した ID の種類。
DataResidencyBoundary	リソースのデータ所在地の境界。
Domain	EventGrid ドメイン。
DomainProvisioningState	Event Grid ドメインリソースのプロビジョニング状態。
EventDefinitionKind	使用されるイベントの種類。
EventTypeInfo	チャネルのイベントの種類の情報。
IdentityInfo	リソースの ID 情報。
IdentityType	使用されるマネージド ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' では、任意の ID が削除されます。
InboundIpRule
InlineEventProperties	すべてのインラインイベントに関する追加情報。
InputSchema	これにより、Event Grid ドメインリソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。
IpActionType	IpMask の一致または一致に基づいて実行するアクション。
JsonField	これは、Event Grid イベントスキーマ内の 1 つのターゲットフィールドの入力スキーママッピングのソースを表すために使用されます。これは現在、'id'、'topic'、および 'eventtime' プロパティのマッピングで使用されています。これは、入力イベントスキーマのフィールドを表します。
JsonFieldWithDefault	これは、Event Grid イベントスキーマ内の 1 つのターゲットフィールドの入力スキーママッピングのソースを表すために使用されます。これは現在、'subject'、'eventtype'、および 'dataversion' プロパティのマッピングで使用されています。これは、入力イベントスキーマ内のフィールドと使用する既定値を表し、これら 2 つのプロパティのうち少なくとも 1 つを指定する必要があります。
JsonInputSchemaMapping	これにより、カスタム入力スキーマを使用して Event Grid に発行できます。これを使用して、カスタム入力 JSON スキーマのプロパティを Event Grid イベントスキーマにマップできます。
PersistedConnectionStatus	接続の状態。
PrivateEndpoint	PrivateEndpoint 情報。
PrivateEndpointConnection
PublicNetworkAccess	これにより、パブリックネットワーク経由でトラフィックが許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。
ResourceProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TlsVersion	このドメインへの発行が許可されている発行元の最小 TLS バージョン
UserIdentityProperties	ユーザー ID に関する情報。

ConnectionState

Object

ConnectionState 情報。

名前	型	説明
actionsRequired	string	必要なアクション (ある場合)。
description	string	接続状態の説明。
status	PersistedConnectionStatus	接続の状態。

createdByType

Enumeration

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

値	説明
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

リソースのデータ所在地の境界。

値	説明
WithinGeopair
WithinRegion

Domain

Object

EventGrid ドメイン。

名前	型	規定値	説明
id	string		リソースの完全修飾識別子。
identity	IdentityInfo		Event Grid ドメインリソースの ID 情報。
location	string		リソースの場所。
name	string		リソースの名前。
properties.autoCreateTopicWithFirstSubscription	boolean	True	このブール値は、この Event Grid ドメインリソースに関連付けられている Event Grid ドメイントピックの作成メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイントピックの作成は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。このプロパティの既定値は true です。このプロパティが null または true に設定されている場合、Event Grid は、ドメイントピックのスコープで最初のイベントサブスクリプションが作成されるときに、ドメイントピックを自動的に作成します。このプロパティが false に設定されている場合、最初のイベントサブスクリプションを作成するには、ユーザーがドメイントピックを作成する必要があります。自己管理モードは、ユーザーがドメイントピックを作成するタイミングを完全に制御する必要がある場合に使用できますが、自動管理モードでは、実行する操作を減らし、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。また、自動管理作成モードでは、必要に応じてユーザーが必要に応じてドメイントピックを作成できます。
properties.autoDeleteTopicWithLastSubscription	boolean	True	このブール値は、この Event Grid ドメインリソースに関連付けられている Event Grid ドメイントピックの削除メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイントピックの削除は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。このプロパティの既定値は true です。このプロパティが true に設定されている場合、Event Grid は、ドメイントピックのスコープにある最後のイベントサブスクリプションが削除されたときに、ドメイントピックを自動的に削除します。このプロパティが false に設定されている場合、ユーザーは必要なくなったときにドメイントピックを手動で削除する必要があります (たとえば、最後のイベントサブスクリプションが削除され、リソースをクリーンアップする必要がある場合)。自己管理モードは、ユーザーがドメイントピックを削除する必要があるタイミングを完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。
properties.dataResidencyBoundary	DataResidencyBoundary		リソースのデータ所在地の境界。
properties.disableLocalAuth	boolean	False	このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。プロパティが true に設定されている場合、ユーザーがドメインへの発行を許可されている場合は、AAD トークンのみが認証に使用されます。
properties.endpoint	string		イベントの発行に使用される Event Grid ドメインリソースのエンドポイント。
properties.eventTypeInfo	EventTypeInfo		ドメインのイベントの種類情報。この情報はパブリッシャーによって提供され、サブスクライバーが公開されているさまざまな種類のイベントを表示するために使用できます。
properties.inboundIpRules	InboundIpRule[]		これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。
properties.inputSchema	InputSchema	EventGridSchema	これにより、Event Grid ドメインリソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		マッピングイベントペイロードに関する情報を指定した InputSchemaMapping に関する情報。
properties.metricResourceId	string		Event Grid ドメインリソースのメトリックリソース ID。
properties.minimumTlsVersionAllowed	TlsVersion		このドメインへの発行が許可されている発行元の最小 TLS バージョン
properties.privateEndpointConnections	PrivateEndpointConnection[]		プライベートエンドポイント接続の一覧。
properties.provisioningState	DomainProvisioningState		Event Grid ドメインリソースのプロビジョニング状態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	これにより、パブリックネットワーク経由でトラフィックが許可されるかどうかが決まります。既定では有効になっています。を構成することで、特定の IP にさらに制限できます。
systemData	systemData		Event Grid リソースに関連するシステムメタデータ。
tags	object		リソースのタグ。
type	string		リソースの種類。

DomainProvisioningState

Enumeration

Event Grid ドメインリソースのプロビジョニング状態。

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

EventDefinitionKind

Enumeration

使用されるイベントの種類。

値	説明
Inline

EventTypeInfo

Object

チャネルのイベントの種類の情報。

名前	型	説明
inlineEventTypes	<string, InlineEventProperties>	リソースのインラインイベントの種類のコレクション。インラインイベント型キーは、イベントの名前を表す文字列型です。有効なインラインイベント名の例として、"Contoso.OrderCreated" があります。インラインイベント型の値は InlineEventProperties 型であり、すべてのインラインイベントの種類に関する追加情報が含まれます。
kind	EventDefinitionKind	使用されるイベントの種類。

IdentityInfo

Object

リソースの ID 情報。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	IdentityType	使用されるマネージド ID の種類。型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。型 'None' では、任意の ID が削除されます。
userAssignedIdentities	<string, UserIdentityProperties>	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。現在、このプロパティは使用されず、将来使用するために予約されています。

IdentityType

Enumeration

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

値	説明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

名前	型	説明
action	IpActionType	IpMask の一致または一致に基づいて実行するアクション。
ipMask	string	CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InlineEventProperties

Object

すべてのインラインイベントに関する追加情報。

名前	型	説明
dataSchemaUrl	string	インラインイベントの dataSchemaUrl。
description	string	インラインイベントの説明。
displayName	string	インラインイベントの displayName。
documentationUrl	string	インラインイベントの documentationUrl。

InputSchema

Enumeration

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

値	説明
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

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

値	説明
Allow

JsonField

Object

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

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

JsonFieldWithDefault

Object

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

名前	型	説明
defaultValue	string	SourceField が指定されていない場合、または発行された JSON イベントペイロードに指定された名前のプロパティがない場合に、マッピングに使用される既定値。
sourceField	string	マッピングのソースとして使用される入力イベントスキーマ内のフィールドの名前。

JsonInputSchemaMapping

Object

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

名前	型	説明
inputSchemaMappingType	string: Json	カスタムマッピングの種類
properties.dataVersion	JsonFieldWithDefault	Event Grid イベントの DataVersion プロパティのマッピング情報。
properties.eventTime	JsonField	Event Grid イベントの EventTime プロパティのマッピング情報。
properties.eventType	JsonFieldWithDefault	Event Grid イベントの EventType プロパティのマッピング情報。
properties.id	JsonField	Event Grid イベントの Id プロパティのマッピング情報。
properties.subject	JsonFieldWithDefault	Event Grid イベントの Subject プロパティのマッピング情報。
properties.topic	JsonField	Event Grid イベントの Topic プロパティのマッピング情報。

PersistedConnectionStatus

Enumeration

接続の状態。

値	説明
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

PrivateEndpoint 情報。

名前	型	説明
id	string	プライベートエンドポイントの ARM 識別子。

PrivateEndpointConnection

Object

名前	型	説明
id	string	リソースの完全修飾識別子。
name	string	リソースの名前。
properties.groupIds	string[]	プライベートリンクサービスリソースの GroupId。
properties.privateEndpoint	PrivateEndpoint	この接続のプライベートエンドポイントリソース。
properties.privateLinkServiceConnectionState	ConnectionState	接続の状態に関する詳細。
properties.provisioningState	ResourceProvisioningState	プライベートエンドポイント接続のプロビジョニング状態。
type	string	リソースの種類。

PublicNetworkAccess

Enumeration

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

値	説明
Disabled
Enabled

ResourceProvisioningState

Enumeration

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

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

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

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TlsVersion

Enumeration

このドメインへの発行が許可されている発行元の最小 TLS バージョン

値	説明
1.0
1.1
1.2

UserIdentityProperties

Object

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

名前	型	説明
clientId	string	ユーザー割り当て ID のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル ID。

次の方法で共有

Domains - Create Or Update

URI パラメーター

要求本文

応答

例

Domains_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

ConnectionState

createdByType

DataResidencyBoundary

Domain

DomainProvisioningState

EventDefinitionKind

EventTypeInfo

IdentityInfo

IdentityType

InboundIpRule

InlineEventProperties

InputSchema

IpActionType

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion

UserIdentityProperties

その他のリソース