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 參數

名稱	位於	必要	類型	Description
domainName	path	True	string	功能變數名稱。
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源的位置。
identity		IdentityInfo	事件方格網域資源的身分識別資訊。
properties.autoCreateTopicWithFirstSubscription		boolean	此布爾值可用來指定與這個事件方格網域資源相關聯之事件方格網域主題之「全部」的建立機制。在此內容中，您可以自動管理網域主題（若為 true）或自我管理（若為 false）。此屬性的預設值為 true。當此屬性為 Null 或設定為 true 時，事件方格會負責在定義域主題範圍建立第一個事件訂閱時自動建立網域主題。如果此屬性設定為 false，則建立第一個事件訂用帳戶需要使用者建立網域主題。如果使用者想要完全控制建立網域主題的時間，則可以使用自我管理模式，而自動管理模式則提供彈性來執行較少的作業，並讓使用者管理較少的資源。此外，請注意，在自動管理的建立模式中，用戶可以視需要建立網域主題。
properties.autoDeleteTopicWithLastSubscription		boolean	此布爾值可用來指定與這個事件方格網域資源相關聯的「全部」事件方格網域主題的刪除機制。在此內容中，刪除網域主題可以自動管理（若為 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	這會決定事件方格針對發佈至事件方格網域資源之傳入事件所應預期的格式。
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	指定對應事件承載相關信息的 InputSchemaMapping 相關信息。
properties.minimumTlsVersionAllowed		TlsVersion	允許發佈至此網域之發行者的最低 TLS 版本
properties.publicNetworkAccess		PublicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。您可以藉由設定進一步限制特定IP
tags		object	資源的標記。

回應

名稱	類型	Description
201 Created	Domain	創建
Other Status Codes		錯誤回應： *** 400 不正確的要求。 500 內部伺服器錯誤。

名稱

類型

Description

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

定義

名稱	Description
ConnectionState	ConnectionState 資訊。
createdByType	建立資源的身分識別類型。
DataResidencyBoundary	資源的數據落地界限。
Domain	EventGrid 網域。
DomainProvisioningState	事件方格網域資源的布建狀態。
EventDefinitionKind	所使用的事件類型類型。
EventTypeInfo	通道的事件類型資訊。
IdentityInfo	資源的身分識別資訊。
IdentityType	所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。
InboundIpRule
InlineEventProperties	每個內嵌事件的其他資訊。
InputSchema	這會決定事件方格針對發佈至事件方格網域資源之傳入事件所應預期的格式。
IpActionType	根據相符專案或 IpMask 不相符執行的動作。
JsonField	這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。這目前用於『id』、『topic』和 'eventtime' 屬性的對應中。這代表輸入事件架構中的欄位。
JsonFieldWithDefault	這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。這目前用於 'subject' 、'eventtype' 和 'dataversion' 屬性的對應中。這代表輸入事件架構中的欄位以及要使用的預設值，而且至少應該提供這兩個屬性的其中一個。
JsonInputSchemaMapping	這可讓您使用自定義輸入架構發佈至事件方格。這可用來將自定義輸入 JSON 架構中的屬性對應至事件方格事件架構。
PersistedConnectionStatus	線上的狀態。
PrivateEndpoint	PrivateEndpoint 資訊。
PrivateEndpointConnection
PublicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。您可以藉由設定進一步限制特定IP
ResourceProvisioningState	私人端點聯機的布建狀態。
systemData	與建立和上次修改資源相關的元數據。
TlsVersion	允許發佈至此網域之發行者的最低 TLS 版本
UserIdentityProperties	使用者身分識別的相關信息。

ConnectionState

Object

ConnectionState 資訊。

名稱	類型	Description
actionsRequired	string	需要動作（如果有的話）。
description	string	連接狀態的描述。
status	PersistedConnectionStatus	線上的狀態。

createdByType

Enumeration

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

DataResidencyBoundary

Enumeration

資源的數據落地界限。

值	Description
WithinGeopair
WithinRegion

Domain

Object

EventGrid 網域。

