Domains - Create Or Update

Etki alanı oluşturun veya güncelleştirin.
Belirtilen parametrelerle yeni bir etki alanını zaman uyumsuz olarak oluşturur veya güncelleştirir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
domainName
path True

string

Etki alanının adı.

resourceGroupName
path True

string

Kullanıcının aboneliğindeki kaynak grubunun adı.

subscriptionId
path True

string

Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.

api-version
query True

string

İstemci isteğiyle kullanılacak API'nin sürümü.

İstek Gövdesi

Name Gerekli Tür Description
location True

string

Kaynağın konumu.

identity

IdentityInfo

Event Grid Etki Alanı kaynağı için kimlik bilgileri.

properties.autoCreateTopicWithFirstSubscription

boolean

Bu Boole değeri, bu Event Grid Etki Alanı kaynağıyla ilişkili Event Grid Etki Alanı Konularının 'tümü' için oluşturma mekanizmasını belirtmek için kullanılır. Bu bağlamda, etki alanı konusunun oluşturulması otomatik olarak yönetilebilir (doğru olduğunda) veya kendi kendine yönetilebilir (yanlış olduğunda). Bu özelliğin varsayılan değeri true'dur. Bu özellik null veya true olarak ayarlandığında Event Grid, etki alanı konusunun kapsamında ilk olay aboneliği oluşturulduğunda etki alanı konusunu otomatik olarak oluşturmakla sorumludur. Bu özellik false olarak ayarlanırsa, ilk olay aboneliğini oluşturmak için kullanıcı tarafından bir etki alanı konusu oluşturulması gerekir. Otomatik yönetim modu, kullanıcı etki alanı konusunun ne zaman oluşturulduğunu tam olarak denetlemek istiyorsa kullanılabilirken, otomatik yönetilen mod daha az işlem gerçekleştirme ve kullanıcı tarafından daha az kaynak yönetme esnekliği sağlar. Ayrıca, otomatik yönetilen oluşturma modunda kullanıcının gerekirse etki alanı konusunu isteğe bağlı olarak oluşturmasına izin verileceğini unutmayın.

properties.autoDeleteTopicWithLastSubscription

boolean

Bu Boole değeri, bu Event Grid Etki Alanı kaynağıyla ilişkili Event Grid Etki Alanı Konularının 'tümü' için silme mekanizmasını belirtmek için kullanılır. Bu bağlamda, etki alanı konusunun silinmesi otomatik olarak yönetilebilir (doğru olduğunda) veya kendi kendine yönetilebilir (yanlış olduğunda). Bu özelliğin varsayılan değeri true'dur. Bu özellik true olarak ayarlandığında, etki alanı konusunun kapsamındaki son olay aboneliği silindiğinde Event Grid etki alanı konusunu otomatik olarak silmekle sorumludur. Bu özellik false olarak ayarlanırsa, kullanıcının artık gerekli olmadığında etki alanı konusunu el ile silmesi gerekir (örneğin, son olay aboneliği silindiğinde ve kaynağın temizlenmesi gerektiğinde). Otomatik yönetim modu, kullanıcı etki alanı konusunun ne zaman silinmesi gerektiğini tam olarak denetlemek istediğinde kullanılabilirken, otomatik yönetilen mod daha az işlem gerçekleştirme ve kullanıcı tarafından daha az kaynak yönetme esnekliği sağlar.

properties.dataResidencyBoundary

DataResidencyBoundary

kaynağın Data Residency Sınırı.

properties.disableLocalAuth

boolean

Bu boole yerel kimlik doğrulamasını etkinleştirmek veya devre dışı bırakmak için kullanılır. Varsayılan değer false'tur. Özellik true olarak ayarlandığında, kullanıcının etki alanında yayımlamasına izin veriliyorsa kimlik doğrulaması için yalnızca AAD belirteci kullanılır.

properties.inboundIpRules

InboundIpRule[]

Bu, tüm IP'ler yerine belirli IP'lerden gelen trafiği kısıtlamak için kullanılabilir. Not: Bunlar yalnızca PublicNetworkAccess etkinleştirildiğinde dikkate alınır.

properties.inputSchema

