Bagikan melalui


Domains - Create Or Update

Membuat atau memperbarui domain.
Secara asinkron membuat atau memperbarui domain baru dengan parameter yang ditentukan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
domainName
path True

string

Nama domain.

resourceGroupName
path True

string

Nama grup sumber daya dalam langganan pengguna.

subscriptionId
path True

string

Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan klien.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
location True

string

Lokasi sumber daya.

identity

IdentityInfo

Informasi identitas untuk sumber daya Domain Event Grid.

properties.autoCreateTopicWithFirstSubscription

boolean

Boolean ini digunakan untuk menentukan mekanisme pembuatan untuk 'semua' Topik Domain Event Grid yang terkait dengan sumber daya Domain Event Grid ini. Dalam konteks ini, pembuatan topik domain dapat dikelola secara otomatis (jika benar) atau dikelola sendiri (saat false). Nilai default untuk properti ini adalah true. Ketika properti ini null atau diatur ke true, Event Grid bertanggung jawab untuk secara otomatis membuat topik domain saat langganan peristiwa pertama dibuat pada cakupan topik domain. Jika properti ini diatur ke false, maka membuat langganan peristiwa pertama akan memerlukan pembuatan topik domain oleh pengguna. Mode manajemen mandiri dapat digunakan jika pengguna menginginkan kontrol penuh ketika topik domain dibuat, sementara mode terkelola otomatis memberikan fleksibilitas untuk melakukan lebih sedikit operasi dan mengelola lebih sedikit sumber daya oleh pengguna. Selain itu, perhatikan bahwa dalam mode pembuatan yang dikelola secara otomatis, pengguna diizinkan untuk membuat topik domain sesuai permintaan jika diperlukan.

properties.autoDeleteTopicWithLastSubscription

boolean

Boolean ini digunakan untuk menentukan mekanisme penghapusan untuk 'semua' Topik Domain Event Grid yang terkait dengan sumber daya Domain Event Grid ini. Dalam konteks ini, penghapusan topik domain dapat dikelola secara otomatis (jika benar) atau dikelola sendiri (saat false). Nilai default untuk properti ini adalah true. Ketika properti ini diatur ke true, Event Grid bertanggung jawab untuk secara otomatis menghapus topik domain saat langganan peristiwa terakhir di cakupan topik domain dihapus. Jika properti ini diatur ke false, maka pengguna perlu menghapus topik domain secara manual ketika tidak lagi diperlukan (misalnya, ketika langganan peristiwa terakhir dihapus dan sumber daya perlu dibersihkan). Mode manajemen mandiri dapat digunakan jika pengguna menginginkan kontrol penuh ketika topik domain perlu dihapus, sementara mode terkelola otomatis memberikan fleksibilitas untuk melakukan lebih sedikit operasi dan mengelola lebih sedikit sumber daya oleh pengguna.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Batas sumber daya.

properties.disableLocalAuth

boolean

Boolean ini digunakan untuk mengaktifkan atau menonaktifkan autentikasi lokal. Nilai defaultnya adalah false. Ketika properti diatur ke true, hanya token AAD yang akan digunakan untuk mengautentikasi jika pengguna diizinkan untuk menerbitkan ke domain.

properties.inboundIpRules

InboundIpRule[]

Ini dapat digunakan untuk membatasi lalu lintas dari IP tertentu, bukan semua IP. Catatan: Ini hanya dipertimbangkan jika PublicNetworkAccess diaktifkan.

properties.inputSchema

InputSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informasi tentang InputSchemaMapping yang menentukan info tentang pemetaan payload peristiwa.

properties.publicNetworkAccess

PublicNetworkAccess

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

tags

object

Tag sumber daya.

Respons

Nama Jenis Deskripsi
201 Created

Domain

Dibuat

Other Status Codes

Respons Kesalahan: ***

  • 400 Permintaan Buruk.

  • 500 Kesalahan Server Internal.

Contoh

Domains_CreateOrUpdate

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
ConnectionState

Informasi ConnectionState.

createdByType

Jenis identitas yang membuat sumber daya.

DataResidencyBoundary

Data Residency Batas sumber daya.

Domain

Domain EventGrid.

DomainProvisioningState

Status provisi Sumber Daya Domain Event Grid.

IdentityInfo

Informasi identitas untuk sumber daya.

IdentityType

Jenis identitas terkelola yang digunakan. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun.

InboundIpRule
InputSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

IpActionType

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan IpMask.

JsonField

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Saat ini digunakan dalam pemetaan untuk properti 'id', 'topik' dan 'eventtime'. Ini mewakili bidang dalam skema peristiwa input.

JsonFieldWithDefault

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Saat ini digunakan dalam pemetaan untuk properti 'subjek', 'eventtype' dan 'dataversion'. Ini mewakili bidang dalam skema peristiwa input bersama dengan nilai default yang akan digunakan, dan setidaknya salah satu dari dua properti ini harus disediakan.

JsonInputSchemaMapping