名稱	類型	預設值	Description
id	string		資源的完整標識碼。
identity	IdentityInfo		事件方格網域資源的身分識別資訊。
location	string		資源的位置。
name	string		資源的名稱。
properties.autoCreateTopicWithFirstSubscription	boolean	True	此布爾值可用來指定與這個事件方格網域資源相關聯之事件方格網域主題之「全部」的建立機制。在此內容中，您可以自動管理網域主題（若為 true）或自我管理（若為 false）。此屬性的預設值為 true。當此屬性為 Null 或設定為 true 時，事件方格會負責在定義域主題範圍建立第一個事件訂閱時自動建立網域主題。如果此屬性設定為 false，則建立第一個事件訂用帳戶需要使用者建立網域主題。如果使用者想要完全控制建立網域主題的時間，則可以使用自我管理模式，而自動管理模式則提供彈性來執行較少的作業，並讓使用者管理較少的資源。此外，請注意，在自動管理的建立模式中，用戶可以視需要建立網域主題。
properties.autoDeleteTopicWithLastSubscription	boolean	True	此布爾值可用來指定與這個事件方格網域資源相關聯的「全部」事件方格網域主題的刪除機制。在此內容中，刪除網域主題可以自動管理（若為 true）或自我管理（若為 false）。此屬性的預設值為 true。當此屬性設定為 true 時，Event Grid 會負責在刪除網域主題範圍的最後一個事件訂閱時，自動刪除網域主題。如果此屬性設定為 false，則當使用者不再需要網域主題時需要手動刪除該主題（例如，刪除最後一個事件訂用帳戶且需要清除資源時）。如果使用者想要完全控制何時需要刪除網域主題，則可以使用自我管理模式，而自動管理模式則提供彈性，讓使用者執行較少的作業和管理較少的資源。
properties.dataResidencyBoundary	DataResidencyBoundary		資源的數據落地界限。
properties.disableLocalAuth	boolean	False	此布爾值是用來啟用或停用本機驗證。默認值為 false。當屬性設定為 true 時，只有在允許使用者發佈至網域時，才會使用 AAD 令牌進行驗證。
properties.endpoint	string		用於發佈事件的事件方格網域資源的端點。
properties.eventTypeInfo	EventTypeInfo		網域的事件類型資訊。這項資訊是由發行者提供，訂閱者可以使用此資訊來檢視發行的不同事件類型。
properties.inboundIpRules	InboundIpRule[]		這可用來限制來自特定IP的流量，而不是所有IP的流量。注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。
properties.inputSchema	InputSchema	EventGridSchema	這會決定事件方格針對發佈至事件方格網域資源之傳入事件所應預期的格式。
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		指定對應事件承載相關信息的 InputSchemaMapping 相關信息。
properties.metricResourceId	string		事件方格網域資源的計量資源標識符。
properties.minimumTlsVersionAllowed	TlsVersion		允許發佈至此網域之發行者的最低 TLS 版本
properties.privateEndpointConnections	PrivateEndpointConnection[]		私人端點連線的清單。
properties.provisioningState	DomainProvisioningState		事件方格網域資源的布建狀態。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	這會判斷是否允許透過公用網路傳輸流量。默認會啟用。您可以藉由設定進一步限制特定IP
systemData	systemData		與事件方格資源相關的系統元數據。
tags	object		資源的標記。
type	string		資源的類型。

DomainProvisioningState

Enumeration

事件方格網域資源的布建狀態。

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

EventDefinitionKind

Enumeration

所使用的事件類型類型。

值	Description
Inline

EventTypeInfo

Object

通道的事件類型資訊。

名稱	類型	Description
inlineEventTypes	<string, InlineEventProperties>	資源的內嵌事件類型集合。內嵌事件類型索引鍵的類型為字串，代表事件的名稱。有效的內嵌事件名稱範例是「Contoso.OrderCreated」。。內嵌事件類型值的類型為 InlineEventProperties，且會包含每個內嵌事件類型的其他資訊。
kind	EventDefinitionKind	所使用的事件類型類型。

IdentityInfo

Object

