Domains - Create Or Update

Service:

Event Grid

API Version:

2022-06-15

Create or update a domain.
Asynchronously creates or updates a new domain with the specified parameters.

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

URI Parameters

Name	In	Required	Type	Description
domainName	path	True	string	Name of the domain.
resourceGroupName	path	True	string	The name of the resource group within the user's subscription.
subscriptionId	path	True	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.

Request Body

Name	Required	Type	Description
location	True	string	Location of the resource.
identity		IdentityInfo	Identity information for the Event Grid Domain resource.
properties.autoCreateTopicWithFirstSubscription		boolean	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
properties.autoDeleteTopicWithLastSubscription		boolean	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
properties.dataResidencyBoundary		DataResidencyBoundary	Data Residency Boundary of the resource.
properties.disableLocalAuth		boolean	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
properties.inboundIpRules		InboundIpRule[]	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
properties.inputSchema		InputSchema	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
properties.inputSchemaMapping		InputSchemaMapping: JsonInputSchemaMapping	Information about the InputSchemaMapping which specified the info about mapping event payload.
properties.publicNetworkAccess		PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
tags		object	Tags of the resource.

Responses

Name	Type	Description
201 Created	Domain	Created
Other Status Codes		*** Error Responses: *** 400 Bad Request. 500 Internal Server Error.

Examples

Domains_CreateOrUpdate

Sample Request

HTTP

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

Java