InputSchema

Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Eşleme olayı yükü hakkındaki bilgileri belirten InputSchemaMapping hakkında bilgiler.

properties.publicNetworkAccess

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

tags

object

Kaynağın etiketleri.

Yanıtlar

Name Tür Description
201 Created

Domain

Oluşturulan

Other Status Codes

Hata Yanıtları: **

  • 400 Hatalı İstek.

  • 500 İç Sunucu Hatası.

Örnekler

Domains_CreateOrUpdate

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
ConnectionState

ConnectionState bilgileri.

createdByType

Kaynağı oluşturan kimliğin türü.

DataResidencyBoundary

kaynağın Data Residency Sınırı.

Domain

EventGrid Etki Alanı.

DomainProvisioningState

Event Grid Etki Alanı Kaynağının sağlama durumu.

IdentityInfo

Kaynağın kimlik bilgileri.

IdentityType

Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü tüm kimlikleri kaldırır.

InboundIpRule
InputSchema

Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.

IpActionType

IpMask eşleşmesine dayalı olarak gerçekleştirilecek eylem veya eşleşme yok.

JsonField

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'id', 'topic' ve 'eventtime' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasındaki bir alanı temsil eder.

JsonFieldWithDefault

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'subject', 'eventtype' ve 'dataversion' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasında kullanılacak varsayılan değerle birlikte bir alanı temsil eder ve bu iki özelliğin en az biri sağlanmalıdır.

JsonInputSchemaMapping

Bu, özel bir giriş şeması kullanarak Event Grid'de yayımlamayı etkinleştirir. Bu, özellikleri özel giriş JSON şemasından Event Grid olay şemasına eşlemek için kullanılabilir.

PersistedConnectionStatus

Bağlantının durumu.

PrivateEndpoint

PrivateEndpoint bilgileri.

PrivateEndpointConnection
PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

ResourceProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

UserIdentityProperties

Kullanıcı kimliği hakkındaki bilgiler.

ConnectionState

ConnectionState bilgileri.

Name Tür Description
actionsRequired

string

Gerekli eylemler (varsa).

description

string

Bağlantı durumunun açıklaması.

status

PersistedConnectionStatus

Bağlantının durumu.

createdByType

Kaynağı oluşturan kimliğin türü.

Name Tür Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

kaynağın Data Residency Sınırı.

Name Tür Description
WithinGeopair

string

WithinRegion

string

Domain

EventGrid Etki Alanı.

Name Tür Default value Description
id

string

Kaynağın tam tanımlayıcısı.

identity

IdentityInfo

Event Grid Etki Alanı kaynağı için kimlik bilgileri.

location

string

Kaynağın konumu.

name

string

Kaynağın adı.

properties.autoCreateTopicWithFirstSubscription

boolean

True

Bu Boole değeri, bu Event Grid Etki Alanı kaynağıyla ilişkili Event Grid Etki Alanı Konularının 'tümü' için oluşturma mekanizmasını belirtmek için kullanılır. Bu bağlamda, etki alanı konusunun oluşturulması otomatik olarak yönetilebilir (doğru olduğunda) veya kendi kendine yönetilebilir (yanlış olduğunda). Bu özelliğin varsayılan değeri true'dur. Bu özellik null veya true olarak ayarlandığında Event Grid, etki alanı konusunun kapsamında ilk olay aboneliği oluşturulduğunda etki alanı konusunu otomatik olarak oluşturmakla sorumludur. Bu özellik false olarak ayarlanırsa, ilk olay aboneliğini oluşturmak için kullanıcı tarafından bir etki alanı konusu oluşturulması gerekir. Otomatik yönetim modu, kullanıcı etki alanı konusunun ne zaman oluşturulduğunu tam olarak denetlemek istiyorsa kullanılabilirken, otomatik yönetilen mod daha az işlem gerçekleştirme ve kullanıcı tarafından daha az kaynak yönetme esnekliği sağlar. Ayrıca, otomatik yönetilen oluşturma modunda kullanıcının gerekirse etki alanı konusunu isteğe bağlı olarak oluşturmasına izin verileceğini unutmayın.

properties.autoDeleteTopicWithLastSubscription

boolean

True

