Domains - Create Or Update
建立或更新網域。
以異步方式建立或更新具有指定參數的新網域。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
domain
|
path | True |
string |
功能變數名稱。 |
resource
|
path | True |
string |
用戶訂用帳戶內的資源組名。 |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
要與用戶端要求搭配使用的 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
location | True |
string |
資源的位置。 |
identity |
事件方格網域資源的識別資訊。 |
||
properties.autoCreateTopicWithFirstSubscription |
boolean |
這個布爾值是用來指定與這個事件方格網域資源相關聯之「所有」事件方格網域主題的建立機制。 在此內容中,如果為 true) (,或是在 false) 時,可以自動管理網域主題的建立 (。 這個屬性的預設值是 True。 當此屬性為 Null 或設定為 true 時,當第一個事件訂用帳戶建立於定義域主題的範圍時,事件方格會負責自動建立網域主題。 如果此屬性設定為 false,則建立第一個事件訂用帳戶需要使用者建立網域主題。 如果使用者想要在建立網域主題時完全控制,而自動管理模式則可讓您彈性地執行較少的作業,並管理使用者較少的資源。 此外,請注意,在自動管理的建立模式中,用戶可以視需要視需要建立網域主題。 |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
這個布爾值是用來指定與這個事件方格網域資源相關聯之「所有」事件方格網域主題的刪除機制。 在此內容中,如果為 true) ,或是在 false) 時,可以自動 (管理網域主題的刪除 (。 這個屬性的預設值是 True。 當此屬性設定為 true 時,Event Grid 會負責在刪除網域主題範圍的最後一個事件訂閱時,自動刪除網域主題。 如果此屬性設定為 false,則用戶必須在不再需要網域主題時手動刪除 (例如,刪除最後一個事件訂用帳戶時,而且需要清除資源) 。 如果使用者想要完全控制何時需要刪除網域主題,而自動管理模式則可讓您彈性地執行較少的作業,並管理使用者較少的資源。 |
|
properties.dataResidencyBoundary |
Data Residency 資源的界限。 |
||
properties.disableLocalAuth |
boolean |
此布爾值是用來啟用或停用本機驗證。默認值為 false。 當 屬性設定為 true 時,只有在允許使用者發佈至網域時,才會使用 AAD 令牌進行驗證。 |
|
properties.inboundIpRules |
這可以用來限制來自特定IP的流量,而不是所有IP。 注意:只有在啟用 PublicNetworkAccess 時,才會考慮這些專案。 |
||
properties.inputSchema |
這會決定事件方格在發行至事件方格網域資源之傳入事件時應該預期的格式。 |
||
properties.inputSchemaMapping | InputSchemaMapping: |
InputSchemaMapping 的相關信息,指定對應事件承載的相關信息。 |
|
properties.publicNetworkAccess |
這會判斷是否允許透過公用網路流量。 默認會啟用它。 您可以藉由設定來進一步限制特定IP |
||
tags |
object |
資源的標記。 |
回應
名稱 | 類型 | Description |
---|---|---|
201 Created |
建立時間 |
|
Other Status Codes |
錯誤回應: ≦
|
範例
Domains_CreateOrUpdate
範例要求
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"
}
]
}
}
範例回覆
{
"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 |
---|---|
Connection |
ConnectionState 資訊。 |
created |
建立資源的身分識別類型。 |
Data |
Data Residency 資源的界限。 |
Domain |
EventGrid 網域。 |
Domain |
事件方格網域資源的布建狀態。 |
Identity |
資源的身分識別資訊。 |
Identity |
使用的受控識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 |
Inbound |
|
Input |
這會決定事件方格應該預期發行至事件方格網域資源之傳入事件的格式。 |
Ip |
要根據比對或不符合 IpMask 執行的動作。 |
Json |
這會用來表示事件方格事件架構中單一目標欄位的輸入架構對應來源。 這目前用於 『id』、『topic』 和 'eventtime' 屬性的對應中。 這代表輸入事件架構中的欄位。 |
Json |
這會用來表示事件方格事件架構中單一目標欄位的輸入架構對應來源。 這目前用於 'subject'、'eventtype' 和 'dataversion' 屬性的對應中。 這代表輸入事件架構中的欄位以及要使用的預設值,而且至少應該提供這兩個屬性的其中一個。 |
Json |
這可讓您使用自定義輸入架構發佈至事件方格。 這可用來將自定義輸入 JSON 架構的屬性對應至事件方格事件架構。 |
Persisted |
線上的狀態。 |
Private |
PrivateEndpoint 資訊。 |
Private |
|
Public |
這會判斷是否允許透過公用網路使用流量。 默認會啟用。 您可以藉由設定進一步限制特定IP |
Resource |
私人端點聯機的布建狀態。 |
system |
與建立和上次修改資源相關的元數據。 |
User |
使用者身分識別的相關信息。 |
ConnectionState
ConnectionState 資訊。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
如有任何) ,則需要 (動作。 |
description |
string |
線上狀態的描述。 |
status |
線上的狀態。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency 資源的界限。
名稱 | 類型 | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
EventGrid 網域。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
id |
string |
資源的完整標識碼。 |
|
identity |
事件方格網域資源的身分識別資訊。 |
||
location |
string |
資源的位置。 |
|
name |
string |
資源名稱。 |
|
properties.autoCreateTopicWithFirstSubscription |
boolean |
True |
此布爾值是用來指定與此事件方格定義域資源相關聯之事件方格定義域主題的建立機制。 在此內容中,當 true) 或自我管理 (為 false) 時,可以自動管理網域主題的建立 (。 這個屬性的預設值是 True。 當此屬性為 null 或設定為 true 時,事件方格會負責在網域主題範圍建立第一個事件訂閱時自動建立網域主題。 如果此屬性設定為 false,則建立第一個事件訂閱需要使用者建立網域主題。 如果使用者想要完全控制何時建立網域主題,則可以使用自我管理模式,而自動管理模式則提供彈性,讓使用者執行較少的作業和管理較少的資源。 此外,請注意,在自動管理的建立模式中,用戶可以視需要視需要建立網域主題。 |
properties.autoDeleteTopicWithLastSubscription |
boolean |
True |
此布爾值是用來指定與這個事件方格定義域資源相關聯之「所有」事件方格網域主題的刪除機制。 在此內容中,當 true) 或自我管理 (為 false) 時,可以自動管理網域主題的刪除 (。 這個屬性的預設值是 True。 當此屬性設定為 true 時,事件方格會負責在刪除網域主題範圍的最後一個事件訂閱時,自動刪除網域主題。 如果此屬性設定為 false,則當使用者不再需要網域主題時, (例如刪除最後一個事件訂閱,而且需要清除資源) 時手動刪除網域主題。 如果使用者想要完全控制何時需要刪除網域主題,則可以使用自我管理模式,而自動管理模式則提供彈性,讓使用者執行較少的作業和管理較少的資源。 |
properties.dataResidencyBoundary |
Data Residency 資源的界限。 |
||
properties.disableLocalAuth |
boolean |
False |
此布爾值是用來啟用或停用本機驗證。默認值為 false。 當 屬性設定為 true 時,如果允許使用者發佈至網域,則只會使用 AAD 令牌來驗證。 |
properties.endpoint |
string |
用於發佈事件的事件方格定義域資源的端點。 |
|
properties.inboundIpRules |
這可用來限制來自特定IP的流量,而不是所有IP。 注意:只有在啟用 PublicNetworkAccess 時,才會考慮這些專案。 |
||
properties.inputSchema | EventGridSchema |
這會決定事件方格應該預期發行至事件方格網域資源之傳入事件的格式。 |
|
properties.inputSchemaMapping | InputSchemaMapping: |
InputSchemaMapping 的相關信息,指定對應事件承載的相關信息。 |
|
properties.metricResourceId |
string |
事件方格網域資源的計量資源標識符。 |
|
properties.privateEndpointConnections |
私人端點連線的清單。 |
||
properties.provisioningState |
事件方格網域資源的布建狀態。 |
||
properties.publicNetworkAccess | Enabled |
這會判斷是否允許透過公用網路使用流量。 默認會啟用。 您可以藉由設定進一步限制特定IP |
|
systemData |
與事件方格網域資源相關的系統元數據。 |
||
tags |
object |
資源的標記。 |
|
type |
string |
資源類型。 |
DomainProvisioningState
事件方格網域資源的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
資源的身分識別資訊。
名稱 | 類型 | Description |
---|---|---|
principalId |
string |
資源識別的主要標識碼。 |
tenantId |
string |
資源的租用戶標識碼。 |
type |
使用的受控識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。 |
|
userAssignedIdentities |
<string,
User |
與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 此屬性目前未使用,並保留供日後使用。 |
IdentityType
使用的受控識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
名稱 | 類型 | Description |
---|---|---|
action |
要根據比對或不符合 IpMask 執行的動作。 |
|
ipMask |
string |
CIDR 表示法中的IP位址,例如10.0.0.0.0/8。 |
InputSchema
這會決定事件方格應該預期發行至事件方格網域資源之傳入事件的格式。
名稱 | 類型 | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
要根據比對或不符合 IpMask 執行的動作。
名稱 | 類型 | Description |
---|---|---|
Allow |
string |
JsonField
這會用來表示事件方格事件架構中單一目標欄位的輸入架構對應來源。 這目前用於 『id』、『topic』 和 'eventtime' 屬性的對應中。 這代表輸入事件架構中的欄位。
名稱 | 類型 | Description |
---|---|---|
sourceField |
string |
輸入事件架構中要作為對應來源的功能變數名稱。 |
JsonFieldWithDefault
這會用來表示事件方格事件架構中單一目標欄位的輸入架構對應來源。 這目前用於 'subject'、'eventtype' 和 'dataversion' 屬性的對應中。 這代表輸入事件架構中的欄位以及要使用的預設值,而且至少應該提供這兩個屬性的其中一個。
名稱 | 類型 | Description |
---|---|---|
defaultValue |
string |
未提供SourceField時要用於對應的預設值,或在已發佈的 JSON 事件承載中沒有具有指定名稱的屬性時使用。 |
sourceField |
string |
輸入事件架構中要作為對應來源的功能變數名稱。 |
JsonInputSchemaMapping
這可讓您使用自定義輸入架構發佈至事件方格。 這可用來將自定義輸入 JSON 架構的屬性對應至事件方格事件架構。
名稱 | 類型 | 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
線上的狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
PrivateEndpoint 資訊。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼。 |
PrivateEndpointConnection
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整標識碼。 |
name |
string |
資源名稱。 |
properties.groupIds |
string[] |
來自私人鏈接服務資源的 GroupId。 |
properties.privateEndpoint |
此連線的私人端點資源。 |
|
properties.privateLinkServiceConnectionState |
線上狀態的詳細數據。 |
|
properties.provisioningState |
私人端點聯機的布建狀態。 |
|
type |
string |
資源類型。 |
PublicNetworkAccess
這會判斷是否允許透過公用網路使用流量。 默認會啟用。 您可以藉由設定進一步限制特定IP
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
私人端點聯機的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |
UserIdentityProperties
使用者身分識別的相關信息。
名稱 | 類型 | Description |
---|---|---|
clientId |
string |
使用者指派身分識別的用戶端標識碼。 |
principalId |
string |
使用者指派身分識別的主體標識碼。 |