Ini memungkinkan penerbitan ke Event Grid menggunakan skema input kustom. Ini dapat digunakan untuk memetakan properti dari skema JSON input kustom ke skema peristiwa Event Grid.

PersistedConnectionStatus

Status koneksi.

PrivateEndpoint

Informasi PrivateEndpoint.

PrivateEndpointConnection
PublicNetworkAccess

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

ResourceProvisioningState

Status provisi Koneksi Titik Akhir Privat.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

UserIdentityProperties

Informasi tentang identitas pengguna.

ConnectionState

Informasi ConnectionState.

Nama Jenis Deskripsi
actionsRequired

string

Tindakan diperlukan (jika ada).

description

string

Deskripsi status koneksi.

status

PersistedConnectionStatus

Status koneksi.

createdByType

Jenis identitas yang membuat sumber daya.

Nama Jenis Deskripsi
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

Data Residency Batas sumber daya.

Nama Jenis Deskripsi
WithinGeopair

string

WithinRegion

string

Domain

Domain EventGrid.

Nama Jenis Nilai default Deskripsi
id

string

Pengidentifikasi sumber daya yang sepenuhnya memenuhi syarat.

identity

IdentityInfo

Informasi identitas untuk sumber daya Domain Event Grid.

location

string

Lokasi sumber daya.

name

string

Nama sumber daya.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Boolean ini digunakan untuk menentukan mekanisme pembuatan untuk 'semua' Topik Domain Event Grid yang terkait dengan sumber daya Domain Event Grid ini. Dalam konteks ini, pembuatan topik domain dapat dikelola secara otomatis (jika benar) atau dikelola sendiri (saat false). Nilai default untuk properti ini adalah true. Ketika properti ini null atau diatur ke true, Event Grid bertanggung jawab untuk secara otomatis membuat topik domain saat langganan peristiwa pertama dibuat pada cakupan topik domain. Jika properti ini diatur ke false, maka membuat langganan peristiwa pertama akan memerlukan pembuatan topik domain oleh pengguna. Mode manajemen mandiri dapat digunakan jika pengguna menginginkan kontrol penuh ketika topik domain dibuat, sementara mode terkelola otomatis memberikan fleksibilitas untuk melakukan lebih sedikit operasi dan mengelola lebih sedikit sumber daya oleh pengguna. Selain itu, perhatikan bahwa dalam mode pembuatan yang dikelola secara otomatis, pengguna diizinkan untuk membuat topik domain sesuai permintaan jika diperlukan.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Boolean ini digunakan untuk menentukan mekanisme penghapusan untuk 'semua' Topik Domain Event Grid yang terkait dengan sumber daya Domain Event Grid ini. Dalam konteks ini, penghapusan topik domain dapat dikelola secara otomatis (jika benar) atau dikelola sendiri (saat false). Nilai default untuk properti ini adalah true. Ketika properti ini diatur ke true, Event Grid bertanggung jawab untuk secara otomatis menghapus topik domain saat langganan peristiwa terakhir di cakupan topik domain dihapus. Jika properti ini diatur ke false, maka pengguna perlu menghapus topik domain secara manual ketika tidak lagi diperlukan (misalnya, ketika langganan peristiwa terakhir dihapus dan sumber daya perlu dibersihkan). Mode manajemen mandiri dapat digunakan jika pengguna menginginkan kontrol penuh ketika topik domain perlu dihapus, sementara mode terkelola otomatis memberikan fleksibilitas untuk melakukan lebih sedikit operasi dan mengelola lebih sedikit sumber daya oleh pengguna.

properties.dataResidencyBoundary

DataResidencyBoundary

Data Residency Batas sumber daya.

properties.disableLocalAuth

boolean

False

Boolean ini digunakan untuk mengaktifkan atau menonaktifkan autentikasi lokal. Nilai defaultnya adalah false. Ketika properti diatur ke true, hanya token AAD yang akan digunakan untuk mengautentikasi jika pengguna diizinkan untuk menerbitkan ke domain.

properties.endpoint

string

Titik akhir untuk Sumber Daya Domain Event Grid yang digunakan untuk menerbitkan peristiwa.

properties.inboundIpRules

InboundIpRule[]

Ini dapat digunakan untuk membatasi lalu lintas dari IP tertentu, bukan semua IP. Catatan: Ini hanya dipertimbangkan jika PublicNetworkAccess diaktifkan.

properties.inputSchema

InputSchema

EventGridSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Informasi tentang InputSchemaMapping yang menentukan info tentang pemetaan payload peristiwa.

properties.metricResourceId

string

Id sumber daya metrik untuk Sumber Daya Domain Event Grid.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Daftar koneksi titik akhir privat.

properties.provisioningState

DomainProvisioningState

Status provisi Sumber Daya Domain Event Grid.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

systemData

systemData

Metadata sistem yang berkaitan dengan sumber daya Domain Event Grid.

tags

object

Tag sumber daya.

type

string

Jenis sumber daya.