Bu Boole değeri, bu Event Grid Etki Alanı kaynağıyla ilişkili Event Grid Etki Alanı Konularının 'tümü' için silme mekanizmasını belirtmek için kullanılır. Bu bağlamda, etki alanı konusunun silinmesi otomatik olarak yönetilebilir (doğru olduğunda) veya kendi kendine yönetilebilir (yanlış olduğunda). Bu özelliğin varsayılan değeri true'dur. Bu özellik true olarak ayarlandığında, etki alanı konusunun kapsamındaki son olay aboneliği silindiğinde Event Grid etki alanı konusunu otomatik olarak silmekle sorumludur. Bu özellik false olarak ayarlanırsa, kullanıcının artık gerekli olmadığında etki alanı konusunu el ile silmesi gerekir (örneğin, son olay aboneliği silindiğinde ve kaynağın temizlenmesi gerektiğinde). Otomatik yönetim modu, kullanıcı etki alanı konusunun ne zaman silinmesi gerektiğini tam olarak denetlemek istediğinde kullanılabilirken, otomatik yönetilen mod daha az işlem gerçekleştirme ve kullanıcı tarafından daha az kaynak yönetme esnekliği sağlar.

properties.dataResidencyBoundary

DataResidencyBoundary

kaynağın Data Residency Sınırı.

properties.disableLocalAuth

boolean

False

Bu boole yerel kimlik doğrulamasını etkinleştirmek veya devre dışı bırakmak için kullanılır. Varsayılan değer false'tur. Özellik true olarak ayarlandığında, kullanıcının etki alanında yayımlamasına izin veriliyorsa kimlik doğrulaması için yalnızca AAD belirteci kullanılır.

properties.endpoint

string

Olayları yayımlamak için kullanılan Event Grid Etki Alanı Kaynağı uç noktası.

properties.inboundIpRules

InboundIpRule[]

Bu, tüm IP'ler yerine belirli IP'lerden gelen trafiği kısıtlamak için kullanılabilir. Not: Bunlar yalnızca PublicNetworkAccess etkinleştirildiğinde dikkate alınır.

properties.inputSchema

InputSchema

EventGridSchema

Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

Eşleme olayı yükü hakkındaki bilgileri belirten InputSchemaMapping hakkında bilgiler.

properties.metricResourceId

string

Event Grid Etki Alanı Kaynağı için ölçüm kaynak kimliği.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Özel uç nokta bağlantılarının listesi.

properties.provisioningState

DomainProvisioningState

Event Grid Etki Alanı Kaynağının sağlama durumu.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

systemData

systemData

Event Grid Etki Alanı kaynağıyla ilgili sistem meta verileri.

tags

object

Kaynağın etiketleri.

type

string

Kaynağın türü.

DomainProvisioningState

Event Grid Etki Alanı Kaynağının sağlama durumu.

Name Tür Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

IdentityInfo

Kaynağın kimlik bilgileri.

Name Tür Description
principalId

string

Kaynak kimliğinin asıl kimliği.

tenantId

string

Kaynağın kiracı kimliği.

type

IdentityType

Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü tüm kimlikleri kaldırır.

userAssignedIdentities

<string,  UserIdentityProperties>

Kaynakla ilişkili kullanıcı kimliklerinin listesi. Kullanıcı kimliği sözlüğü anahtarı başvuruları şu formda ARM kaynak kimlikleri olacaktır: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Bu özellik şu anda kullanılmamaktadır ve gelecekteki kullanım için ayrılmıştır.

IdentityType

Kullanılan yönetilen kimliğin türü. 'SystemAssigned, UserAssigned' türü hem örtük olarak oluşturulmuş bir kimliği hem de kullanıcı tarafından atanan bir kimlik kümesini içerir. 'Hiçbiri' türü tüm kimlikleri kaldırır.

Name Tür Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

Name Tür Description
action

IpActionType

IpMask eşleşmesine dayalı olarak gerçekleştirilecek eylem veya eşleşme yok.

ipMask

string

CIDR gösteriminde IP Adresi; örneğin, 10.0.0.0/8.

InputSchema

Bu, Event Grid'in Event Grid Etki Alanı Kaynağı'nda yayımlanan gelen olaylar için beklemesi gereken biçimi belirler.

