Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

EndpointEventGrid

Manages a Digital Twins Event Grid Endpoint.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleInstance = new Azure.DigitalTwins.Instance("exampleInstance", new Azure.DigitalTwins.InstanceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var exampleTopic = new Azure.EventGrid.Topic("exampleTopic", new Azure.EventGrid.TopicArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
        var exampleEndpointEventGrid = new Azure.DigitalTwins.EndpointEventGrid("exampleEndpointEventGrid", new Azure.DigitalTwins.EndpointEventGridArgs
        {
            DigitalTwinsId = exampleInstance.Id,
            EventgridTopicEndpoint = exampleTopic.Endpoint,
            EventgridTopicPrimaryAccessKey = exampleTopic.PrimaryAccessKey,
            EventgridTopicSecondaryAccessKey = exampleTopic.SecondaryAccessKey,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/digitaltwins"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventgrid"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := digitaltwins.NewInstance(ctx, "exampleInstance", &digitaltwins.InstanceArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
		})
		if err != nil {
			return err
		}
		exampleTopic, err := eventgrid.NewTopic(ctx, "exampleTopic", &eventgrid.TopicArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
		})
		if err != nil {
			return err
		}
		_, err = digitaltwins.NewEndpointEventGrid(ctx, "exampleEndpointEventGrid", &digitaltwins.EndpointEventGridArgs{
			DigitalTwinsId:                   exampleInstance.ID(),
			EventgridTopicEndpoint:           exampleTopic.Endpoint,
			EventgridTopicPrimaryAccessKey:   exampleTopic.PrimaryAccessKey,
			EventgridTopicSecondaryAccessKey: exampleTopic.SecondaryAccessKey,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.digitaltwins.Instance;
import com.pulumi.azure.digitaltwins.InstanceArgs;
import com.pulumi.azure.eventgrid.Topic;
import com.pulumi.azure.eventgrid.TopicArgs;
import com.pulumi.azure.digitaltwins.EndpointEventGrid;
import com.pulumi.azure.digitaltwins.EndpointEventGridArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .build());

        var exampleEndpointEventGrid = new EndpointEventGrid("exampleEndpointEventGrid", EndpointEventGridArgs.builder()        
            .digitalTwinsId(exampleInstance.id())
            .eventgridTopicEndpoint(exampleTopic.endpoint())
            .eventgridTopicPrimaryAccessKey(exampleTopic.primaryAccessKey())
            .eventgridTopicSecondaryAccessKey(exampleTopic.secondaryAccessKey())
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_instance = azure.digitaltwins.Instance("exampleInstance",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_topic = azure.eventgrid.Topic("exampleTopic",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name)
example_endpoint_event_grid = azure.digitaltwins.EndpointEventGrid("exampleEndpointEventGrid",
    digital_twins_id=example_instance.id,
    eventgrid_topic_endpoint=example_topic.endpoint,
    eventgrid_topic_primary_access_key=example_topic.primary_access_key,
    eventgrid_topic_secondary_access_key=example_topic.secondary_access_key)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleInstance = new azure.digitaltwins.Instance("exampleInstance", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleTopic = new azure.eventgrid.Topic("exampleTopic", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
});
const exampleEndpointEventGrid = new azure.digitaltwins.EndpointEventGrid("exampleEndpointEventGrid", {
    digitalTwinsId: exampleInstance.id,
    eventgridTopicEndpoint: exampleTopic.endpoint,
    eventgridTopicPrimaryAccessKey: exampleTopic.primaryAccessKey,
    eventgridTopicSecondaryAccessKey: exampleTopic.secondaryAccessKey,
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleInstance:
    type: azure:digitaltwins:Instance
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
  exampleTopic:
    type: azure:eventgrid:Topic
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleEndpointEventGrid:
    type: azure:digitaltwins:EndpointEventGrid
    properties:
      digitalTwinsId: ${exampleInstance.id}
      eventgridTopicEndpoint: ${exampleTopic.endpoint}
      eventgridTopicPrimaryAccessKey: ${exampleTopic.primaryAccessKey}
      eventgridTopicSecondaryAccessKey: ${exampleTopic.secondaryAccessKey}

Create a EndpointEventGrid Resource

new EndpointEventGrid(name: string, args: EndpointEventGridArgs, opts?: CustomResourceOptions);
@overload
def EndpointEventGrid(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      dead_letter_storage_secret: Optional[str] = None,
                      digital_twins_id: Optional[str] = None,
                      eventgrid_topic_endpoint: Optional[str] = None,
                      eventgrid_topic_primary_access_key: Optional[str] = None,
                      eventgrid_topic_secondary_access_key: Optional[str] = None,
                      name: Optional[str] = None)
@overload
def EndpointEventGrid(resource_name: str,
                      args: EndpointEventGridArgs,
                      opts: Optional[ResourceOptions] = None)
func NewEndpointEventGrid(ctx *Context, name string, args EndpointEventGridArgs, opts ...ResourceOption) (*EndpointEventGrid, error)
public EndpointEventGrid(string name, EndpointEventGridArgs args, CustomResourceOptions? opts = null)
public EndpointEventGrid(String name, EndpointEventGridArgs args)
public EndpointEventGrid(String name, EndpointEventGridArgs args, CustomResourceOptions options)
type: azure:digitaltwins:EndpointEventGrid
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EndpointEventGridArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EndpointEventGridArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EndpointEventGridArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EndpointEventGridArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EndpointEventGridArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EndpointEventGrid Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EndpointEventGrid resource accepts the following input properties:

DigitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

EventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

EventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

EventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

Name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

DigitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

EventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

EventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

EventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

Name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

digitalTwinsId String

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint String

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey String

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey String

The secondary access key of the Event Grid Topic.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name String

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

digitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

deadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

digital_twins_id str

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgrid_topic_endpoint str

The endpoint of the Event Grid Topic.

eventgrid_topic_primary_access_key str

The primary access key of the Event Grid Topic.

eventgrid_topic_secondary_access_key str

The secondary access key of the Event Grid Topic.

dead_letter_storage_secret str

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name str

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

digitalTwinsId String

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint String

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey String

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey String

The secondary access key of the Event Grid Topic.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

name String

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the EndpointEventGrid resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing EndpointEventGrid Resource

Get an existing EndpointEventGrid resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EndpointEventGridState, opts?: CustomResourceOptions): EndpointEventGrid
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dead_letter_storage_secret: Optional[str] = None,
        digital_twins_id: Optional[str] = None,
        eventgrid_topic_endpoint: Optional[str] = None,
        eventgrid_topic_primary_access_key: Optional[str] = None,
        eventgrid_topic_secondary_access_key: Optional[str] = None,
        name: Optional[str] = None) -> EndpointEventGrid
func GetEndpointEventGrid(ctx *Context, name string, id IDInput, state *EndpointEventGridState, opts ...ResourceOption) (*EndpointEventGrid, error)
public static EndpointEventGrid Get(string name, Input<string> id, EndpointEventGridState? state, CustomResourceOptions? opts = null)
public static EndpointEventGrid get(String name, Output<String> id, EndpointEventGridState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

DigitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

EventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

EventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

EventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

Name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

DeadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

DigitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

EventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

EventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

EventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

Name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId String

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint String

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey String

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey String

The secondary access key of the Event Grid Topic.

name String

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

deadLetterStorageSecret string

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId string

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint string

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey string

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey string

The secondary access key of the Event Grid Topic.

name string

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

dead_letter_storage_secret str

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digital_twins_id str

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgrid_topic_endpoint str

The endpoint of the Event Grid Topic.

eventgrid_topic_primary_access_key str

The primary access key of the Event Grid Topic.

eventgrid_topic_secondary_access_key str

The secondary access key of the Event Grid Topic.

name str

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

deadLetterStorageSecret String

The storage secret of the dead-lettering, whose format is https://<storageAccountname>.blob.core.windows.net/<containerName>?<SASToken>. When an endpoint can't deliver an event within a certain time period or after trying to deliver the event a certain number of times, it can send the undelivered event to a storage account.

digitalTwinsId String

The resource ID of the Digital Twins Instance. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

eventgridTopicEndpoint String

The endpoint of the Event Grid Topic.

eventgridTopicPrimaryAccessKey String

The primary access key of the Event Grid Topic.

eventgridTopicSecondaryAccessKey String

The secondary access key of the Event Grid Topic.

name String

The name which should be used for this Digital Twins Eventgrid Endpoint. Changing this forces a new Digital Twins Eventgrid Endpoint to be created.

Import

Digital Twins Eventgrid Endpoints can be imported using the resource id, e.g.

 $ pulumi import azure:digitaltwins/endpointEventGrid:EndpointEventGrid example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.DigitalTwins/digitalTwinsInstances/dt1/endpoints/ep1

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.