DomainProvisioningState

Status provisi Sumber Daya Domain Event Grid.

Nama Jenis Deskripsi
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

Informasi identitas untuk sumber daya.

Nama Jenis Deskripsi
principalId

string

ID utama identitas sumber daya.

tenantId

string

ID penyewa sumber daya.

type

IdentityType

Jenis identitas terkelola yang digunakan. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun.

userAssignedIdentities

<string,  UserIdentityProperties>

Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Properti ini saat ini tidak digunakan dan dicadangkan untuk penggunaan di masa mendatang.

IdentityType

Jenis identitas terkelola yang digunakan. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun.

Nama Jenis Deskripsi
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Nama Jenis Deskripsi
action

IpActionType

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan IpMask.

ipMask

string

Alamat IP dalam notasi CIDR misalnya, 10.0.0.0/8.

InputSchema

Ini menentukan format yang harus diharapkan Event Grid untuk peristiwa masuk yang diterbitkan ke Sumber Daya Domain Event Grid.

Nama Jenis Deskripsi
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

Tindakan yang harus dilakukan berdasarkan kecocokan atau tidak ada kecocokan IpMask.

Nama Jenis Deskripsi
Allow

string

JsonField

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Saat ini digunakan dalam pemetaan untuk properti 'id', 'topik' dan 'eventtime'. Ini mewakili bidang dalam skema peristiwa input.

Nama Jenis Deskripsi
sourceField

string

Nama bidang dalam skema peristiwa input yang akan digunakan sebagai sumber pemetaan.

JsonFieldWithDefault

Ini digunakan untuk mengekspresikan sumber pemetaan skema input untuk satu bidang target dalam skema Peristiwa Event Grid. Saat ini digunakan dalam pemetaan untuk properti 'subjek', 'eventtype' dan 'dataversion'. Ini mewakili bidang dalam skema peristiwa input bersama dengan nilai default yang akan digunakan, dan setidaknya salah satu dari dua properti ini harus disediakan.

Nama Jenis Deskripsi
defaultValue

string

Nilai default yang akan digunakan untuk pemetaan ketika SourceField tidak disediakan atau jika tidak ada properti dengan nama yang ditentukan dalam payload peristiwa JSON yang diterbitkan.

sourceField

string

Nama bidang dalam skema peristiwa input yang akan digunakan sebagai sumber pemetaan.

JsonInputSchemaMapping

Ini memungkinkan penerbitan ke Event Grid menggunakan skema input kustom. Ini dapat digunakan untuk memetakan properti dari skema JSON input kustom ke skema peristiwa Event Grid.

Nama Jenis Deskripsi
inputSchemaMappingType string:

Json

Jenis pemetaan kustom

properties.dataVersion

JsonFieldWithDefault

Informasi pemetaan untuk properti DataVersion dari Peristiwa Event Grid.

properties.eventTime

JsonField

Informasi pemetaan untuk properti EventTime dari Event Grid Event.

properties.eventType

JsonFieldWithDefault

Informasi pemetaan untuk properti EventType dari Event Grid Event.

properties.id

JsonField

Informasi pemetaan untuk properti Id dari Peristiwa Event Grid.

properties.subject

JsonFieldWithDefault

Informasi pemetaan untuk properti Subjek dari Peristiwa Event Grid.

properties.topic

JsonField

Informasi pemetaan untuk properti Topik dari Peristiwa Event Grid.

PersistedConnectionStatus

Status koneksi.

Nama Jenis Deskripsi
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

Informasi PrivateEndpoint.

Nama Jenis Deskripsi
id

string

Pengidentifikasi ARM untuk Titik Akhir Privat.

PrivateEndpointConnection

Nama Jenis Deskripsi
id

string

Pengidentifikasi sumber daya yang sepenuhnya memenuhi syarat.

name

string

Nama sumber daya.

properties.groupIds

string[]

GroupIds dari sumber daya layanan tautan privat.

properties.privateEndpoint

PrivateEndpoint

Sumber daya Titik Akhir Privat untuk Koneksi ini.

properties.privateLinkServiceConnectionState

ConnectionState

Detail tentang status koneksi.

properties.provisioningState

ResourceProvisioningState

Status provisi Koneksi Titik Akhir Privat.

type

string

Jenis sumber daya.

PublicNetworkAccess

Ini menentukan apakah lalu lintas diizinkan melalui jaringan publik. Secara default diaktifkan. Anda dapat membatasi IP tertentu lebih lanjut dengan mengonfigurasi

Nama Jenis Deskripsi
Disabled

string

Enabled

string

ResourceProvisioningState

Status provisi Koneksi Titik Akhir Privat.

Nama Jenis Deskripsi
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir mengubah sumber daya.

UserIdentityProperties

Informasi tentang identitas pengguna.

Nama Jenis Deskripsi
clientId

string

Id klien identitas yang ditetapkan pengguna.

principalId

string

Id utama identitas yang ditetapkan pengguna.