Domains - Create Or Update
Создание или обновление домена.
Асинхронно создает или обновляет новый домен с указанными параметрами.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
domain
|
path | True |
string |
Имя домена. |
resource
|
path | True |
string |
Имя группы ресурсов в подписке пользователя. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API для использования с клиентским запросом. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
location | True |
string |
Расположение ресурса. |
identity |
Сведения об удостоверениях для ресурса домена Сетки событий. |
||
properties.autoCreateTopicWithFirstSubscription |
boolean |
Этот логический код используется для указания механизма создания для всех разделов домена Сетки событий, связанных с этим ресурсом домена Сетки событий. В этом контексте создание раздела домена может быть автоматическим (при значении true) или самоуправляемым (при значении false). Значение этого свойства по умолчанию — true. Если это свойство имеет значение NULL или имеет значение true, сетка событий отвечает за автоматическое создание раздела домена при создании первой подписки на события в область раздела домена. Если для этого свойства задано значение false, то для создания первой подписки на события пользователю потребуется создать раздел домена. Режим самостоятельного управления можно использовать, если пользователю требуется полный контроль над созданием раздела домена, в то время как режим автоматического управления обеспечивает гибкость для выполнения меньшего количества операций и управления меньшим количеством ресурсов пользователем. Кроме того, обратите внимание, что в режиме автоматического создания пользователь может при необходимости создавать раздел домена по запросу. |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
Этот логический код используется для указания механизма удаления для всех разделов домена Сетки событий, связанных с этим ресурсом домена Сетки событий. В этом контексте удаление раздела домена может быть автоматическим (при значении true) или самоуправляемым (при значении false). Значение этого свойства по умолчанию — true. Если для этого свойства задано значение true, сетка событий отвечает за автоматическое удаление раздела домена при удалении последней подписки на событие в область раздела домена. Если для этого свойства задано значение 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 |
Теги ресурса. |
Ответы
Имя | Тип | Описание |
---|---|---|
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"
}
Определения
Имя | Описание |
---|---|
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 |
Сведения о частной конечной точке. |
Private |
|
Public |
Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Можно дополнительно ограничить определенными IP-адресами, настроив |
Resource |
Состояние подготовки подключения к частной конечной точке. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
User |
Сведения об удостоверении пользователя. |
ConnectionState
Сведения о connectionState.
Имя | Тип | Описание |
---|---|---|
actionsRequired |
string |
Требуются действия (если таковые есть). |
description |
string |
Описание состояния подключения. |
status |
Состояние подключения. |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency граница ресурса.
Имя | Тип | Описание |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
Домен EventGrid.
Имя | Тип | Default value | Описание |
---|---|---|---|
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
Состояние подготовки ресурса домена Сетки событий.
Имя | Тип | Описание |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
Сведения об удостоверении ресурса.
Имя | Тип | Описание |
---|---|---|
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 приведет к удалению всех удостоверений.
Имя | Тип | Описание |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Имя | Тип | Описание |
---|---|---|
action |
Действие для выполнения на основе совпадения или отсутствия совпадения IpMask. |
|
ipMask |
string |
IP-адрес в нотации CIDR, например 10.0.0.0/8. |
InputSchema
Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в ресурсе домена Сетки событий.
Имя | Тип | Описание |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Действие для выполнения на основе совпадения или отсутствия совпадения IpMask.
Имя | Тип | Описание |
---|---|---|
Allow |
string |
JsonField
Используется для выражения источника сопоставления входной схемы для одного целевого поля в схеме событий Сетки событий. В настоящее время используется в сопоставлениях для свойств "id", "topic" и "eventtime". Представляет поле во входной схеме события.
Имя | Тип | Описание |
---|---|---|
sourceField |
string |
Имя поля во входной схеме событий, которое будет использоваться в качестве источника сопоставления. |
JsonFieldWithDefault
Используется для выражения источника сопоставления входной схемы для одного целевого поля в схеме событий Сетки событий. В настоящее время используется в сопоставлениях для свойств "subject", "eventtype" и "dataversion". Он представляет поле во входной схеме событий вместе со значением по умолчанию, которое необходимо использовать, и должно быть предоставлено по крайней мере одно из этих двух свойств.
Имя | Тип | Описание |
---|---|---|
defaultValue |
string |
Значение по умолчанию, используемое для сопоставления, если sourceField не предоставлен или если в опубликованных полезных данных события JSON нет свойства с указанным именем. |
sourceField |
string |
Имя поля во входной схеме событий, которое будет использоваться в качестве источника сопоставления. |
JsonInputSchemaMapping
Это позволяет публиковать данные в Сетке событий с помощью пользовательской входной схемы. Его можно использовать для сопоставления свойств из пользовательской входной схемы JSON со схемой событий Сетки событий.
Имя | Тип | Описание |
---|---|---|
inputSchemaMappingType |
string:
Json |
Тип настраиваемого сопоставления |
properties.dataVersion |
Сведения о сопоставлении для свойства DataVersion события Сетки событий. |
|
properties.eventTime |
Сведения о сопоставлении для свойства EventTime события Сетки событий. |
|
properties.eventType |
Сведения о сопоставлении для свойства EventType события Сетки событий. |
|
properties.id |
Сведения о сопоставлении для свойства Id события Сетки событий. |
|
properties.subject |
Сведения о сопоставлении для свойства Subject события Сетки событий. |
|
properties.topic |
Сведения о сопоставлении для свойства Topic события Сетки событий. |
PersistedConnectionStatus
Состояние подключения.
Имя | Тип | Описание |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
Сведения о частной конечной точке.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ARM для частной конечной точки. |
PrivateEndpointConnection
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. |
name |
string |
Имя ресурса. |
properties.groupIds |
string[] |
GroupIds из ресурса службы приватного канала. |
properties.privateEndpoint |
Ресурс частной конечной точки для этого подключения. |
|
properties.privateLinkServiceConnectionState |
Сведения о состоянии подключения. |
|
properties.provisioningState |
Состояние подготовки подключения к частной конечной точке. |
|
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 |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое последним изменял ресурс. |
lastModifiedByType |
Тип удостоверения, которое последним изменял ресурс. |
UserIdentityProperties
Сведения об удостоверении пользователя.
Имя | Тип | Описание |
---|---|---|
clientId |
string |
Идентификатор клиента удостоверения, назначаемого пользователем. |
principalId |
string |
Идентификатор субъекта удостоверения, назначаемого пользователем. |