Domain interface

パッケージ:

@azure/arm-eventgrid

EventGrid ドメイン。

Extends

TrackedResource

プロパティ

autoCreateTopicWithFirstSubscription	このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの作成メカニズムを "all" に指定するために使用されます。 このコンテキストでは、ドメイン トピックの作成は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は、true です。 このプロパティが null または true に設定されている場合、Event Grid は、ドメイン トピックのスコープで最初のイベント サブスクリプションが作成されるときに、ドメイン トピックを自動的に作成します。 このプロパティが false に設定されている場合、最初のイベント サブスクリプションを作成するには、ユーザーがドメイン トピックを作成する必要があります。 自己管理モードは、ユーザーがドメイン トピックの作成時を完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らす柔軟性が提供されます。 また、自動管理作成モードでは、必要に応じてユーザーが必要に応じてドメイン トピックを作成できます。
autoDeleteTopicWithLastSubscription	このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの削除メカニズムを 'all' に指定するために使用されます。 このコンテキストでは、ドメイン トピックの削除は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は、true です。 このプロパティが true に設定されている場合、Event Grid は、ドメイン トピックのスコープにある最後のイベント サブスクリプションが削除されたときに、ドメイン トピックを自動的に削除する役割を担います。 このプロパティが false に設定されている場合、ユーザーは必要なくなったドメイン トピックを手動で削除する必要があります (たとえば、最後のイベント サブスクリプションが削除され、リソースをクリーンアップする必要がある場合など)。 自己管理モードは、ユーザーがドメイン トピックを削除する必要があるタイミングを完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が得られます。
dataResidencyBoundary	Data Residency リソースの境界。
disableLocalAuth	このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。 プロパティが true に設定されている場合、ユーザーがドメインへの発行を許可されている場合は、AAD トークンのみが認証に使用されます。
endpoint	イベントの発行に使用される Event Grid ドメイン リソースのエンドポイント。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
identity	Event Grid ドメイン リソースの ID 情報。
inboundIpRules	これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。
inputSchema	これにより、Event Grid ドメイン リソースに発行される受信イベントに対して Event Grid が想定する形式が決まります。
inputSchemaMapping	マッピング イベント ペイロードに関する情報を指定した InputSchemaMapping に関する情報。
metricResourceId	Event Grid ドメイン リソースのメトリック リソース ID。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
privateEndpointConnections	プライベート エンドポイント接続の一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState	Event Grid ドメイン リソースのプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
publicNetworkAccess	これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 を構成することで、特定の IP にさらに制限できます。
systemData	Event Grid ドメイン リソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

継承されたプロパティ

id	リソースの完全修飾識別子。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
location	リソースの場所。
name	リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
tags	リソースのタグ。
type	リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

autoCreateTopicWithFirstSubscription

このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの作成メカニズムを "all" に指定するために使用されます。 このコンテキストでは、ドメイン トピックの作成は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は、true です。 このプロパティが null または true に設定されている場合、Event Grid は、ドメイン トピックのスコープで最初のイベント サブスクリプションが作成されるときに、ドメイン トピックを自動的に作成します。 このプロパティが false に設定されている場合、最初のイベント サブスクリプションを作成するには、ユーザーがドメイン トピックを作成する必要があります。 自己管理モードは、ユーザーがドメイン トピックの作成時を完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らす柔軟性が提供されます。 また、自動管理作成モードでは、必要に応じてユーザーが必要に応じてドメイン トピックを作成できます。

autoCreateTopicWithFirstSubscription?: boolean

プロパティ値

boolean

autoDeleteTopicWithLastSubscription

このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの削除メカニズムを 'all' に指定するために使用されます。 このコンテキストでは、ドメイン トピックの削除は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は、true です。 このプロパティが true に設定されている場合、Event Grid は、ドメイン トピックのスコープにある最後のイベント サブスクリプションが削除されたときに、ドメイン トピックを自動的に削除する役割を担います。 このプロパティが false に設定されている場合、ユーザーは必要なくなったドメイン トピックを手動で削除する必要があります (たとえば、最後のイベント サブスクリプションが削除され、リソースをクリーンアップする必要がある場合など)。 自己管理モードは、ユーザーがドメイン トピックを削除する必要があるタイミングを完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が得られます。

autoDeleteTopicWithLastSubscription?: boolean

プロパティ値

boolean

dataResidencyBoundary

Data Residency リソースの境界。

dataResidencyBoundary?: string

プロパティ値

string

disableLocalAuth

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

disableLocalAuth?: boolean

プロパティ値

boolean

endpoint

イベントの発行に使用される Event Grid ドメイン リソースのエンドポイント。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

endpoint?: string

プロパティ値

string

identity

Event Grid ドメイン リソースの ID 情報。

identity?: IdentityInfo

プロパティ値

IdentityInfo

inboundIpRules

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

inboundIpRules?: InboundIpRule[]

プロパティ値

InboundIpRule[]

inputSchema

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

inputSchema?: string

プロパティ値

string

inputSchemaMapping

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

inputSchemaMapping?: InputSchemaMappingUnion

プロパティ値

InputSchemaMappingUnion

metricResourceId

Event Grid ドメイン リソースのメトリック リソース ID。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

metricResourceId?: string

プロパティ値

string

privateEndpointConnections

プライベート エンドポイント接続の一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

privateEndpointConnections?: PrivateEndpointConnection[]

プロパティ値

PrivateEndpointConnection[]

provisioningState

Event Grid ドメイン リソースのプロビジョニング状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

publicNetworkAccess

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

publicNetworkAccess?: string

プロパティ値

string

systemData

Event Grid ドメイン リソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

継承されたプロパティの詳細

id

リソースの完全修飾識別子。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

TrackedResource.idから継承

location

リソースの場所。

location: string

プロパティ値

string

TrackedResource.locationから継承

name

リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

TrackedResource.nameから継承

tags

リソースのタグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

TrackedResource.tagsから継承

type

リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

TrackedResource.typeから継承