Name Tür Description
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

IpMask eşleşmesine dayalı olarak gerçekleştirilecek eylem veya eşleşme yok.

Name Tür Description
Allow

string

JsonField

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'id', 'topic' ve 'eventtime' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasındaki bir alanı temsil eder.

Name Tür Description
sourceField

string

Eşlemenin kaynağı olarak kullanılacak giriş olayı şemasındaki bir alanın adı.

JsonFieldWithDefault

Bu, Event Grid Olay şemasındaki tek bir hedef alan için giriş şeması eşlemesinin kaynağını ifade etmek için kullanılır. Bu, şu anda 'subject', 'eventtype' ve 'dataversion' özellikleri için eşlemelerde kullanılır. Bu, giriş olayı şemasında kullanılacak varsayılan değerle birlikte bir alanı temsil eder ve bu iki özelliğin en az biri sağlanmalıdır.

Name Tür Description
defaultValue

string

SourceField sağlanmadığında veya yayımlanan JSON olay yükünde belirtilen ada sahip bir özellik olmadığında eşleme için kullanılacak varsayılan değer.

sourceField

string

Eşlemenin kaynağı olarak kullanılacak giriş olayı şemasındaki bir alanın adı.

JsonInputSchemaMapping

Bu, özel bir giriş şeması kullanarak Event Grid'de yayımlamayı etkinleştirir. Bu, özellikleri özel giriş JSON şemasından Event Grid olay şemasına eşlemek için kullanılabilir.

Name Tür Description
inputSchemaMappingType string:

Json

Özel eşleme türü

properties.dataVersion

JsonFieldWithDefault

Event Grid Olayının DataVersion özelliği için eşleme bilgileri.

properties.eventTime

JsonField

Event Grid Olayının EventTime özelliği için eşleme bilgileri.

properties.eventType

JsonFieldWithDefault

Event Grid Olayının EventType özelliği için eşleme bilgileri.

properties.id

JsonField

Event Grid Olayının Id özelliği için eşleme bilgileri.

properties.subject

JsonFieldWithDefault

Event Grid Olayının Subject özelliği için eşleme bilgileri.

properties.topic

JsonField

Event Grid Olayının Topic özelliği için eşleme bilgileri.

PersistedConnectionStatus

Bağlantının durumu.

Name Tür Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint bilgileri.

Name Tür Description
id

string

Özel Uç Nokta için ARM tanımlayıcısı.

PrivateEndpointConnection

Name Tür Description
id

string

Kaynağın tam tanımlayıcısı.

name

string

Kaynağın adı.

properties.groupIds

string[]

Özel bağlantı hizmeti kaynağındaki GroupId'ler.

properties.privateEndpoint

PrivateEndpoint

Bu Bağlantı için Özel Uç Nokta kaynağı.

properties.privateLinkServiceConnectionState

ConnectionState

Bağlantının durumuyla ilgili ayrıntılar.

properties.provisioningState

ResourceProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

type

string

Kaynağın türü.

PublicNetworkAccess

Bu, genel ağ üzerinden trafiğe izin verilip verilmediğini belirler. Varsayılan olarak etkindir. Yapılandırarak belirli IP'leri daha da kısıtlayabilirsiniz

Name Tür Description
Disabled

string

Enabled

string

ResourceProvisioningState

Özel Uç Nokta Bağlantısının sağlama durumu.

Name Tür Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name Tür Description
createdAt

string

Kaynak oluşturma (UTC) zaman damgası.

createdBy

string

Kaynağı oluşturan kimlik.

createdByType

createdByType

Kaynağı oluşturan kimliğin türü.

lastModifiedAt

string

Kaynağın son değişikliğinin zaman damgası (UTC)

lastModifiedBy

string

Kaynağı son değiştiren kimlik.

lastModifiedByType

createdByType

Kaynağı en son değiştiren kimliğin türü.

UserIdentityProperties

Kullanıcı kimliği hakkındaki bilgiler.

Name Tür Description
clientId

string

Kullanıcı tarafından atanan kimliğin istemci kimliği.

principalId

string

Kullanıcı tarafından atanan kimliğin asıl kimliği.