Domains - Create Or Update
Skapa eller uppdatera en domän.
Skapar eller uppdaterar asynkront en ny domän med de angivna parametrarna.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}?api-version=2022-06-15
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
domain
|
path | True |
string |
Namnet på domänen. |
resource
|
path | True |
string |
Namnet på resursgruppen i användarens prenumeration. |
subscription
|
path | True |
string |
Autentiseringsuppgifter för prenumeration som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop. |
api-version
|
query | True |
string |
Version av API:et som ska användas med klientbegäran. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
location | True |
string |
Platsen för resursen. |
identity |
Identitetsinformation för Event Grid-domänresursen. |
||
properties.autoCreateTopicWithFirstSubscription |
boolean |
Det här booleska objektet används för att ange skapandemekanismen för "alla" Event Grid-domänämnen som är associerade med den här Event Grid-domänresursen. I det här sammanhanget kan skapandet av domänämne hanteras automatiskt (när det är sant) eller självhanterat (när falskt). Standardvärdet för den här egenskapen är true. När den här egenskapen är null eller inställd på true ansvarar Event Grid för att automatiskt skapa domänämnet när den första händelseprenumerationen skapas i omfånget för domänavsnittet. Om den här egenskapen är inställd på false måste användaren skapa ett domänämne för att skapa den första händelseprenumerationen. Självhanteringsläget kan användas om användaren vill ha fullständig kontroll över när domänavsnittet skapas, medan automatiskt hanterat läge ger flexibiliteten att utföra färre åtgärder och hantera färre resurser av användaren. Observera också att i läget för automatiskt hanterad skapande kan användaren skapa domänämnet på begäran om det behövs. |
|
properties.autoDeleteTopicWithLastSubscription |
boolean |
Det här booleska objektet används för att ange borttagningsmekanismen för "alla" Event Grid-domänämnen som är associerade med den här Event Grid-domänresursen. I det här sammanhanget kan borttagning av domänämne hanteras automatiskt (när det är sant) eller självhanterat (när falskt). Standardvärdet för den här egenskapen är true. När den här egenskapen är inställd på true ansvarar Event Grid för att automatiskt ta bort domänämnet när den sista händelseprenumerationen i omfånget för domänavsnittet tas bort. Om den här egenskapen är inställd på false måste användaren manuellt ta bort domänavsnittet när det inte längre behövs (t.ex. när den senaste händelseprenumerationen tas bort och resursen måste rensas). Självhanteringsläget kan användas om användaren vill ha fullständig kontroll över när domänämnet behöver tas bort, medan automatiskt hanterat läge ger flexibiliteten att utföra färre åtgärder och hantera färre resurser av användaren. |
|
properties.dataResidencyBoundary |
Data Residency resursens gräns. |
||
properties.disableLocalAuth |
boolean |
Det här booleska värdet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är false. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till domänen. |
|
properties.inboundIpRules |
Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa beaktas endast om PublicNetworkAccess är aktiverat. |
||
properties.inputSchema |
Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen. |
||
properties.inputSchemaMapping | InputSchemaMapping: |
Information om InputSchemaMapping som angav information om att mappa händelsenyttolasten. |
|
properties.publicNetworkAccess |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera |
||
tags |
object |
Taggar för resursen. |
Svar
Name | Typ | Description |
---|---|---|
201 Created |
Skapad |
|
Other Status Codes |
Felsvar: ***
|
Exempel
Domains_CreateOrUpdate
Exempelbegäran
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"
}
]
}
}
Exempelsvar
{
"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"
}
Definitioner
Name | Description |
---|---|
Connection |
Information om ConnectionState. |
created |
Den typ av identitet som skapade resursen. |
Data |
Data Residency resursens gräns. |
Domain |
EventGrid-domän. |
Domain |
Etableringstillstånd för Event Grid-domänresursen. |
Identity |
Identitetsinformationen för resursen. |
Identity |
Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter. |
Inbound |
|
Input |
Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen. |
Ip |
Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask. |
Json |
Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat. |
Json |
Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "ämne", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges. |
Json |
På så sätt kan du publicera till Event Grid med ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat. |
Persisted |
Status för anslutningen. |
Private |
PrivateEndpoint-information. |
Private |
|
Public |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera |
Resource |
Etableringstillstånd för den privata slutpunktsanslutningen. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
User |
Information om användaridentiteten. |
ConnectionState
Information om ConnectionState.
Name | Typ | Description |
---|---|---|
actionsRequired |
string |
Åtgärder som krävs (om sådana finns). |
description |
string |
Beskrivning av anslutningstillståndet. |
status |
Status för anslutningen. |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataResidencyBoundary
Data Residency resursens gräns.
Name | Typ | Description |
---|---|---|
WithinGeopair |
string |
|
WithinRegion |
string |
Domain
EventGrid-domän.
Name | Typ | Standardvärde | Description |
---|---|---|---|
id |
string |
Fullständigt kvalificerad identifierare för resursen. |
|
identity |
Identitetsinformation för Event Grid-domänresursen. |
||
location |
string |
Platsen för resursen. |
|
name |
string |
Namn på resursen. |
|
properties.autoCreateTopicWithFirstSubscription |
boolean |
True |
Det här booleska objektet används för att ange skapandemekanismen för "alla" Event Grid-domänämnen som är associerade med den här Event Grid-domänresursen. I det här sammanhanget kan skapandet av domänämnet hanteras automatiskt (när det är sant) eller självhanterat (när det är falskt). Standardvärdet för den här egenskapen är sant. När den här egenskapen är null eller inställd på true ansvarar Event Grid för att automatiskt skapa domänämnet när den första händelseprenumerationen skapas i domänämnets omfång. Om den här egenskapen är inställd på false måste användaren skapa en domänämne för att skapa den första händelseprenumerationen. Självhanteringsläget kan användas om användaren vill ha fullständig kontroll över när domänämnet skapas, medan automatiskt hanterat läge ger flexibiliteten att utföra färre åtgärder och hantera färre resurser av användaren. Observera också att i läget för automatiskt hanterad skapande tillåts användaren att skapa domänämnet på begäran om det behövs. |
properties.autoDeleteTopicWithLastSubscription |
boolean |
True |
Det här booleska objektet används för att ange borttagningsmekanismen för "alla" Event Grid-domänämnen som är associerade med den här Event Grid-domänresursen. I det här sammanhanget kan borttagning av domänämnet hanteras automatiskt (när det är sant) eller självhanterat (när det är falskt). Standardvärdet för den här egenskapen är sant. När den här egenskapen är inställd på true ansvarar Event Grid för att automatiskt ta bort domänämnet när den sista händelseprenumerationen i domänämnets omfång tas bort. Om den här egenskapen är inställd på false måste användaren ta bort domänämnet manuellt när det inte längre behövs (t.ex. när den senaste händelseprenumerationen tas bort och resursen måste rensas). Självhanteringsläget kan användas om användaren vill ha fullständig kontroll över när domänämnet behöver tas bort, medan automatiskt hanterat läge ger flexibiliteten att utföra mindre åtgärder och hantera färre resurser av användaren. |
properties.dataResidencyBoundary |
Data Residency resursens gräns. |
||
properties.disableLocalAuth |
boolean |
False |
Det här booleska objektet används för att aktivera eller inaktivera lokal autentisering. Standardvärdet är falskt. När egenskapen är inställd på true används endast AAD-token för att autentisera om användaren tillåts publicera till domänen. |
properties.endpoint |
string |
Slutpunkt för Event Grid-domänresursen som används för att publicera händelserna. |
|
properties.inboundIpRules |
Detta kan användas för att begränsa trafik från specifika IP-adresser i stället för alla IP-adresser. Obs! Dessa betraktas endast om PublicNetworkAccess är aktiverat. |
||
properties.inputSchema | EventGridSchema |
Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen. |
|
properties.inputSchemaMapping | InputSchemaMapping: |
Information om InputSchemaMapping som angav information om nyttolasten för mappningshändelser. |
|
properties.metricResourceId |
string |
Måttresurs-ID för Event Grid-domänresursen. |
|
properties.privateEndpointConnections |
Lista över privata slutpunktsanslutningar. |
||
properties.provisioningState |
Etableringstillstånd för Event Grid-domänresursen. |
||
properties.publicNetworkAccess | Enabled |
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera |
|
systemData |
Systemmetadata som relaterar till Event Grid-domänresursen. |
||
tags |
object |
Taggar för resursen. |
|
type |
string |
Resurstyp. |
DomainProvisioningState
Etableringstillstånd för Event Grid-domänresursen.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
IdentityInfo
Identitetsinformationen för resursen.
Name | Typ | Description |
---|---|---|
principalId |
string |
Huvud-ID för resursidentitet. |
tenantId |
string |
Resursens klientorganisations-ID. |
type |
Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter. |
|
userAssignedIdentities |
<string,
User |
Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Den här egenskapen används för närvarande inte och är reserverad för framtida användning. |
IdentityType
Den typ av hanterad identitet som används. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter.
Name | Typ | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
InboundIpRule
Name | Typ | Description |
---|---|---|
action |
Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask. |
|
ipMask |
string |
IP-adress i CIDR-notation, t.ex. 10.0.0.0/8. |
InputSchema
Detta avgör vilket format Event Grid ska förvänta sig för inkommande händelser som publicerats till Event Grid-domänresursen.
Name | Typ | Description |
---|---|---|
CloudEventSchemaV1_0 |
string |
|
CustomEventSchema |
string |
|
EventGridSchema |
string |
IpActionType
Åtgärd att utföra baserat på matchningen eller ingen matchning av IpMask.
Name | Typ | Description |
---|---|---|
Allow |
string |
JsonField
Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "id", "topic" och "eventtime". Detta representerar ett fält i indatahändelseschemat.
Name | Typ | Description |
---|---|---|
sourceField |
string |
Namn på ett fält i indatahändelseschemat som ska användas som källa för en mappning. |
JsonFieldWithDefault
Detta används för att uttrycka källan för en mappning av indatascheman för ett enda målfält i Event Grid-händelseschemat. Detta används för närvarande i mappningarna för egenskaperna "ämne", "eventtype" och "dataversion". Detta representerar ett fält i indatahändelseschemat tillsammans med ett standardvärde som ska användas, och minst en av dessa två egenskaper bör anges.
Name | Typ | Description |
---|---|---|
defaultValue |
string |
Standardvärdet som ska användas för mappning när ett SourceField inte anges eller om det inte finns någon egenskap med det angivna namnet i den publicerade JSON-händelsenyttolasten. |
sourceField |
string |
Namnet på ett fält i indatahändelseschemat som ska användas som källa för en mappning. |
JsonInputSchemaMapping
På så sätt kan du publicera till Event Grid med ett anpassat indataschema. Detta kan användas för att mappa egenskaper från ett anpassat JSON-indataschema till Event Grid-händelseschemat.
Name | Typ | Description |
---|---|---|
inputSchemaMappingType |
string:
Json |
Typ av anpassad mappning |
properties.dataVersion |
Mappningsinformationen för egenskapen DataVersion för Event Grid-händelsen. |
|
properties.eventTime |
Mappningsinformationen för EventTime-egenskapen för Event Grid-händelsen. |
|
properties.eventType |
Mappningsinformationen för eventtype-egenskapen för Event Grid-händelsen. |
|
properties.id |
Mappningsinformationen för ID-egenskapen för Event Grid-händelsen. |
|
properties.subject |
Mappningsinformationen för egenskapen Subject för Event Grid-händelsen. |
|
properties.topic |
Mappningsinformationen för egenskapen Topic för Event Grid-händelsen. |
PersistedConnectionStatus
Status för anslutningen.
Name | Typ | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateEndpoint
PrivateEndpoint-information.
Name | Typ | Description |
---|---|---|
id |
string |
ARM-identifieraren för privat slutpunkt. |
PrivateEndpointConnection
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerad identifierare för resursen. |
name |
string |
Namn på resursen. |
properties.groupIds |
string[] |
GroupIds från private link-tjänstresursen. |
properties.privateEndpoint |
Den privata slutpunktsresursen för den här anslutningen. |
|
properties.privateLinkServiceConnectionState |
Information om anslutningens tillstånd. |
|
properties.provisioningState |
Etableringstillstånd för den privata slutpunktsanslutningen. |
|
type |
string |
Resurstyp. |
PublicNetworkAccess
Detta avgör om trafik tillåts via offentligt nätverk. Som standard är den aktiverad. Du kan ytterligare begränsa till specifika IP-adresser genom att konfigurera
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ResourceProvisioningState
Etableringstillstånd för den privata slutpunktsanslutningen.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
UserIdentityProperties
Information om användaridentiteten.
Name | Typ | Description |
---|---|---|
clientId |
string |
Klient-ID för användartilldelad identitet. |
principalId |
string |
Huvud-ID för användartilldelad identitet. |