Share via


Domains - Create Or Update

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-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

Data Residency リソースの境界。

properties.disableLocalAuth

boolean

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

properties.inboundIpRules

InboundIpRule[]

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

properties.inputSchema

InputSchema

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

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

マッピング イベント ペイロードに関する情報を指定した InputSchemaMapping に関する情報。

properties.publicNetworkAccess

PublicNetworkAccess

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

tags

object

リソースのタグ。

応答

名前 説明
201 Created

Domain

作成済み

Other Status Codes

エラー応答: ***

  • 400 無効な要求です。

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

Domains_CreateOrUpdate

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1?api-version=2022-06-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"
      }
    ]
  }
}

Sample Response

{
  "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

Data Residency リソースの境界。

Domain

EventGrid ドメイン。

DomainProvisioningState

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

IdentityInfo

リソースの ID 情報。

IdentityType

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

InboundIpRule
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

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

UserIdentityProperties

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

ConnectionState

ConnectionState 情報。

名前 説明
actionsRequired

string

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

description

string

接続状態の説明。

status

PersistedConnectionStatus

接続の状態。

createdByType

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

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency リソースの境界。

名前 説明
WithinGeopair

string

WithinRegion

string

Domain

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

Data Residency リソースの境界。

properties.disableLocalAuth

boolean

False

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

properties.endpoint

string

イベントの発行に使用される Event Grid ドメイン リソースのエンドポイント。

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.privateEndpointConnections

PrivateEndpointConnection[]

プライベート エンドポイント接続の一覧。

properties.provisioningState

DomainProvisioningState

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

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

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

systemData

systemData

Event Grid ドメイン リソースに関連するシステム メタデータ。

tags

object

リソースのタグ。

type

string

リソースの種類。

DomainProvisioningState

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

名前 説明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

リソースの 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

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

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

名前 説明
action

IpActionType

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

ipMask

string

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

InputSchema

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

名前 説明
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

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

名前 説明
Allow

string

JsonField

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

名前 説明
sourceField

string

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

JsonFieldWithDefault

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

名前 説明
defaultValue

string

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

sourceField

string

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

JsonInputSchemaMapping

これにより、カスタム入力スキーマを使用して 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

接続の状態。

名前 説明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint 情報。

名前 説明
id

string

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

PrivateEndpointConnection

名前 説明
id

string

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

name

string

リソースの名前。

properties.groupIds

string[]

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

properties.privateEndpoint

PrivateEndpoint

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

properties.privateLinkServiceConnectionState

ConnectionState

接続の状態の詳細。

properties.provisioningState

ResourceProvisioningState

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

type

string

リソースの種類。

PublicNetworkAccess

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

名前 説明
Disabled

string

Enabled

string

ResourceProvisioningState

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

名前 説明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

UserIdentityProperties

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

名前 説明
clientId

string

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

principalId

string

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