Module eventgrid

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

namespace events

function onGridBlobCreated

onGridBlobCreated(name: string, args: StorageAccountEventGridCallbackSubscriptionArgs<StorageBlobCreatedEventData>, opts?: pulumi.ComponentResourceOptions): EventGridCallbackSubscription<StorageBlobCreatedEventData>

Creates a new subscription to events fired from Event Grid. The callback is executed whenever a new Blob is created in a container of the Storage Account.

function onGridBlobDeleted

onGridBlobDeleted(name: string, args: StorageAccountEventGridCallbackSubscriptionArgs<StorageBlobDeletedEventData>, opts?: pulumi.ComponentResourceOptions): EventGridCallbackSubscription<StorageBlobDeletedEventData>

Creates a new subscription to events fired from Event Grid. The callback is executed whenever a Blob is deleted from a container of the Storage Account.

function onResourceGroupEvent

onResourceGroupEvent(name: string, args: ResourceGroupEventGridCallbackSubscriptionArgs, opts?: pulumi.ComponentResourceOptions): EventGridCallbackSubscription<ResourceGroupEvent>

Creates a new subscription to events fired from Event Grid. The callback is executed whenever an event associated with the Resource Group fires.

Resources

Resource Domain

class Domain extends CustomResource

Manages an EventGrid Domain

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US 2"});
const exampleDomain = new azure.eventgrid.Domain("exampleDomain", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        environment: "Production",
    },
});

constructor

new Domain(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions)

Create a Domain resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Domain

Returns true if the given object is an instance of Domain. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpoint

public endpoint: pulumi.Output<string>;

The Endpoint associated with the EventGrid Domain.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inputMappingDefaultValues

public inputMappingDefaultValues: pulumi.Output<DomainInputMappingDefaultValues | undefined>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

public inputMappingFields: pulumi.Output<DomainInputMappingFields | undefined>;

A inputMappingFields block as defined below.

property inputSchema

public inputSchema: pulumi.Output<string | undefined>;

Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to eventgridschema. Changing this forces a new resource to be created.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The Primary Shared Access Key associated with the EventGrid Domain.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The Secondary Shared Access Key associated with the EventGrid Domain.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DomainTopic

class DomainTopic extends CustomResource

Manages an EventGrid Domain Topic

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US 2"});
const exampleDomain = new azure.eventgrid.Domain("exampleDomain", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        environment: "Production",
    },
});
const exampleDomainTopic = new azure.eventgrid.DomainTopic("exampleDomainTopic", {
    domainName: exampleDomain.name,
    resourceGroupName: exampleResourceGroup.name,
});

constructor

new DomainTopic(name: string, args: DomainTopicArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainTopic resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainTopicState, opts?: pulumi.CustomResourceOptions): DomainTopic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainTopic

Returns true if the given object is an instance of DomainTopic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property domainName

public domainName: pulumi.Output<string>;

Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EventSubscription

class EventSubscription extends CustomResource

Manages an EventGrid Event Subscription

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const defaultResourceGroup = new azure.core.ResourceGroup("defaultResourceGroup", {location: "West US 2"});
const defaultAccount = new azure.storage.Account("defaultAccount", {
    resourceGroupName: defaultResourceGroup.name,
    location: defaultResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    tags: {
        environment: "staging",
    },
});
const defaultQueue = new azure.storage.Queue("defaultQueue", {storageAccountName: defaultAccount.name});
const defaultEventSubscription = new azure.eventgrid.EventSubscription("defaultEventSubscription", {
    scope: defaultResourceGroup.id,
    storage_queue_endpoint: {
        storageAccountId: defaultAccount.id,
        queueName: defaultQueue.name,
    },
});

constructor

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState, opts?: pulumi.CustomResourceOptions): EventSubscription

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventSubscription

Returns true if the given object is an instance of EventSubscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property advancedFilter

public advancedFilter: pulumi.Output<EventSubscriptionAdvancedFilter | undefined>;