資源的身分識別資訊。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	IdentityType	所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。
userAssignedIdentities	<string, UserIdentityProperties>	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。此屬性目前未使用，並保留供日後使用。

IdentityType

Enumeration

所使用的受控識別類型。類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。類型『None』將會移除任何身分識別。

值	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

InboundIpRule

Object

名稱	類型	Description
action	IpActionType	根據相符專案或 IpMask 不相符執行的動作。
ipMask	string	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。

InlineEventProperties

Object

每個內嵌事件的其他資訊。

名稱	類型	Description
dataSchemaUrl	string	內嵌事件的 dataSchemaUrl。
description	string	內嵌事件的描述。
displayName	string	內嵌事件的 displayName。
documentationUrl	string	內嵌事件的檔Url。

InputSchema

Enumeration

這會決定事件方格針對發佈至事件方格網域資源之傳入事件所應預期的格式。

值	Description
CloudEventSchemaV1_0
CustomEventSchema
EventGridSchema

IpActionType

Enumeration

根據相符專案或 IpMask 不相符執行的動作。

值	Description
Allow

JsonField

Object

這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。這目前用於『id』、『topic』和 'eventtime' 屬性的對應中。這代表輸入事件架構中的欄位。

名稱	類型	Description
sourceField	string	輸入事件架構中要作為對應來源的功能變數名稱。

JsonFieldWithDefault

Object

這是用來表示事件方格事件架構中單一目標欄位輸入架構對應的來源。這目前用於 'subject' 、'eventtype' 和 'dataversion' 屬性的對應中。這代表輸入事件架構中的欄位以及要使用的預設值，而且至少應該提供這兩個屬性的其中一個。

名稱	類型	Description
defaultValue	string	未提供SourceField時要用於對應的預設值，如果已發佈的 JSON 事件承載中沒有具有指定名稱的屬性，則為。
sourceField	string	輸入事件架構中要作為對應來源的功能變數名稱。

JsonInputSchemaMapping

Object

這可讓您使用自定義輸入架構發佈至事件方格。這可用來將自定義輸入 JSON 架構中的屬性對應至事件方格事件架構。

名稱	類型	Description
inputSchemaMappingType	string: Json	自定義對應的類型
properties.dataVersion	JsonFieldWithDefault	事件方格事件之 DataVersion 屬性的對應資訊。
properties.eventTime	JsonField	Event Grid 事件之 EventTime 屬性的對應資訊。
properties.eventType	JsonFieldWithDefault	Event Grid 事件之 EventType 屬性的對應資訊。
properties.id	JsonField	事件方格事件的Id屬性對應資訊。
properties.subject	JsonFieldWithDefault	事件方格事件之 Subject 屬性的對應資訊。
properties.topic	JsonField	事件方格事件之 Topic 屬性的對應資訊。

PersistedConnectionStatus

Enumeration

線上的狀態。

值	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Object

PrivateEndpoint 資訊。

名稱	類型	Description
id	string	私人端點的ARM標識碼。

PrivateEndpointConnection

Object

名稱	類型	Description
id	string	資源的完整標識碼。
name	string	資源的名稱。
properties.groupIds	string[]	Private Link 服務資源的 GroupId。
properties.privateEndpoint	PrivateEndpoint	此連線的私人端點資源。
properties.privateLinkServiceConnectionState	ConnectionState	線上狀態的詳細數據。
properties.provisioningState	ResourceProvisioningState	私人端點聯機的布建狀態。
type	string	資源的類型。

PublicNetworkAccess

Enumeration

這會判斷是否允許透過公用網路傳輸流量。默認會啟用。您可以藉由設定進一步限制特定IP

值	Description
Disabled
Enabled

ResourceProvisioningState

Enumeration

私人端點聯機的布建狀態。

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

TlsVersion

Enumeration

允許發佈至此網域之發行者的最低 TLS 版本

值	Description
1.0
1.1
1.2

UserIdentityProperties

Object

使用者身分識別的相關信息。

名稱	類型	Description
clientId	string	使用者指派身分識別的用戶端標識碼。
principalId	string	使用者指派身分識別的主體標識碼。

共用方式為

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

其他資源