import com.azure.resourcemanager.eventgrid.models.InboundIpRule;
import com.azure.resourcemanager.eventgrid.models.IpActionType;
import com.azure.resourcemanager.eventgrid.models.PublicNetworkAccess;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for Domains CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json
     */
    /**
     * Sample code: Domains_CreateOrUpdate.
     *
     * @param manager Entry point to EventGridManager.
     */
    public static void domainsCreateOrUpdate(com.azure.resourcemanager.eventgrid.EventGridManager manager) {
        manager
            .domains()
            .define("exampledomain1")
            .withRegion("westus2")
            .withExistingResourceGroup("examplerg")
            .withTags(mapOf("tag1", "value1", "tag2", "value2"))
            .withPublicNetworkAccess(PublicNetworkAccess.ENABLED)
            .withInboundIpRules(
                Arrays
                    .asList(
                        new InboundIpRule().withIpMask("12.18.30.15").withAction(IpActionType.ALLOW),
                        new InboundIpRule().withIpMask("12.18.176.1").withAction(IpActionType.ALLOW)))
            .create();
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.eventgrid import EventGridManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventgrid
# USAGE
    python domains_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventGridManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
    )

    response = client.domains.begin_create_or_update(
        resource_group_name="examplerg",
        domain_name="exampledomain1",
        domain_info={
            "location": "westus2",
            "properties": {
                "inboundIpRules": [
                    {"action": "Allow", "ipMask": "12.18.30.15"},
                    {"action": "Allow", "ipMask": "12.18.176.1"},
                ],
                "publicNetworkAccess": "Enabled",
            },
            "tags": {"tag1": "value1", "tag2": "value2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armeventgrid_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f88928d723133dc392e3297e6d61b7f6d10501fd/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json
func ExampleDomainsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventgrid.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDomainsClient().BeginCreateOrUpdate(ctx, "examplerg", "exampledomain1", armeventgrid.Domain{
		Location: to.Ptr("westus2"),
		Tags: map[string]*string{
			"tag1": to.Ptr("value1"),
			"tag2": to.Ptr("value2"),
		},
		Properties: &armeventgrid.DomainProperties{
			InboundIPRules: []*armeventgrid.InboundIPRule{
				{
					Action: to.Ptr(armeventgrid.IPActionTypeAllow),
					IPMask: to.Ptr("12.18.30.15"),
				},
				{
					Action: to.Ptr(armeventgrid.IPActionTypeAllow),
					IPMask: to.Ptr("12.18.176.1"),
				}},
			PublicNetworkAccess: to.Ptr(armeventgrid.PublicNetworkAccessEnabled),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { EventGridManagementClient } = require("@azure/arm-eventgrid");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Asynchronously creates or updates a new domain with the specified parameters.
 *
 * @summary Asynchronously creates or updates a new domain with the specified parameters.
 * x-ms-original-file: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json
 */
async function domainsCreateOrUpdate() {
  const subscriptionId =
    process.env["EVENTGRID_SUBSCRIPTION_ID"] || "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
  const resourceGroupName = process.env["EVENTGRID_RESOURCE_GROUP"] || "examplerg";
  const domainName = "exampledomain1";
  const domainInfo = {
    inboundIpRules: [
      { action: "Allow", ipMask: "12.18.30.15" },
      { action: "Allow", ipMask: "12.18.176.1" },
    ],
    location: "westus2",
    publicNetworkAccess: "Enabled",
    tags: { tag1: "value1", tag2: "value2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new EventGridManagementClient(credential, subscriptionId);
  const result = await client.domains.beginCreateOrUpdateAndWait(
    resourceGroupName,
    domainName,
    domainInfo
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EventGrid;
using Azure.ResourceManager.EventGrid.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2022-06-15/examples/Domains_CreateOrUpdate.json
// this example is just showing the usage of "Domains_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "5b4b650e-28b9-4790-b3ab-ddbd88d727c4";
string resourceGroupName = "examplerg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this EventGridDomainResource
EventGridDomainCollection collection = resourceGroupResource.GetEventGridDomains();

// invoke the operation
string domainName = "exampledomain1";
EventGridDomainData data = new EventGridDomainData(new AzureLocation("westus2"))
{
    PublicNetworkAccess = EventGridPublicNetworkAccess.Enabled,
    InboundIPRules =
    {
    new EventGridInboundIPRule()
    {
    IPMask = "12.18.30.15",
    Action = EventGridIPActionType.Allow,
    },new EventGridInboundIPRule()
    {
    IPMask = "12.18.176.1",
    Action = EventGridIPActionType.Allow,
    }
    },
    Tags =
    {
    ["tag1"] = "value1",
    ["tag2"] = "value2",
    },
};
ArmOperation<EventGridDomainResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, domainName, data);
EventGridDomainResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EventGridDomainData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

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

Definitions

Name	Description
ConnectionState	ConnectionState information.
createdByType	The type of identity that created the resource.
DataResidencyBoundary	Data Residency Boundary of the resource.
Domain	EventGrid Domain.
DomainProvisioningState	Provisioning state of the Event Grid Domain Resource.
IdentityInfo	The identity information for the resource.
IdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
InboundIpRule
InputSchema	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
IpActionType	Action to perform based on the match or no match of the IpMask.
JsonField	This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.
JsonFieldWithDefault	This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.
JsonInputSchemaMapping	This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.
PersistedConnectionStatus	Status of the connection.
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
ResourceProvisioningState	Provisioning state of the Private Endpoint Connection.
systemData	Metadata pertaining to creation and last modification of the resource.
UserIdentityProperties	The information about the user identity.

ConnectionState

ConnectionState information.

Name	Type	Description
actionsRequired	string	Actions required (if any).
description	string	Description of the connection state.
status	PersistedConnectionStatus	Status of the connection.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataResidencyBoundary

Data Residency Boundary of the resource.

Name	Type	Description
WithinGeopair	string
WithinRegion	string

Domain

EventGrid Domain.

Name	Type	Default Value	Description
id	string		Fully qualified identifier of the resource.
identity	IdentityInfo		Identity information for the Event Grid Domain resource.
location	string		Location of the resource.
name	string		Name of the resource.
properties.autoCreateTopicWithFirstSubscription	boolean	True	This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
properties.autoDeleteTopicWithLastSubscription	boolean	True	This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
properties.dataResidencyBoundary	DataResidencyBoundary		Data Residency Boundary of the resource.
properties.disableLocalAuth	boolean	False	This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only AAD token will be used to authenticate if user is allowed to publish to the domain.
properties.endpoint	string		Endpoint for the Event Grid Domain Resource which is used for publishing the events.
properties.inboundIpRules	InboundIpRule[]		This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
properties.inputSchema	InputSchema	EventGridSchema	This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
properties.inputSchemaMapping	InputSchemaMapping: JsonInputSchemaMapping		Information about the InputSchemaMapping which specified the info about mapping event payload.
properties.metricResourceId	string		Metric resource id for the Event Grid Domain Resource.
properties.privateEndpointConnections	PrivateEndpointConnection[]		List of private endpoint connections.
properties.provisioningState	DomainProvisioningState		Provisioning state of the Event Grid Domain Resource.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring
systemData	systemData		The system metadata relating to the Event Grid Domain resource.
tags	object		Tags of the resource.
type	string		Type of the resource.

DomainProvisioningState

Provisioning state of the Event Grid Domain Resource.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

IdentityInfo

The identity information for the resource.

Name	Type	Description
principalId	string	The principal ID of resource identity.
tenantId	string	The tenant ID of resource.
type	IdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.
userAssignedIdentities	<string,  UserIdentityProperties>	The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. This property is currently not used and reserved for future usage.

IdentityType

The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity.

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

InboundIpRule

Name	Type	Description
action	IpActionType	Action to perform based on the match or no match of the IpMask.
ipMask	string	IP Address in CIDR notation e.g., 10.0.0.0/8.

InputSchema

This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.

Name	Type	Description
CloudEventSchemaV1_0	string
CustomEventSchema	string
EventGridSchema	string

IpActionType

Action to perform based on the match or no match of the IpMask.

Name	Type	Description
Allow	string

JsonField

This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.

Name	Type	Description
sourceField	string	Name of a field in the input event schema that's to be used as the source of a mapping.

JsonFieldWithDefault

This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject', 'eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.

Name	Type	Description
defaultValue	string	The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.
sourceField	string	Name of a field in the input event schema that's to be used as the source of a mapping.

JsonInputSchemaMapping

This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.

Name	Type	Description
inputSchemaMappingType	string: Json	Type of the custom mapping
properties.dataVersion	JsonFieldWithDefault	The mapping information for the DataVersion property of the Event Grid Event.
properties.eventTime	JsonField	The mapping information for the EventTime property of the Event Grid Event.
properties.eventType	JsonFieldWithDefault	The mapping information for the EventType property of the Event Grid Event.
properties.id	JsonField	The mapping information for the Id property of the Event Grid Event.
properties.subject	JsonFieldWithDefault	The mapping information for the Subject property of the Event Grid Event.
properties.topic	JsonField	The mapping information for the Topic property of the Event Grid Event.

PersistedConnectionStatus

Status of the connection.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateEndpoint

PrivateEndpoint information.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint.

PrivateEndpointConnection

Name	Type	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties.groupIds	string[]	GroupIds from the private link service resource.
properties.privateEndpoint	PrivateEndpoint	The Private Endpoint resource for this Connection.
properties.privateLinkServiceConnectionState	ConnectionState	Details about the state of the connection.
properties.provisioningState	ResourceProvisioningState	Provisioning state of the Private Endpoint Connection.
type	string	Type of the resource.

PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

Name	Type	Description
Disabled	string
Enabled	string

ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserIdentityProperties

The information about the user identity.

Name	Type	Description
clientId	string	The client id of user assigned identity.
principalId	string	The principal id of user assigned identity.