A advancedFilter block as defined below.

property azureFunctionEndpoint

public azureFunctionEndpoint: pulumi.Output<EventSubscriptionAzureFunctionEndpoint | undefined>;

An azureFunctionEndpoint block as defined below.

property eventDeliverySchema

public eventDeliverySchema: pulumi.Output<string | undefined>;

Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventSchemaV1_0, CustomInputSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

property eventhubEndpoint

DEPRECATED Deprecated in favour of eventhub_endpoint_id

public eventhubEndpoint: pulumi.Output<EventSubscriptionEventhubEndpoint>;

A eventhubEndpoint block as defined below.

property eventhubEndpointId

public eventhubEndpointId: pulumi.Output<string>;

Specifies the id where the Event Hub is located.

property expirationTimeUtc

public expirationTimeUtc: pulumi.Output<string | undefined>;

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

property hybridConnectionEndpoint

DEPRECATED Deprecated in favour of hybrid_connection_endpoint_id

public hybridConnectionEndpoint: pulumi.Output<EventSubscriptionHybridConnectionEndpoint>;

A hybridConnectionEndpoint block as defined below.

property hybridConnectionEndpointId

public hybridConnectionEndpointId: pulumi.Output<string>;

Specifies the id where the Hybrid Connection is located.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property includedEventTypes

public includedEventTypes: pulumi.Output<string[]>;

A list of applicable event types that need to be part of the event subscription.

property labels

public labels: pulumi.Output<string[] | undefined>;

A list of labels to assign to the event subscription.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

property retryPolicy

public retryPolicy: pulumi.Output<EventSubscriptionRetryPolicy>;

A retryPolicy block as defined below.

property scope

public scope: pulumi.Output<string>;

Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

property serviceBusQueueEndpointId

public serviceBusQueueEndpointId: pulumi.Output<string | undefined>;

Specifies the id where the Service Bus Queue is located.

property serviceBusTopicEndpointId

public serviceBusTopicEndpointId: pulumi.Output<string | undefined>;

Specifies the id where the Service Bus Topic is located.

property storageBlobDeadLetterDestination

public storageBlobDeadLetterDestination: pulumi.Output<EventSubscriptionStorageBlobDeadLetterDestination | undefined>;

A storageBlobDeadLetterDestination block as defined below.

property storageQueueEndpoint

public storageQueueEndpoint: pulumi.Output<EventSubscriptionStorageQueueEndpoint | undefined>;

A storageQueueEndpoint block as defined below.

property subjectFilter

public subjectFilter: pulumi.Output<EventSubscriptionSubjectFilter | undefined>;

A subjectFilter block as defined below.

property topicName

public topicName: pulumi.Output<string>;

(Optional) Specifies the name of the topic to associate with the event subscription.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property webhookEndpoint

public webhookEndpoint: pulumi.Output<EventSubscriptionWebhookEndpoint | undefined>;

A webhookEndpoint block as defined below.

Resource Topic

class Topic extends CustomResource

Manages an EventGrid Topic

Note: at this time EventGrid Topic’s are only available in a limited number of regions.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US 2"});
const exampleTopic = new azure.eventgrid.Topic("exampleTopic", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    tags: {
        environment: "Production",
    },
});

constructor

new Topic(name: string, args: TopicArgs, opts?: pulumi.CustomResourceOptions)

Create a Topic resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): Topic

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Topic

Returns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property endpoint

public endpoint: pulumi.Output<string>;

The Endpoint associated with the EventGrid Topic.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inputMappingDefaultValues

public inputMappingDefaultValues: pulumi.Output<TopicInputMappingDefaultValues | undefined>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

public inputMappingFields: pulumi.Output<TopicInputMappingFields | undefined>;

A inputMappingFields block as defined below.

property inputSchema

public inputSchema: pulumi.Output<string | undefined>;

Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The Primary Shared Access Key associated with the EventGrid Topic.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The Secondary Shared Access Key associated with the EventGrid Topic.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getTopic

getTopic(args: GetTopicArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicResult>

Use this data source to access information about an existing EventGrid Topic

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = pulumi.output(azure.eventgrid.getTopic({
    name: "my-eventgrid-topic",
    resourceGroupName: "example-resources",
}, { async: true }));

Others

interface DomainArgs

interface DomainArgs

The set of arguments for constructing a Domain resource.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<DomainInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<DomainInputMappingFields>;

A inputMappingFields block as defined below.

property inputSchema

inputSchema?: pulumi.Input<string>;

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DomainState

interface DomainState

Input properties used for looking up and filtering Domain resources.

property endpoint

endpoint?: pulumi.Input<string>;

The Endpoint associated with the EventGrid Domain.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<DomainInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<DomainInputMappingFields>;

A inputMappingFields block as defined below.

property inputSchema

inputSchema?: pulumi.Input<string>;

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The Primary Shared Access Key associated with the EventGrid Domain.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The Secondary Shared Access Key associated with the EventGrid Domain.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface DomainTopicArgs

interface DomainTopicArgs

The set of arguments for constructing a DomainTopic resource.

property domainName

domainName: pulumi.Input<string>;

Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

interface DomainTopicState

interface DomainTopicState

Input properties used for looking up and filtering DomainTopic resources.

property domainName

domainName?: pulumi.Input<string>;

Specifies the name of the EventGrid Domain. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Domain Topic resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

class EventGridCallbackSubscription

class EventGridCallbackSubscription extends EventSubscription<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>

A callback-based subscription to events coming from Event Grid. Creates an Azure Function and an Event Grid Event Subscription with the webhook URL pointing to the Azure Function.

constructor

new EventGridCallbackSubscription(name: string, scope: EventGridScope, args: EventGridCallbackSubscriptionArgs<T>, opts: ComponentResourceOptions)

method getData

protected getData(): Promise<TData>

Retrieves the data produces by [initialize]. The data is immediately available in a derived class’s constructor after the super(...) call to ComponentResource.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method initialize

protected initialize(args: Inputs): Promise<TData>

Can be overridden by a subclass to asynchronously initialize data for this Component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use .getData.

method isInstance

static isInstance(obj: any): obj is ComponentResource

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method registerOutputs

protected registerOutputs(outputs?: Inputs | Promise<Inputs> | Output<Inputs>): void

registerOutputs registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

ComponentResources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

property functionApp

public functionApp: CallbackFunctionApp<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

property subscription

public subscription: EventSubscription;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface EventGridCallbackSubscriptionArgs

interface EventGridCallbackSubscriptionArgs extends CallbackFunctionAppArgs<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>

property account

account?: storageForTypesOnly.Account;

The storage account to use where the zip-file blob for the FunctionApp will be located. If not provided, a new storage account will create. It will be a ‘Standard’, ‘LRS’, ‘StorageV2’ account.

property appSettings

appSettings?: pulumi.Input<{[key: string]: any}>;

A key-value pair of App Settings.

property authSettings

authSettings?: pulumi.Input<FunctionAppAuthSettings>;

A authSettings block as defined below.

property callback

callback?: Callback<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

This form is useful when there is expensive initialization work that should only be executed once. The factory-function will be invoked once when the final Azure FunctionApp module is loaded. It can run whatever code it needs, and will end by returning the actual function that the Azure will call into each time the FunctionApp it is is invoked.

property clientAffinityEnabled

clientAffinityEnabled?: pulumi.Input<boolean>;

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

property codePathOptions

codePathOptions?: pulumi.runtime.CodePathOptions;

Options to control which files and packages are included with the serialized FunctionApp code.

property connectionStrings

connectionStrings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    type: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

An connection_string block as defined below.

property container

container?: storageForTypesOnly.Container;

The container to use where the zip-file blob for the FunctionApp will be located. If not provided, the root container of the storage account will be used.

property dailyMemoryTimeQuota

dailyMemoryTimeQuota?: pulumi.Input<number>;

The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to 0.

property enableBuiltinLogging

enableBuiltinLogging?: pulumi.Input<boolean>;

Should the built-in logging of this Function App be enabled? Defaults to true.

property enabled

enabled?: pulumi.Input<boolean>;

Is the Function App enabled?

property hostSettings

hostSettings?: HostSettings;

Host configuration options.

property httpsOnly

httpsOnly?: pulumi.Input<boolean>;

Can the Function App only be accessed via HTTPS? Defaults to false.

property identity

identity?: pulumi.Input<FunctionAppIdentity>;

An identity block as defined below.

property includedEventTypes

includedEventTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of applicable event types that need to be part of the event subscription.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Function App.

property nodeVersion

nodeVersion?: pulumi.Input<string>;

Controls the value of WEBSITE_NODE_DEFAULT_VERSION in appSettings. If not provided, defaults to ~12.

property osType

osType?: pulumi.Input<string>;

A string indicating the Operating System type for this function app.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

property plan

plan?: appservice.Plan;

The App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

If not provided, a default “Consumption” plan will be created. See: https://docs.microsoft.com/en-us/azure/azure-functions/functions-scale#consumption-plan for more details.

property resourceGroup

resourceGroup?: core.ResourceGroup;

The resource group in which to create the event subscription. [resourceGroup] takes precedence over [resourceGroupName].

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the event subscription. [resourceGroup] takes precedence over [resourceGroupName]. If none of the two is supplied, the Queue’s resource group will be used.

property retryPolicy

retryPolicy?: pulumi.Input<{
    eventTimeToLive: pulumi.Input<number>;
    maxDeliveryAttempts: pulumi.Input<number>;
}>;

A retry policy block as defined below.

property siteConfig

siteConfig?: pulumi.Input<FunctionAppSiteConfig>;

A site_config object as defined below.

property subjectFilter

subjectFilter?: pulumi.Input<{
    caseSensitive?: pulumi.Input<boolean>;
    subjectBeginsWith?: pulumi.Input<string>;
    subjectEndsWith?: pulumi.Input<string>;
}>;

A subject filter block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

The runtime version associated with the Function App. Defaults to ~3.

interface EventGridContext

interface EventGridContext extends Context<appservice.FunctionDefaultResponse>

Data that will be passed along in the context object to the EventGridCallback.

method done

done(err?: Error | string | null, result?: R): void

A callback function that signals to the runtime that your code has completed. If your function is synchronous, you must call context.done at the end of execution. If your function is asynchronous, you should not use this callback.

property bindingData

bindingData: {
    data: T;
    invocationId: string;
    sys: {
        methodName: string;
        utcNow: string;
    };
};

property bindingDefinitions

bindingDefinitions: BindingDefinition[];

Bindings your function uses, as defined in function.json.

property bindings

bindings: {
    message: EventGridEvent<T>;
};

property executionContext

executionContext: {
    functionDirectory: string;
    functionName: string;
    invocationId: string;
};

property invocationId

invocationId: string;

property log

log: Logger;

Allows you to write streaming function logs. Calling directly allows you to write streaming function logs at the default trace level.

property req

req?: HttpRequest;

HTTP request object. Provided to your function when using HTTP Bindings.

property res

res?: undefined | {[key: string]: any};

HTTP response object. Provided to your function when using HTTP Bindings.

property traceContext

traceContext: TraceContext;

TraceContext information to enable distributed tracing scenarios.

interface EventGridEvent

interface EventGridEvent extends EventGridEvent

Event that will be passed along to the EventGridCallback.

property data

data: T;

property dataVersion

dataVersion: string;

property eventTime

eventTime: Date;

property eventType

eventType: string;

property id

id: string;

property metadataVersion

metadataVersion?: undefined | string;

property subject

subject: string;

property topic

topic?: undefined | string;

class EventGridFunction

class EventGridFunction extends Function<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>

Azure Function triggered by a Event Grid Topic.

constructor

new EventGridFunction(name: string, args: EventGridFunctionArgs<T>)

property appSettings

public appSettings?: pulumi.Input<{[key: string]: string}>;

Application settings required by the function.

property bindings

public bindings: pulumi.Input<BindingDefinition[]>;

An array of function binding definitions.

property callback

public callback: CallbackArgs<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

Function callback.

property name

public name: string;

Function name.

interface EventGridFunctionArgs

interface EventGridFunctionArgs extends CallbackFunctionArgs<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>

property callback

callback?: Callback<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

interface EventGridScope

interface EventGridScope

Resource properties to scope an Event Grid subscription to. The shape fits most Azure resources, so they can be passed directly.

property id

id: pulumi.Input<string>;

Azure Resource ID.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

Resource group name to create subscription at, if another resource group is not explicitly passed in subscription arguments.

interface EventSubscriptionArgs

interface EventSubscriptionArgs

The set of arguments for constructing a EventSubscription resource.

property advancedFilter

advancedFilter?: pulumi.Input<EventSubscriptionAdvancedFilter>;

A advancedFilter block as defined below.

property azureFunctionEndpoint

azureFunctionEndpoint?: pulumi.Input<EventSubscriptionAzureFunctionEndpoint>;

An azureFunctionEndpoint block as defined below.

property eventDeliverySchema

eventDeliverySchema?: pulumi.Input<string>;

property eventhubEndpoint

DEPRECATED Deprecated in favour of eventhub_endpoint_id

eventhubEndpoint?: pulumi.Input<EventSubscriptionEventhubEndpoint>;

A eventhubEndpoint block as defined below.

property eventhubEndpointId

eventhubEndpointId?: pulumi.Input<string>;

Specifies the id where the Event Hub is located.

property expirationTimeUtc

expirationTimeUtc?: pulumi.Input<string>;

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

property hybridConnectionEndpoint

DEPRECATED Deprecated in favour of hybrid_connection_endpoint_id

hybridConnectionEndpoint?: pulumi.Input<EventSubscriptionHybridConnectionEndpoint>;

A hybridConnectionEndpoint block as defined below.

property hybridConnectionEndpointId

hybridConnectionEndpointId?: pulumi.Input<string>;

Specifies the id where the Hybrid Connection is located.

property includedEventTypes

includedEventTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of applicable event types that need to be part of the event subscription.

property labels

labels?: pulumi.Input<pulumi.Input<string>[]>;

A list of labels to assign to the event subscription.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

property retryPolicy

retryPolicy?: pulumi.Input<EventSubscriptionRetryPolicy>;

A retryPolicy block as defined below.

property scope

scope: pulumi.Input<string>;

Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

property serviceBusQueueEndpointId

serviceBusQueueEndpointId?: pulumi.Input<string>;

Specifies the id where the Service Bus Queue is located.

property serviceBusTopicEndpointId

serviceBusTopicEndpointId?: pulumi.Input<string>;

Specifies the id where the Service Bus Topic is located.

property storageBlobDeadLetterDestination

storageBlobDeadLetterDestination?: pulumi.Input<EventSubscriptionStorageBlobDeadLetterDestination>;

A storageBlobDeadLetterDestination block as defined below.

property storageQueueEndpoint

storageQueueEndpoint?: pulumi.Input<EventSubscriptionStorageQueueEndpoint>;

A storageQueueEndpoint block as defined below.

property subjectFilter

subjectFilter?: pulumi.Input<EventSubscriptionSubjectFilter>;

A subjectFilter block as defined below.

property topicName

topicName?: pulumi.Input<string>;

(Optional) Specifies the name of the topic to associate with the event subscription.

property webhookEndpoint

webhookEndpoint?: pulumi.Input<EventSubscriptionWebhookEndpoint>;

A webhookEndpoint block as defined below.

interface EventSubscriptionState

interface EventSubscriptionState

Input properties used for looking up and filtering EventSubscription resources.

property advancedFilter

advancedFilter?: pulumi.Input<EventSubscriptionAdvancedFilter>;

A advancedFilter block as defined below.

property azureFunctionEndpoint

azureFunctionEndpoint?: pulumi.Input<EventSubscriptionAzureFunctionEndpoint>;

An azureFunctionEndpoint block as defined below.

property eventDeliverySchema

eventDeliverySchema?: pulumi.Input<string>;

property eventhubEndpoint

DEPRECATED Deprecated in favour of eventhub_endpoint_id

eventhubEndpoint?: pulumi.Input<EventSubscriptionEventhubEndpoint>;

A eventhubEndpoint block as defined below.

property eventhubEndpointId

eventhubEndpointId?: pulumi.Input<string>;

Specifies the id where the Event Hub is located.

property expirationTimeUtc

expirationTimeUtc?: pulumi.Input<string>;

Specifies the expiration time of the event subscription (Datetime Format RFC 3339).

property hybridConnectionEndpoint

DEPRECATED Deprecated in favour of hybrid_connection_endpoint_id

hybridConnectionEndpoint?: pulumi.Input<EventSubscriptionHybridConnectionEndpoint>;

A hybridConnectionEndpoint block as defined below.

property hybridConnectionEndpointId

hybridConnectionEndpointId?: pulumi.Input<string>;

Specifies the id where the Hybrid Connection is located.

property includedEventTypes

includedEventTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of applicable event types that need to be part of the event subscription.

property labels

labels?: pulumi.Input<pulumi.Input<string>[]>;

A list of labels to assign to the event subscription.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

property retryPolicy

retryPolicy?: pulumi.Input<EventSubscriptionRetryPolicy>;

A retryPolicy block as defined below.

property scope

scope?: pulumi.Input<string>;

Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

property serviceBusQueueEndpointId

serviceBusQueueEndpointId?: pulumi.Input<string>;

Specifies the id where the Service Bus Queue is located.

property serviceBusTopicEndpointId

serviceBusTopicEndpointId?: pulumi.Input<string>;

Specifies the id where the Service Bus Topic is located.

property storageBlobDeadLetterDestination

storageBlobDeadLetterDestination?: pulumi.Input<EventSubscriptionStorageBlobDeadLetterDestination>;

A storageBlobDeadLetterDestination block as defined below.

property storageQueueEndpoint

storageQueueEndpoint?: pulumi.Input<EventSubscriptionStorageQueueEndpoint>;

A storageQueueEndpoint block as defined below.

property subjectFilter

subjectFilter?: pulumi.Input<EventSubscriptionSubjectFilter>;

A subjectFilter block as defined below.

property topicName

topicName?: pulumi.Input<string>;

(Optional) Specifies the name of the topic to associate with the event subscription.

property webhookEndpoint

webhookEndpoint?: pulumi.Input<EventSubscriptionWebhookEndpoint>;

A webhookEndpoint block as defined below.

interface GetTopicArgs

interface GetTopicArgs

A collection of arguments for invoking getTopic.

property name

name: string;

The name of the EventGrid Topic resource.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the EventGrid Topic exists.

property tags

tags?: undefined | {[key: string]: string};

interface GetTopicResult

interface GetTopicResult

A collection of values returned by getTopic.

property endpoint

endpoint: string;

The Endpoint associated with the EventGrid Topic.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

property name

name: string;

property primaryAccessKey

primaryAccessKey: string;

The Primary Shared Access Key associated with the EventGrid Topic.

property resourceGroupName

resourceGroupName: string;

property secondaryAccessKey

secondaryAccessKey: string;

The Secondary Shared Access Key associated with the EventGrid Topic.

property tags

tags?: undefined | {[key: string]: string};

interface ResourceGroupEventGridCallbackSubscriptionArgs

interface ResourceGroupEventGridCallbackSubscriptionArgs extends EventGridCallbackSubscriptionArgs<ResourceGroupEvent>

property account

account?: storageForTypesOnly.Account;

property appSettings

appSettings?: pulumi.Input<{[key: string]: any}>;

A key-value pair of App Settings.

property authSettings

authSettings?: pulumi.Input<FunctionAppAuthSettings>;

A authSettings block as defined below.

property callback

callback?: Callback<EventGridContext<ResourceGroupEvent>, EventGridEvent<ResourceGroupEvent>, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventGridContext<ResourceGroupEvent>, EventGridEvent<ResourceGroupEvent>, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property clientAffinityEnabled

clientAffinityEnabled?: pulumi.Input<boolean>;

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

property codePathOptions

codePathOptions?: pulumi.runtime.CodePathOptions;

Options to control which files and packages are included with the serialized FunctionApp code.

property connectionStrings

connectionStrings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    type: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

An connection_string block as defined below.

property container

container?: storageForTypesOnly.Container;

The container to use where the zip-file blob for the FunctionApp will be located. If not provided, the root container of the storage account will be used.

property dailyMemoryTimeQuota

dailyMemoryTimeQuota?: pulumi.Input<number>;

The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to 0.

property enableBuiltinLogging

enableBuiltinLogging?: pulumi.Input<boolean>;

Should the built-in logging of this Function App be enabled? Defaults to true.

property enabled

enabled?: pulumi.Input<boolean>;

Is the Function App enabled?

property hostSettings

hostSettings?: HostSettings;

Host configuration options.

property httpsOnly

httpsOnly?: pulumi.Input<boolean>;

Can the Function App only be accessed via HTTPS? Defaults to false.

property identity

identity?: pulumi.Input<FunctionAppIdentity>;

An identity block as defined below.

property includedEventTypes

includedEventTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of applicable event types that need to be part of the event subscription.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Function App.

property nodeVersion

nodeVersion?: pulumi.Input<string>;

Controls the value of WEBSITE_NODE_DEFAULT_VERSION in appSettings. If not provided, defaults to ~12.

property osType

osType?: pulumi.Input<string>;

A string indicating the Operating System type for this function app.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

property plan

plan?: appservice.Plan;

The App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

If not provided, a default “Consumption” plan will be created. See: https://docs.microsoft.com/en-us/azure/azure-functions/functions-scale#consumption-plan for more details.

property resourceGroup

resourceGroup: ResourceGroup;

Resource Group to subscribe to. Event Grid events for this resource group trigger the callback execution.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

property retryPolicy

retryPolicy?: pulumi.Input<{
    eventTimeToLive: pulumi.Input<number>;
    maxDeliveryAttempts: pulumi.Input<number>;
}>;

A retry policy block as defined below.

property siteConfig

siteConfig?: pulumi.Input<FunctionAppSiteConfig>;

A site_config object as defined below.

property subjectFilter

subjectFilter?: pulumi.Input<{
    caseSensitive?: pulumi.Input<boolean>;
    subjectBeginsWith?: pulumi.Input<string>;
    subjectEndsWith?: pulumi.Input<string>;
}>;

A subject filter block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

The runtime version associated with the Function App. Defaults to ~3.

interface StorageAccountEventGridCallbackSubscriptionArgs

interface StorageAccountEventGridCallbackSubscriptionArgs extends EventGridCallbackSubscriptionArgs<T>

property account

account?: storageForTypesOnly.Account;

property appSettings

appSettings?: pulumi.Input<{[key: string]: any}>;

A key-value pair of App Settings.

property authSettings

authSettings?: pulumi.Input<FunctionAppAuthSettings>;

A authSettings block as defined below.

property callback

callback?: Callback<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance to use as the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property callbackFactory

callbackFactory?: CallbackFactory<EventGridContext<T>, EventGridEvent<T>, appservice.FunctionDefaultResponse>;

The Javascript function instance that will be called to produce the function that is the entrypoint for the Azure FunctionApp. Either [callback] or [callbackFactory] must be provided.

property clientAffinityEnabled

clientAffinityEnabled?: pulumi.Input<boolean>;

Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

property codePathOptions

codePathOptions?: pulumi.runtime.CodePathOptions;

Options to control which files and packages are included with the serialized FunctionApp code.

property connectionStrings

connectionStrings?: pulumi.Input<pulumi.Input<{
    name: pulumi.Input<string>;
    type: pulumi.Input<string>;
    value: pulumi.Input<string>;
}>[]>;

An connection_string block as defined below.

property container

container?: storageForTypesOnly.Container;

The container to use where the zip-file blob for the FunctionApp will be located. If not provided, the root container of the storage account will be used.

property dailyMemoryTimeQuota

dailyMemoryTimeQuota?: pulumi.Input<number>;

The amount of memory in gigabyte-seconds that your application is allowed to consume per day. Setting this value only affects function apps under the consumption plan. Defaults to 0.

property enableBuiltinLogging

enableBuiltinLogging?: pulumi.Input<boolean>;

Should the built-in logging of this Function App be enabled? Defaults to true.

property enabled

enabled?: pulumi.Input<boolean>;

Is the Function App enabled?

property hostSettings

hostSettings?: HostSettings;

Host configuration options.

property httpsOnly

httpsOnly?: pulumi.Input<boolean>;

Can the Function App only be accessed via HTTPS? Defaults to false.

property identity

identity?: pulumi.Input<FunctionAppIdentity>;

An identity block as defined below.

property includedEventTypes

includedEventTypes?: pulumi.Input<pulumi.Input<string>[]>;

A list of applicable event types that need to be part of the event subscription.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

The name of the Function App.

property nodeVersion

nodeVersion?: pulumi.Input<string>;

Controls the value of WEBSITE_NODE_DEFAULT_VERSION in appSettings. If not provided, defaults to ~12.

property osType

osType?: pulumi.Input<string>;

A string indicating the Operating System type for this function app.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

property plan

plan?: appservice.Plan;

The App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

If not provided, a default “Consumption” plan will be created. See: https://docs.microsoft.com/en-us/azure/azure-functions/functions-scale#consumption-plan for more details.

property resourceGroup

resourceGroup?: core.ResourceGroup;

The resource group in which to create the event subscription. [resourceGroup] takes precedence over [resourceGroupName].

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

property retryPolicy

retryPolicy?: pulumi.Input<{
    eventTimeToLive: pulumi.Input<number>;
    maxDeliveryAttempts: pulumi.Input<number>;
}>;

A retry policy block as defined below.

property siteConfig

siteConfig?: pulumi.Input<FunctionAppSiteConfig>;

A site_config object as defined below.

property storageAccount

storageAccount: Account;

Storage Account to subscribe to. Event Grid events for this account trigger the callback execution.

property subjectFilter

subjectFilter?: pulumi.Input<{
    caseSensitive?: pulumi.Input<boolean>;
    subjectBeginsWith?: pulumi.Input<string>;
    subjectEndsWith?: pulumi.Input<string>;
}>;

A subject filter block as defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property version

version?: pulumi.Input<string>;

The runtime version associated with the Function App. Defaults to ~3.

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<TopicInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<TopicInputMappingFields>;

A inputMappingFields block as defined below.

property inputSchema

inputSchema?: pulumi.Input<string>;

Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property endpoint

endpoint?: pulumi.Input<string>;

The Endpoint associated with the EventGrid Topic.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<TopicInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<TopicInputMappingFields>;

A inputMappingFields block as defined below.

property inputSchema

inputSchema?: pulumi.Input<string>;

Specifies the schema in which incoming events will be published to this domain. Allowed values are CloudEventSchemaV1_0, CustomEventSchema, or EventGridSchema. Defaults to EventGridSchema. Changing this forces a new resource to be created.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The Primary Shared Access Key associated with the EventGrid Topic.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The Secondary Shared Access Key associated with the EventGrid Topic.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module eventgrid

namespace events

Resources

Functions

Others

namespace events

Resources

Example Usage

Example Usage

Example Usage

Example Usage

A mapping of tags to assign to the resource.

Functions

Example Usage

Others