Module eventhub

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

const onGridBlobCreated

DEPRECATED This function has moved to the [eventgrid] module.

const onGridBlobCreated: onGridBlobCreated =  eventgrid.events.onGridBlobCreated;

const onGridBlobDeleted

DEPRECATED This function has moved to the [eventgrid] module.

const onGridBlobDeleted: onGridBlobDeleted =  eventgrid.events.onGridBlobDeleted;

const onResourceGroupEvent

DEPRECATED This function has moved to the [eventgrid] module.

const onResourceGroupEvent: onResourceGroupEvent =  eventgrid.events.onResourceGroupEvent;

Resources

Resource AuthorizationRule

class AuthorizationRule extends CustomResource

Manages a Event Hubs authorization Rule within an Event Hub. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", { location: "West US", resourceGroupName: exampleResourceGroup.name, sku: "Basic", capacity: 2, tags: { environment: "Production", }, }); const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", { namespaceName: exampleEventHubNamespace.name, resourceGroupName: exampleResourceGroup.name, partitionCount: 2, messageRetention: 2, }); const exampleAuthorizationRule = new azure.eventhub.AuthorizationRule("exampleAuthorizationRule", { namespaceName: exampleEventHubNamespace.name, eventhubName: exampleEventHub.name, resourceGroupName: exampleResourceGroup.name, listen: true, send: false, manage: false, }); ```

constructor

new AuthorizationRule(name: string, args: AuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a AuthorizationRule 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?: AuthorizationRuleState, opts?: pulumi.CustomResourceOptions): AuthorizationRule

Get an existing AuthorizationRule 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 AuthorizationRule

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

property eventhubName

public eventhubName: pulumi.Output<string>;

Specifies the name of the EventHub. 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 listen

public listen: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to `false`.

property manage

public manage: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is `true` - both `listen` and `send` must be too. Defaults to `false`.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the Event Hubs authorization Rule.

property primaryConnectionStringAlias

public primaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the Event Hubs authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryConnectionStringAlias

public secondaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the Event Hubs Authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to `false`.

property urn

urn: Output<URN>;

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

Resource ConsumerGroup

class ConsumerGroup extends CustomResource

Manages a Event Hubs Consumer Group as a nested resource within an Event Hub. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", { location: "West US", resourceGroupName: exampleResourceGroup.name, sku: "Basic", capacity: 2, tags: { environment: "Production", }, }); const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", { namespaceName: exampleEventHubNamespace.name, resourceGroupName: exampleResourceGroup.name, partitionCount: 2, messageRetention: 2, }); const exampleConsumerGroup = new azure.eventhub.ConsumerGroup("exampleConsumerGroup", { namespaceName: exampleEventHubNamespace.name, eventhubName: exampleEventHub.name, resourceGroupName: exampleResourceGroup.name, userMetadata: "some-meta-data", }); ```

constructor

new ConsumerGroup(name: string, args: ConsumerGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ConsumerGroup 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?: ConsumerGroupState, opts?: pulumi.CustomResourceOptions): ConsumerGroup

Get an existing ConsumerGroup 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 ConsumerGroup

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

property eventhubName

public eventhubName: pulumi.Output<string>;

Specifies the name of the EventHub. 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 EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the grandparent EventHub Namespace. 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 EventHub Consumer Group's grandparent Namespace 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.

property userMetadata

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

Specifies the user metadata.

Resource Domain

DEPRECATED azure.eventhub.Domain has been deprecated in favor of azure.eventgrid.Domain

class Domain extends CustomResource

Manages an EventGrid Domain #### Example Usage ```typescript 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

DEPRECATED azure.eventhub.Domain has been deprecated in favor of azure.eventgrid.Domain

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

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 EventGridTopic

DEPRECATED azure.eventhub.EventGridTopic has been deprecated in favor of azure.eventgrid.Topic

class EventGridTopic extends CustomResource

Manages an EventGrid Topic > **Note:** at this time EventGrid Topic's are only available in a limited number of regions. #### Example Usage ```typescript 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

DEPRECATED azure.eventhub.EventGridTopic has been deprecated in favor of azure.eventgrid.Topic

new EventGridTopic(name: string, args: EventGridTopicArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing EventGridTopic 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 EventGridTopic

Returns true if the given object is an instance of EventGridTopic. 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<EventGridTopicInputMappingDefaultValues | undefined>;

A `inputMappingDefaultValues` block as defined below.

property inputMappingFields

public inputMappingFields: pulumi.Output<EventGridTopicInputMappingFields | 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.

Resource EventHub

class EventHub extends CustomResource

Manages a Event Hubs as a nested resource within a Event Hubs namespace. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", capacity: 1, tags: { environment: "Production", }, }); const exampleEventHub = new azure.eventhub.EventHub("exampleEventHub", { namespaceName: exampleEventHubNamespace.name, resourceGroupName: exampleResourceGroup.name, partitionCount: 2, messageRetention: 1, }); ```

constructor

new EventHub(name: string, args: EventHubArgs, opts?: pulumi.CustomResourceOptions)

Create a EventHub 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?: EventHubState, opts?: pulumi.CustomResourceOptions): EventHub

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

method getEventFunction

getEventFunction(name: string, args: EventHubCallback | GetEventHubFunctionArgs): EventHubFunction

Creates a new Function triggered by events in the given Event Hub using the callback provided. [getEventFunction] creates no Azure resources automatically: the returned Function should be used as part of a [MultiCallbackFunctionApp]. Use [onEvent] if you want to create a Function App with a single Function.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

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

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

method onEvent

onEvent(name: string, args: EventHubCallback | EventHubSubscriptionArgs, opts?: pulumi.ComponentResourceOptions): EventHubSubscription

Subscribes to events logged to this Event Hub to the handler provided, along with options to control the behavior of the subscription. A dedicated Function App is created behind the scenes with a single Azure Function in it. Use [getEventFunction] if you want to compose multiple Functions into the same App manually.

property captureDescription

public captureDescription: pulumi.Output<EventHubCaptureDescription | undefined>;

A `captureDescription` block as defined below.

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 messageRetention

public messageRetention: pulumi.Output<number>;

Specifies the number of days to retain the events for this Event Hub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent EventHub Namespace.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property partitionCount

public partitionCount: pulumi.Output<number>;

Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.

property partitionIds

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

The identifiers for partitions created for Event Hubs.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the EventHub's parent Namespace 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 EventHubAuthorizationRule

DEPRECATED azure.eventhub.EventHubAuthorizationRule has been deprecated in favor of azure.eventhub.AuthorizationRule

class EventHubAuthorizationRule extends CustomResource

constructor

DEPRECATED azure.eventhub.EventHubAuthorizationRule has been deprecated in favor of azure.eventhub.AuthorizationRule

new EventHubAuthorizationRule(name: string, args: EventHubAuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing EventHubAuthorizationRule 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 EventHubAuthorizationRule

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

property eventhubName

public eventhubName: pulumi.Output<string>;

Specifies the name of the EventHub. 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 listen

public listen: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to `false`.

property manage

public manage: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is `true` - both `listen` and `send` must be too. Defaults to `false`.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the Event Hubs authorization Rule.

property primaryConnectionStringAlias

public primaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the Event Hubs authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryConnectionStringAlias

public secondaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the Event Hubs Authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to `false`.

property urn

urn: Output<URN>;

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

Resource EventHubConsumerGroup

DEPRECATED azure.eventhub.EventHubConsumerGroup has been deprecated in favor of azure.eventhub.ConsumerGroup

class EventHubConsumerGroup extends CustomResource

constructor

DEPRECATED azure.eventhub.EventHubConsumerGroup has been deprecated in favor of azure.eventhub.ConsumerGroup

new EventHubConsumerGroup(name: string, args: EventHubConsumerGroupArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing EventHubConsumerGroup 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 EventHubConsumerGroup

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

property eventhubName

public eventhubName: pulumi.Output<string>;

Specifies the name of the EventHub. 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 EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the grandparent EventHub Namespace. 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 EventHub Consumer Group's grandparent Namespace 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.

property userMetadata

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

Specifies the user metadata.

Resource EventHubNamespace

class EventHubNamespace extends CustomResource

Manages an EventHub Namespace. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", capacity: 2, tags: { environment: "Production", }, }); ```

constructor

new EventHubNamespace(name: string, args: EventHubNamespaceArgs, opts?: pulumi.CustomResourceOptions)

Create a EventHubNamespace 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?: EventHubNamespaceState, opts?: pulumi.CustomResourceOptions): EventHubNamespace

Get an existing EventHubNamespace 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 EventHubNamespace

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

property autoInflateEnabled

public autoInflateEnabled: pulumi.Output<boolean | undefined>;

Is Auto Inflate enabled for the EventHub Namespace?

property capacity

public capacity: pulumi.Output<number | undefined>;

Specifies the Capacity / Throughput Units for a `Standard` SKU namespace. Valid values range from `1` - `20`.

property defaultPrimaryConnectionString

public defaultPrimaryConnectionString: pulumi.Output<string>;

The primary connection string for the authorization rule `RootManageSharedAccessKey`.

property defaultPrimaryConnectionStringAlias

public defaultPrimaryConnectionStringAlias: pulumi.Output<string>;

The alias of the primary connection string for the authorization rule `RootManageSharedAccessKey`, which is generated when disaster recovery is enabled.

property defaultPrimaryKey

public defaultPrimaryKey: pulumi.Output<string>;

The primary access key for the authorization rule `RootManageSharedAccessKey`.

property defaultSecondaryConnectionString

public defaultSecondaryConnectionString: pulumi.Output<string>;

The secondary connection string for the authorization rule `RootManageSharedAccessKey`.

property defaultSecondaryConnectionStringAlias

public defaultSecondaryConnectionStringAlias: pulumi.Output<string>;

The alias of the secondary connection string for the authorization rule `RootManageSharedAccessKey`, which is generated when disaster recovery is enabled.

property defaultSecondaryKey

public defaultSecondaryKey: pulumi.Output<string>;

The secondary access key for the authorization rule `RootManageSharedAccessKey`.

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 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 maximumThroughputUnits

public maximumThroughputUnits: pulumi.Output<number>;

Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from `1` - `20`.

property name

public name: pulumi.Output<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property networkRulesets

public networkRulesets: pulumi.Output<EventHubNamespaceNetworkRulesets>;

A `networkRulesets` block as defined below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property sku

public sku: pulumi.Output<string>;

Defines which tier to use. Valid options are `Basic` and `Standard`.

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 EventHubNamespaceAuthorizationRule

class EventHubNamespaceAuthorizationRule extends CustomResource

Manages an Authorization Rule for an Event Hub Namespace. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("exampleEventHubNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Basic", capacity: 2, tags: { environment: "Production", }, }); const exampleEventHubNamespaceAuthorizationRule = new azure.eventhub.EventHubNamespaceAuthorizationRule("exampleEventHubNamespaceAuthorizationRule", { namespaceName: exampleEventHubNamespace.name, resourceGroupName: exampleResourceGroup.name, listen: true, send: false, manage: false, }); ```

constructor

new EventHubNamespaceAuthorizationRule(name: string, args: EventHubNamespaceAuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a EventHubNamespaceAuthorizationRule 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?: EventHubNamespaceAuthorizationRuleState, opts?: pulumi.CustomResourceOptions): EventHubNamespaceAuthorizationRule

Get an existing EventHubNamespaceAuthorizationRule 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 EventHubNamespaceAuthorizationRule

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

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 listen

public listen: pulumi.Output<boolean | undefined>;

Grants listen access to this this Authorization Rule. Defaults to `false`.

property manage

public manage: pulumi.Output<boolean | undefined>;

Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`.

property name

public name: pulumi.Output<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the Authorization Rule.

property primaryConnectionStringAlias

public primaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Primary Connection String for the Authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the Authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the Authorization Rule.

property secondaryConnectionStringAlias

public secondaryConnectionStringAlias: pulumi.Output<string>;

The alias of the Secondary Connection String for the Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the Authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Grants send access to this this Authorization Rule. Defaults to `false`.

property urn

urn: Output<URN>;

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

Resource EventhubNamespaceDisasterRecoveryConfig

class EventhubNamespaceDisasterRecoveryConfig extends CustomResource

Manages an Disaster Recovery Config for an Event Hub Namespace. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const primary = new azure.eventhub.EventHubNamespace("primary", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", }); const secondary = new azure.eventhub.EventHubNamespace("secondary", { location: "West US", resourceGroupName: exampleResourceGroup.name, sku: "Standard", }); const exampleEventhubNamespaceDisasterRecoveryConfig = new azure.eventhub.EventhubNamespaceDisasterRecoveryConfig("exampleEventhubNamespaceDisasterRecoveryConfig", { resourceGroupName: exampleResourceGroup.name, namespaceName: primary.name, partnerNamespaceId: secondary.id, }); ```

constructor

new EventhubNamespaceDisasterRecoveryConfig(name: string, args: EventhubNamespaceDisasterRecoveryConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a EventhubNamespaceDisasterRecoveryConfig 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?: EventhubNamespaceDisasterRecoveryConfigState, opts?: pulumi.CustomResourceOptions): EventhubNamespaceDisasterRecoveryConfig

Get an existing EventhubNamespaceDisasterRecoveryConfig 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 EventhubNamespaceDisasterRecoveryConfig

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

property alternateName

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

An alternate name to use when the Disaster Recovery Config's name is the same as the replicated namespace's name.

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 Disaster Recovery Config. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the primary EventHub Namespace to replicate. Changing this forces a new resource to be created.

property partnerNamespaceId

public partnerNamespaceId: pulumi.Output<string>;

The ID of the EventHub Namespace to replicate to.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which the Disaster Recovery Config 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

DEPRECATED azure.eventhub.EventSubscription has been deprecated in favor of azure.eventgrid.EventSubscription

class EventSubscription extends CustomResource

Manages an EventGrid Event Subscription #### Example Usage ```typescript 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

DEPRECATED azure.eventhub.EventSubscription has been deprecated in favor of azure.eventgrid.EventSubscription

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

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 Namespace

DEPRECATED azure.eventhub.Namespace has been deprecated in favor of azure.servicebus.Namespace

class Namespace extends CustomResource

Manages a ServiceBus Namespace. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); ```

constructor

DEPRECATED azure.eventhub.Namespace has been deprecated in favor of azure.servicebus.Namespace

new Namespace(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing Namespace 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 Namespace

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

property capacity

public capacity: pulumi.Output<number | undefined>;

Specifies the capacity. When `sku` is `Premium`, capacity can be `1`, `2`, `4` or `8`. When `sku` is `Basic` or `Standard`, capacity can be `0` only.

property defaultPrimaryConnectionString

public defaultPrimaryConnectionString: pulumi.Output<string>;

The primary connection string for the authorization rule `RootManageSharedAccessKey`.

property defaultPrimaryKey

public defaultPrimaryKey: pulumi.Output<string>;

The primary access key for the authorization rule `RootManageSharedAccessKey`.

property defaultSecondaryConnectionString

public defaultSecondaryConnectionString: pulumi.Output<string>;

The secondary connection string for the authorization rule `RootManageSharedAccessKey`.

property defaultSecondaryKey

public defaultSecondaryKey: pulumi.Output<string>;

The secondary access key for the authorization rule `RootManageSharedAccessKey`.

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 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 ServiceBus Namespace 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 to create the namespace.

property sku

public sku: pulumi.Output<string>;

Defines which tier to use. Options are basic, standard or premium. Changing this forces a new resource to be created.

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.

property zoneRedundant

public zoneRedundant: pulumi.Output<boolean | undefined>;

Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Defaults to `false`.

Resource NamespaceAuthorizationRule

DEPRECATED azure.eventhub.NamespaceAuthorizationRule has been deprecated in favor of azure.servicebus.NamespaceAuthorizationRule

class NamespaceAuthorizationRule extends CustomResource

Manages a ServiceBus Namespace authorization Rule within a ServiceBus. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleNamespaceAuthorizationRule = new azure.servicebus.NamespaceAuthorizationRule("exampleNamespaceAuthorizationRule", { namespaceName: exampleNamespace.name, resourceGroupName: exampleResourceGroup.name, listen: true, send: true, manage: false, }); ```

constructor

DEPRECATED azure.eventhub.NamespaceAuthorizationRule has been deprecated in favor of azure.servicebus.NamespaceAuthorizationRule

new NamespaceAuthorizationRule(name: string, args: NamespaceAuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing NamespaceAuthorizationRule 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 NamespaceAuthorizationRule

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

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 listen

public listen: pulumi.Output<boolean | undefined>;

Grants listen access to this this Authorization Rule. Defaults to `false`.

property manage

public manage: pulumi.Output<boolean | undefined>;

Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`.

property name

public name: pulumi.Output<string>;

Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the ServiceBus Namespace authorization Rule.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the ServiceBus Namespace authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the ServiceBus Namespace authorization Rule.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the ServiceBus Namespace authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Grants send access to this this Authorization Rule. Defaults to `false`.

property urn

urn: Output<URN>;

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

Resource Queue

DEPRECATED azure.eventhub.Queue has been deprecated in favor of azure.servicebus.Queue

class Queue extends CustomResource

Manages a ServiceBus Queue. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleQueue = new azure.servicebus.Queue("exampleQueue", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); ```

constructor

DEPRECATED azure.eventhub.Queue has been deprecated in favor of azure.servicebus.Queue

new Queue(name: string, args: QueueArgs, opts?: pulumi.CustomResourceOptions)

method get

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

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

method getEventFunction

DEPRECATED The [Queue] type has moved to the [servicebus] module.

getEventFunction(name: string, args: ServiceBusCallback | CallbackFunctionArgs<ServiceBusContext, string, appservice.FunctionDefaultResponse>): ServiceBusFunction

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

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

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

method onEvent

DEPRECATED The [Queue] type has moved to the [servicebus] module.

onEvent(name: string, args: ServiceBusCallback | QueueEventSubscriptionArgs, opts?: pulumi.ComponentResourceOptions): QueueEventSubscription

property autoDeleteOnIdle

public autoDeleteOnIdle: pulumi.Output<string>;

The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

property deadLetteringOnMessageExpiration

public deadLetteringOnMessageExpiration: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to `false`.

property defaultMessageTtl

public defaultMessageTtl: pulumi.Output<string>;

The ISO 8601 timespan duration of the TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself.

property duplicateDetectionHistoryTimeWindow

public duplicateDetectionHistoryTimeWindow: pulumi.Output<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (`PT10M`)

property enableExpress

public enableExpress: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. Defaults to `false` for Basic and Standard. For Premium, it MUST be set to `false`.

property enablePartitioning

public enablePartitioning: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether to enable the queue to be partitioned across multiple message brokers. Changing this forces a new resource to be created. Defaults to `false` for Basic and Standard. For Premium, it MUST be set to `true`.

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 lockDuration

public lockDuration: pulumi.Output<string>;

The ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. Maximum value is 5 minutes. Defaults to 1 minute. (`PT1M`)

property maxDeliveryCount

public maxDeliveryCount: pulumi.Output<number | undefined>;

Integer value which controls when a message is automatically deadlettered. Defaults to `10`.

property maxSizeInMegabytes

public maxSizeInMegabytes: pulumi.Output<number>;

Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue/topic size" section of [this document](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas).

property name

public name: pulumi.Output<string>;

Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

public requiresDuplicateDetection: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to `false`.

property requiresSession

public requiresSession: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Queue requires sessions. This will allow ordered handling of unbounded sequences of related messages. With sessions enabled a queue can guarantee first-in-first-out delivery of messages. Changing this forces a new resource to be created. Defaults to `false`.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the namespace. 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 QueueAuthorizationRule

DEPRECATED azure.eventhub.QueueAuthorizationRule has been deprecated in favor of azure.servicebus.QueueAuthorizationRule

class QueueAuthorizationRule extends CustomResource

Manages an Authorization Rule for a ServiceBus Queue. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleQueue = new azure.servicebus.Queue("exampleQueue", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); const exampleQueueAuthorizationRule = new azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule", { namespaceName: exampleNamespace.name, queueName: exampleQueue.name, resourceGroupName: exampleResourceGroup.name, listen: true, send: true, manage: false, }); ```

constructor

DEPRECATED azure.eventhub.QueueAuthorizationRule has been deprecated in favor of azure.servicebus.QueueAuthorizationRule

new QueueAuthorizationRule(name: string, args: QueueAuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing QueueAuthorizationRule 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 QueueAuthorizationRule

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

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 listen

public listen: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to `false`.

property manage

public manage: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is `true` - both `listen` and `send` must be too. Defaults to `false`.

property name

public name: pulumi.Output<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the Authorization Rule.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the Authorization Rule.

property queueName

public queueName: pulumi.Output<string>;

Specifies the name of the ServiceBus Queue. 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 ServiceBus Namespace exists. Changing this forces a new resource to be created.

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the Authorization Rule.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the Authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to `false`.

property urn

urn: Output<URN>;

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

Resource Subscription

DEPRECATED azure.eventhub.Subscription has been deprecated in favor of azure.servicebus.Subscription

class Subscription extends CustomResource

Manages a ServiceBus Subscription. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleTopic = new azure.servicebus.Topic("exampleTopic", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); const exampleSubscription = new azure.servicebus.Subscription("exampleSubscription", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, topicName: exampleTopic.name, maxDeliveryCount: 1, }); ```

constructor

DEPRECATED azure.eventhub.Subscription has been deprecated in favor of azure.servicebus.Subscription

new Subscription(name: string, args: SubscriptionArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing Subscription 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 Subscription

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

property autoDeleteOnIdle

public autoDeleteOnIdle: pulumi.Output<string>;

The idle interval after which the topic is automatically deleted as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The minimum duration is `5` minutes or `P5M`.

property deadLetteringOnMessageExpiration

public deadLetteringOnMessageExpiration: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to `false`.

property defaultMessageTtl

public defaultMessageTtl: pulumi.Output<string>;

The Default message timespan to live as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

property enableBatchedOperations

public enableBatchedOperations: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Subscription supports batched operations. Defaults to `false`.

property forwardDeadLetteredMessagesTo

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

The name of a Queue or Topic to automatically forward Dead Letter messages to.

property forwardTo

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

The name of a Queue or Topic to automatically forward messages to.

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 lockDuration

public lockDuration: pulumi.Output<string>;

The lock duration for the subscription as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The default value is `1` minute or `P1M`.

property maxDeliveryCount

public maxDeliveryCount: pulumi.Output<number>;

The maximum number of deliveries.

property name

public name: pulumi.Output<string>;

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

property namespaceName

public namespaceName: pulumi.Output<string>;

The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

property requiresSession

public requiresSession: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether this Subscription supports the concept of a session. Defaults to `false`. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property topicName

public topicName: pulumi.Output<string>;

The name of the ServiceBus Topic to create this Subscription in. 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 SubscriptionRule

DEPRECATED azure.eventhub.SubscriptionRule has been deprecated in favor of azure.servicebus.SubscriptionRule

class SubscriptionRule extends CustomResource

Manages a ServiceBus Subscription Rule. #### Example Usage ##### SQL Filter) ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleTopic = new azure.servicebus.Topic("exampleTopic", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); const exampleSubscription = new azure.servicebus.Subscription("exampleSubscription", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, topicName: exampleTopic.name, maxDeliveryCount: 1, }); const exampleSubscriptionRule = new azure.servicebus.SubscriptionRule("exampleSubscriptionRule", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, topicName: exampleTopic.name, subscriptionName: exampleSubscription.name, filterType: "SqlFilter", sqlFilter: "colour = 'red'", }); ``` ##### Correlation Filter) ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleTopic = new azure.servicebus.Topic("exampleTopic", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); const exampleSubscription = new azure.servicebus.Subscription("exampleSubscription", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, topicName: exampleTopic.name, maxDeliveryCount: 1, }); const exampleSubscriptionRule = new azure.servicebus.SubscriptionRule("exampleSubscriptionRule", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, topicName: exampleTopic.name, subscriptionName: exampleSubscription.name, filterType: "CorrelationFilter", correlation_filter: { correlationId: "high", label: "red", }, }); ```

constructor

DEPRECATED azure.eventhub.SubscriptionRule has been deprecated in favor of azure.servicebus.SubscriptionRule

new SubscriptionRule(name: string, args: SubscriptionRuleArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing SubscriptionRule 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 SubscriptionRule

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

property action

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

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

property correlationFilter

public correlationFilter: pulumi.Output<SubscriptionRuleCorrelationFilter | undefined>;

A `correlationFilter` block as documented below to be evaluated against a BrokeredMessage. Required when `filterType` is set to `CorrelationFilter`.

property filterType

public filterType: pulumi.Output<string>;

Type of filter to be applied to a BrokeredMessage. Possible values are `SqlFilter` and `CorrelationFilter`.

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 ServiceBus Subscription Rule. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

property sqlFilter

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

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when `filterType` is set to `SqlFilter`.

property subscriptionName

public subscriptionName: pulumi.Output<string>;

The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

property topicName

public topicName: pulumi.Output<string>;

The name of the ServiceBus Topic in which the ServiceBus Subscription 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 Topic

DEPRECATED azure.eventhub.Topic has been deprecated in favor of azure.servicebus.Topic

class Topic extends CustomResource

Manages a ServiceBus Topic. **Note** Topics can only be created in Namespaces with an SKU of `standard` or higher. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleTopic = new azure.servicebus.Topic("exampleTopic", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, enablePartitioning: true, }); ```

constructor

DEPRECATED azure.eventhub.Topic has been deprecated in favor of azure.servicebus.Topic

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

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 getEventFunction

DEPRECATED The [Topic] type has moved to the [servicebus] module.

getEventFunction(name: string, args: GetTopicFunctionArgs): ServiceBusFunction

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.

method onEvent

DEPRECATED The [Topic] type has moved to the [servicebus] module.

onEvent(name: string, args: ServiceBusCallback | TopicEventSubscriptionArgs, opts?: pulumi.ComponentResourceOptions): TopicEventSubscription

property autoDeleteOnIdle

public autoDeleteOnIdle: pulumi.Output<string>;

The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

property defaultMessageTtl

public defaultMessageTtl: pulumi.Output<string>;

The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.

property duplicateDetectionHistoryTimeWindow

public duplicateDetectionHistoryTimeWindow: pulumi.Output<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (`PT10M`)

property enableBatchedOperations

public enableBatchedOperations: pulumi.Output<boolean | undefined>;

Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

property enableExpress

public enableExpress: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. Defaults to false.

property enablePartitioning

public enablePartitioning: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Defaults to false. 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 maxSizeInMegabytes

public maxSizeInMegabytes: pulumi.Output<number>;

Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of [this document](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas).

property name

public name: pulumi.Output<string>;

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

property namespaceName

public namespaceName: pulumi.Output<string>;

The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

public requiresDuplicateDetection: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property status

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

The Status of the Service Bus Topic. Acceptable values are `Active` or `Disabled`. Defaults to `Active`.

property supportOrdering

public supportOrdering: pulumi.Output<boolean | undefined>;

Boolean flag which controls whether the Topic supports ordering. Defaults to false.

property urn

urn: Output<URN>;

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

Resource TopicAuthorizationRule

DEPRECATED azure.eventhub.TopicAuthorizationRule has been deprecated in favor of azure.servicebus.TopicAuthorizationRule

class TopicAuthorizationRule extends CustomResource

Manages a ServiceBus Topic authorization Rule within a ServiceBus Topic. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"}); const exampleNamespace = new azure.servicebus.Namespace("exampleNamespace", { location: exampleResourceGroup.location, resourceGroupName: exampleResourceGroup.name, sku: "Standard", tags: { source: "example", }, }); const exampleTopic = new azure.servicebus.Topic("exampleTopic", { resourceGroupName: exampleResourceGroup.name, namespaceName: exampleNamespace.name, }); const exampleTopicAuthorizationRule = new azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule", { namespaceName: exampleNamespace.name, topicName: exampleTopic.name, resourceGroupName: exampleResourceGroup.name, listen: true, send: false, manage: false, }); ```

constructor

DEPRECATED azure.eventhub.TopicAuthorizationRule has been deprecated in favor of azure.servicebus.TopicAuthorizationRule

new TopicAuthorizationRule(name: string, args: TopicAuthorizationRuleArgs, opts?: pulumi.CustomResourceOptions)

method get

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

Get an existing TopicAuthorizationRule 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 TopicAuthorizationRule

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

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 listen

public listen: pulumi.Output<boolean | undefined>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

public manage: pulumi.Output<boolean | undefined>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

public name: pulumi.Output<string>;

Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

public namespaceName: pulumi.Output<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The Primary Connection String for the ServiceBus Topic authorization Rule.

property primaryKey

public primaryKey: pulumi.Output<string>;

The Primary Key for the ServiceBus Topic authorization Rule.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The Secondary Connection String for the ServiceBus Topic authorization Rule.

property secondaryKey

public secondaryKey: pulumi.Output<string>;

The Secondary Key for the ServiceBus Topic authorization Rule.

property send

public send: pulumi.Output<boolean | undefined>;

Grants send access to this this Authorization Rule. Defaults to false.

property topicName

public topicName: pulumi.Output<string>;

Specifies the name of the ServiceBus Topic. 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.

Functions

Function getAuthorizationRule

getAuthorizationRule(args: GetAuthorizationRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetAuthorizationRuleResult>

Use this data source to access information about an existing Event Hubs Authorization Rule within an Event Hub.

Example Usage

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

const test = pulumi.all([azurerm_eventhub_test.name, azurerm_eventhub_namespace_test.name, azurerm_resource_group_test.name]).apply(([azurerm_eventhub_testName, azurerm_eventhub_namespace_testName, azurerm_resource_group_testName]) => azure.eventhub.getAuthorizationRule({
    eventhubName: azurerm_eventhub_testName,
    name: "test",
    namespaceName: azurerm_eventhub_namespace_testName,
    resourceGroupName: azurerm_resource_group_testName,
}, { async: true }));

Function getConsumeGroup

getConsumeGroup(args: GetConsumeGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetConsumeGroupResult>

Use this data source to access information about an existing Event Hubs Consumer Group within an Event Hub.

Example Usage

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

const test = pulumi.all([azurerm_eventhub_test.name, azurerm_eventhub_consumer_group_test.name, azurerm_eventhub_namespace_test.name, azurerm_resource_group_test.name]).apply(([azurerm_eventhub_testName, azurerm_eventhub_consumer_group_testName, azurerm_eventhub_namespace_testName, azurerm_resource_group_testName]) => azure.eventhub.getConsumeGroup({
    eventhubName: azurerm_eventhub_testName,
    name: azurerm_eventhub_consumer_group_testName,
    namespaceName: azurerm_eventhub_namespace_testName,
    resourceGroupName: azurerm_resource_group_testName,
}, { async: true }));

Function getEventHub

getEventHub(args: GetEventHubArgs, opts?: pulumi.InvokeOptions): Promise<GetEventHubResult>

Use this data source to access information about an existing EventHub.

Example Usage

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

const example = azure.eventhub.getEventHub({
    name: "search-eventhub",
    resourceGroupName: "search-service",
    namespaceName: "search-eventhubns",
});
export const eventhubId = example.then(example => example.id);

Function getEventhubNamespace

DEPRECATED azure.eventhub.getEventhubNamespace has been deprecated in favor of azure.eventhub.getNamespace

getEventhubNamespace(args: GetEventhubNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetEventhubNamespaceResult>

Function getNamespace

getNamespace(args: GetNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceResult>

Use this data source to access information about an existing EventHub Namespace.

Example Usage

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

const example = azure.eventhub.getNamespace({
    name: "search-eventhubns",
    resourceGroupName: "search-service",
});
export const eventhubNamespaceId = example.then(example => example.id);

Function getNamespaceAuthorizationRule

getNamespaceAuthorizationRule(args: GetNamespaceAuthorizationRuleArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceAuthorizationRuleResult>

Use this data source to access information about an Authorization Rule for an Event Hub Namespace.

Example Usage

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

const example = azure.eventhub.getNamespaceAuthorizationRule({
    name: "navi",
    resourceGroupName: "example-resources",
    namespaceName: "example-ns",
});
export const eventhubAuthorizationRuleId = data.azurem_eventhub_namespace_authorization_rule.example.id;

Function getServiceBusNamespace

DEPRECATED azure.eventhub.getServiceBusNamespace has been deprecated in favor of azure.servicebus.getNamespace

getServiceBusNamespace(args: GetServiceBusNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceBusNamespaceResult>

Others

interface AuthorizationRuleArgs

interface AuthorizationRuleArgs

The set of arguments for constructing a AuthorizationRule resource.

property eventhubName

eventhubName: pulumi.Input<string>;

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

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

interface AuthorizationRuleState

interface AuthorizationRuleState

Input properties used for looking up and filtering AuthorizationRule resources.

property eventhubName

eventhubName?: pulumi.Input<string>;

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

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the Event Hubs authorization Rule.

property primaryConnectionStringAlias

primaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the Event Hubs authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryConnectionStringAlias

secondaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the Event Hubs Authorization Rule.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

interface ConsumerGroupArgs

interface ConsumerGroupArgs

The set of arguments for constructing a ConsumerGroup resource.

property eventhubName

eventhubName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists. Changing this forces a new resource to be created.

property userMetadata

userMetadata?: pulumi.Input<string>;

Specifies the user metadata.

interface ConsumerGroupState

interface ConsumerGroupState

Input properties used for looking up and filtering ConsumerGroup resources.

property eventhubName

eventhubName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists. Changing this forces a new resource to be created.

property userMetadata

userMetadata?: pulumi.Input<string>;

Specifies the user metadata.

const DefaultConsumerGroup

const DefaultConsumerGroup: "$Default" = "$Default";

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>;

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 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.

type EventGridCallbackSubscriptionArgs

DEPRECATED This type has moved to the [eventgrid] module.

type EventGridCallbackSubscriptionArgs = EventGridCallbackSubscriptionArgs<T>;

type EventGridContext

DEPRECATED This type has moved to the [eventgrid] module.

type EventGridContext = EventGridContext<T>;

type EventGridEvent

DEPRECATED This type has moved to the [eventgrid] module.

type EventGridEvent = EventGridEvent<T>;

type EventGridFunctionArgs

DEPRECATED This type has moved to the [eventgrid] module.

type EventGridFunctionArgs = EventGridFunctionArgs<T>;

type EventGridScope

DEPRECATED This type has moved to the [eventgrid] module.

type EventGridScope = EventGridScope;

interface EventGridTopicArgs

interface EventGridTopicArgs

The set of arguments for constructing a EventGridTopic resource.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<EventGridTopicInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<EventGridTopicInputMappingFields>;

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 EventGridTopicState

interface EventGridTopicState

Input properties used for looking up and filtering EventGridTopic resources.

property endpoint

endpoint?: pulumi.Input<string>;

The Endpoint associated with the EventGrid Topic.

property inputMappingDefaultValues

inputMappingDefaultValues?: pulumi.Input<EventGridTopicInputMappingDefaultValues>;

A inputMappingDefaultValues block as defined below.

property inputMappingFields

inputMappingFields?: pulumi.Input<EventGridTopicInputMappingFields>;

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>}>;

A mapping of tags to assign to the resource.

interface EventHubArgs

interface EventHubArgs

The set of arguments for constructing a EventHub resource.

property captureDescription

captureDescription?: pulumi.Input<EventHubCaptureDescription>;

A captureDescription block as defined below.

property messageRetention

messageRetention: pulumi.Input<number>;

Specifies the number of days to retain the events for this Event Hub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent EventHub Namespace.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property partitionCount

partitionCount: pulumi.Input<number>;

Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventHub’s parent Namespace exists. Changing this forces a new resource to be created.

interface EventHubAuthorizationRuleArgs

interface EventHubAuthorizationRuleArgs

The set of arguments for constructing a EventHubAuthorizationRule resource.

property eventhubName

eventhubName: pulumi.Input<string>;

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

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

interface EventHubAuthorizationRuleState

interface EventHubAuthorizationRuleState

Input properties used for looking up and filtering EventHubAuthorizationRule resources.

property eventhubName

eventhubName?: pulumi.Input<string>;

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

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Manage to the Event Hub? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the Event Hubs authorization Rule.

property primaryConnectionStringAlias

primaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Primary Connection String for the Event Hubs authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the Event Hubs authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryConnectionStringAlias

secondaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Secondary Connection String for the Event Hubs Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the Event Hubs Authorization Rule.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

interface EventHubBindingDefinition

interface EventHubBindingDefinition extends BindingDefinition

This is only exported to be used internally by the /iot/zMixins.ts file

property cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property connection

connection: pulumi.Input<string>;

The name of an app setting that contains the Event Hub connection string to use for this binding.

property consumerGroup

consumerGroup?: pulumi.Input<string>;

An optional property that sets the consumer group used to subscribe to events in the hub. If not present, a new Consumer Group resource will be created.

property direction

direction: "in";

The direction of the binding. We only support events being inputs to functions.

property eventHubName

eventHubName: pulumi.Input<string>;

The name of the event hub we are subscribing to.

property name

name: string;

The name of the property in the context object to bind the actual event to.

property type

type: "eventHubTrigger";

The type of an event hub binding. Must be ‘eventHubTrigger’.

type EventHubCallback

type EventHubCallback = appservice.Callback<EventHubContext, string, appservice.FunctionDefaultResponse>;

Signature of the callback that can receive event hub notifications.

interface EventHubConsumerGroupArgs

interface EventHubConsumerGroupArgs

The set of arguments for constructing a EventHubConsumerGroup resource.

property eventhubName

eventhubName: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists. Changing this forces a new resource to be created.

property userMetadata

userMetadata?: pulumi.Input<string>;

Specifies the user metadata.

interface EventHubConsumerGroupState

interface EventHubConsumerGroupState

Input properties used for looking up and filtering EventHubConsumerGroup resources.

property eventhubName

eventhubName?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists. Changing this forces a new resource to be created.

property userMetadata

userMetadata?: pulumi.Input<string>;

Specifies the user metadata.

interface EventHubContext

interface EventHubContext extends Context<appservice.FunctionDefaultResponse>

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

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: {
    enqueuedTimeUtc: string;
    invocationId: string;
    offset: number;
    partitionContext: {
        consumerGroupName: string;
        eventHubPath: string;
        owner: string;
        partitionId: string;
        runtimeInformation: {
            lastEnqueuedTimeUtc: string;
            lastSequenceNumber: number;
            partitionId: string;
            retrievalTime: string;
        };
    };
    partitionKey: string;
    properties: Record<string, any>;
    sequenceNumber: number;
    sys: {
        methodName: string;
        utcNow: string;
    };
    systemProperties: Record<string, any>;
};

property bindingDefinitions

bindingDefinitions: BindingDefinition[];

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

property bindings

bindings: {
    eventHub: string;
};

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.

class EventHubFunction

class EventHubFunction extends Function<EventHubContext, string, appservice.FunctionDefaultResponse>

Azure Function triggered by an Event Hub.

constructor

new EventHubFunction(name: string, args: EventHubFunctionArgs)

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<EventHubContext, string, appservice.FunctionDefaultResponse>;

Function callback.

property name

public name: string;

Function name.

interface EventHubFunctionArgs

interface EventHubFunctionArgs extends GetEventHubFunctionArgs

property callback

callback?: Callback<EventHubContext, any, 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<EventHubContext, any, 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 cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property consumerGroup

consumerGroup?: EventHubConsumerGroup;

Optional Consumer Group to subscribe the FunctionApp to. If not present, the default consumer group will be used.

property eventHub

eventHub: EventHub;

Event Hub to subscribe the Function to.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

interface EventHubNamespaceArgs

interface EventHubNamespaceArgs

The set of arguments for constructing a EventHubNamespace resource.

property autoInflateEnabled

autoInflateEnabled?: pulumi.Input<boolean>;

Is Auto Inflate enabled for the EventHub Namespace?

property capacity

capacity?: pulumi.Input<number>;

Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.

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 maximumThroughputUnits

maximumThroughputUnits?: pulumi.Input<number>;

Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property networkRulesets

networkRulesets?: pulumi.Input<EventHubNamespaceNetworkRulesets>;

A networkRulesets block as defined below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<string>;

Defines which tier to use. Valid options are Basic and Standard.

property tags

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

A mapping of tags to assign to the resource.

interface EventHubNamespaceAuthorizationRuleArgs

interface EventHubNamespaceAuthorizationRuleArgs

The set of arguments for constructing a EventHubNamespaceAuthorizationRule resource.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

interface EventHubNamespaceAuthorizationRuleState

interface EventHubNamespaceAuthorizationRuleState

Input properties used for looking up and filtering EventHubNamespaceAuthorizationRule resources.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the Authorization Rule.

property primaryConnectionStringAlias

primaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Primary Connection String for the Authorization Rule, which is generated when disaster recovery is enabled.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the Authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the Authorization Rule.

property secondaryConnectionStringAlias

secondaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the Secondary Connection String for the Authorization Rule, which is generated when disaster recovery is enabled.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the Authorization Rule.

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

interface EventhubNamespaceDisasterRecoveryConfigArgs

interface EventhubNamespaceDisasterRecoveryConfigArgs

The set of arguments for constructing a EventhubNamespaceDisasterRecoveryConfig resource.

property alternateName

alternateName?: pulumi.Input<string>;

An alternate name to use when the Disaster Recovery Config’s name is the same as the replicated namespace’s name.

property name

name?: pulumi.Input<string>;

Specifies the name of the Disaster Recovery Config. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the primary EventHub Namespace to replicate. Changing this forces a new resource to be created.

property partnerNamespaceId

partnerNamespaceId: pulumi.Input<string>;

The ID of the EventHub Namespace to replicate to.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which the Disaster Recovery Config exists. Changing this forces a new resource to be created.

interface EventhubNamespaceDisasterRecoveryConfigState

interface EventhubNamespaceDisasterRecoveryConfigState

Input properties used for looking up and filtering EventhubNamespaceDisasterRecoveryConfig resources.

property alternateName

alternateName?: pulumi.Input<string>;

An alternate name to use when the Disaster Recovery Config’s name is the same as the replicated namespace’s name.

property name

name?: pulumi.Input<string>;

Specifies the name of the Disaster Recovery Config. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the primary EventHub Namespace to replicate. Changing this forces a new resource to be created.

property partnerNamespaceId

partnerNamespaceId?: pulumi.Input<string>;

The ID of the EventHub Namespace to replicate to.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the Disaster Recovery Config exists. Changing this forces a new resource to be created.

interface EventHubNamespaceState

interface EventHubNamespaceState

Input properties used for looking up and filtering EventHubNamespace resources.

property autoInflateEnabled

autoInflateEnabled?: pulumi.Input<boolean>;

Is Auto Inflate enabled for the EventHub Namespace?

property capacity

capacity?: pulumi.Input<number>;

Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.

property defaultPrimaryConnectionString

defaultPrimaryConnectionString?: pulumi.Input<string>;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryConnectionStringAlias

defaultPrimaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the primary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.

property defaultPrimaryKey

defaultPrimaryKey?: pulumi.Input<string>;

The primary access key for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionString

defaultSecondaryConnectionString?: pulumi.Input<string>;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionStringAlias

defaultSecondaryConnectionStringAlias?: pulumi.Input<string>;

The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey, which is generated when disaster recovery is enabled.

property defaultSecondaryKey

defaultSecondaryKey?: pulumi.Input<string>;

The secondary access key for the authorization rule RootManageSharedAccessKey.

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 maximumThroughputUnits

maximumThroughputUnits?: pulumi.Input<number>;

Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property networkRulesets

networkRulesets?: pulumi.Input<EventHubNamespaceNetworkRulesets>;

A networkRulesets block as defined below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

Defines which tier to use. Valid options are Basic and Standard.

property tags

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

A mapping of tags to assign to the resource.

interface EventHubState

interface EventHubState

Input properties used for looking up and filtering EventHub resources.

property captureDescription

captureDescription?: pulumi.Input<EventHubCaptureDescription>;

A captureDescription block as defined below.

property messageRetention

messageRetention?: pulumi.Input<number>;

Specifies the number of days to retain the events for this Event Hub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent EventHub Namespace.

property name

name?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

property partitionCount

partitionCount?: pulumi.Input<number>;

Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.

property partitionIds

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

The identifiers for partitions created for Event Hubs.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which the EventHub’s parent Namespace exists. Changing this forces a new resource to be created.

class EventHubSubscription

class EventHubSubscription extends EventSubscription<EventHubContext, string, appservice.FunctionDefaultResponse>

constructor

new EventHubSubscription(name: string, eventHub: EventHub, args: EventHubSubscriptionArgs, 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 consumerGroup

consumerGroup?: EventHubConsumerGroup;

property eventHub

eventHub: EventHub;

property functionApp

public functionApp: CallbackFunctionApp<EventHubContext, string, appservice.FunctionDefaultResponse>;

property urn

urn: Output<URN>;

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

interface EventHubSubscriptionArgs

interface EventHubSubscriptionArgs extends GetEventHubFunctionArgs, CallbackFunctionAppArgs<EventHubContext, any, 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<EventHubContext, any, 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<EventHubContext, any, 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 cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

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 consumerGroup

consumerGroup?: EventHubConsumerGroup;

Optional Consumer Group to subscribe the FunctionApp to. If not present, the default consumer group will be used.

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 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 Event Hub’s resource group will be used.

property siteConfig

siteConfig?: pulumi.Input<FunctionAppSiteConfig>;

A site_config object 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 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>;

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

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 GetAuthorizationRuleArgs

interface GetAuthorizationRuleArgs

A collection of arguments for invoking getAuthorizationRule.

property eventhubName

eventhubName: string;

Specifies the name of the EventHub.

property listen

listen?: undefined | false | true;

property manage

manage?: undefined | false | true;

property name

name: string;

Specifies the name of the EventHub Authorization Rule resource. be created.

property namespaceName

namespaceName: string;

Specifies the name of the grandparent EventHub Namespace.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the EventHub Authorization Rule’s grandparent Namespace exists.

property send

send?: undefined | false | true;

interface GetAuthorizationRuleResult

interface GetAuthorizationRuleResult

A collection of values returned by getAuthorizationRule.

property eventhubName

eventhubName: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property listen

listen?: undefined | false | true;

property location

location: string;

property manage

manage?: undefined | false | true;

property name

name: string;

property namespaceName

namespaceName: string;

property primaryConnectionString

primaryConnectionString: string;

The Primary Connection String for the Event Hubs Authorization Rule.

property primaryConnectionStringAlias

primaryConnectionStringAlias: string;

The alias of the Primary Connection String for the Event Hubs Authorization Rule.

property primaryKey

primaryKey: string;

The Primary Key for the Event Hubs Authorization Rule.

property resourceGroupName

resourceGroupName: string;

property secondaryConnectionString

secondaryConnectionString: string;

The Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryConnectionStringAlias

secondaryConnectionStringAlias: string;

The alias of the Secondary Connection String for the Event Hubs Authorization Rule.

property secondaryKey

secondaryKey: string;

The Secondary Key for the Event Hubs Authorization Rule.

property send

send?: undefined | false | true;

interface GetConsumeGroupArgs

interface GetConsumeGroupArgs

A collection of arguments for invoking getConsumeGroup.

property eventhubName

eventhubName: string;

Specifies the name of the EventHub.

property name

name: string;

Specifies the name of the EventHub Consumer Group resource.

property namespaceName

namespaceName: string;

Specifies the name of the grandparent EventHub Namespace.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

interface GetConsumeGroupResult

interface GetConsumeGroupResult

A collection of values returned by getConsumeGroup.

property eventhubName

eventhubName: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

property name

name: string;

property namespaceName

namespaceName: string;

property resourceGroupName

resourceGroupName: string;

property userMetadata

userMetadata: string;

Specifies the user metadata.

interface GetEventHubArgs

interface GetEventHubArgs

A collection of arguments for invoking getEventHub.

property name

name: string;

The name of this EventHub.

property namespaceName

namespaceName: string;

The name of the EventHub Namespace where the EventHub exists.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group where the EventHub exists.

interface GetEventHubFunctionArgs

interface GetEventHubFunctionArgs extends CallbackFunctionArgs<EventHubContext, any, appservice.FunctionDefaultResponse>

property callback

callback?: Callback<EventHubContext, any, 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<EventHubContext, any, 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 cardinality

cardinality?: pulumi.Input<"many" | "one">;

Set to ‘many’ in order to enable batching. If omitted or set to ‘one’, single message passed to function.

property consumerGroup

consumerGroup?: EventHubConsumerGroup;

Optional Consumer Group to subscribe the FunctionApp to. If not present, the default consumer group will be used.

property inputs

inputs?: InputBindingSettings[];

Input bindings.

property outputs

outputs?: OutputBindingSettings[];

Output bindings.

interface GetEventhubNamespaceArgs

interface GetEventhubNamespaceArgs

A collection of arguments for invoking getEventhubNamespace.

property name

name: string;

The name of the EventHub Namespace.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the EventHub Namespace exists.

interface GetEventhubNamespaceResult

interface GetEventhubNamespaceResult

A collection of values returned by getEventhubNamespace.

property autoInflateEnabled

autoInflateEnabled: boolean;

Is Auto Inflate enabled for the EventHub Namespace?

property capacity

capacity: number;

The Capacity / Throughput Units for a Standard SKU namespace.

property defaultPrimaryConnectionString

defaultPrimaryConnectionString: string;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryConnectionStringAlias

defaultPrimaryConnectionStringAlias: string;

The alias of the primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryKey

defaultPrimaryKey: string;

The primary access key for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionString

defaultSecondaryConnectionString: string;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionStringAlias

defaultSecondaryConnectionStringAlias: string;

The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryKey

defaultSecondaryKey: string;

The secondary access key for the authorization rule RootManageSharedAccessKey.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kafkaEnabled

kafkaEnabled: boolean;

property location

location: string;

The Azure location where the EventHub Namespace exists

property maximumThroughputUnits

maximumThroughputUnits: number;

Specifies the maximum number of throughput units when Auto Inflate is Enabled.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

Defines which tier to use.

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the EventHub Namespace.

interface GetEventHubResult

interface GetEventHubResult

A collection of values returned by getEventHub.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property namespaceName

namespaceName: string;

property partitionCount

partitionCount: number;

The number of partitions in the EventHub.

property partitionIds

partitionIds: string[];

The identifiers for the partitions of this EventHub.

property resourceGroupName

resourceGroupName: string;

interface GetNamespaceArgs

interface GetNamespaceArgs

A collection of arguments for invoking getNamespace.

property name

name: string;

The name of the EventHub Namespace.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where the EventHub Namespace exists.

interface GetNamespaceAuthorizationRuleArgs

interface GetNamespaceAuthorizationRuleArgs

A collection of arguments for invoking getNamespaceAuthorizationRule.

property name

name: string;

The name of the EventHub Authorization Rule resource.

property namespaceName

namespaceName: string;

Specifies the name of the EventHub Namespace.

property resourceGroupName

resourceGroupName: string;

The name of the resource group in which the EventHub Namespace exists.

interface GetNamespaceAuthorizationRuleResult

interface GetNamespaceAuthorizationRuleResult

A collection of values returned by getNamespaceAuthorizationRule.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property listen

listen: boolean;

Does this Authorization Rule have permissions to Listen to the Event Hub?

property manage

manage: boolean;

Does this Authorization Rule have permissions to Manage to the Event Hub?

property name

name: string;

property namespaceName

namespaceName: string;

property primaryConnectionString

primaryConnectionString: string;

The Primary Connection String for the Event Hubs authorization Rule.

property primaryConnectionStringAlias

primaryConnectionStringAlias: string;

The alias of the Primary Connection String for the Event Hubs authorization Rule.

property primaryKey

primaryKey: string;

The Primary Key for the Event Hubs authorization Rule.

property resourceGroupName

resourceGroupName: string;

property secondaryConnectionString

secondaryConnectionString: string;

The Secondary Connection String for the Event Hubs authorization Rule.

property secondaryConnectionStringAlias

secondaryConnectionStringAlias: string;

The alias of the Secondary Connection String for the Event Hubs authorization Rule.

property secondaryKey

secondaryKey: string;

The Secondary Key for the Event Hubs authorization Rule.

property send

send: boolean;

Does this Authorization Rule have permissions to Send to the Event Hub?

interface GetNamespaceResult

interface GetNamespaceResult

A collection of values returned by getNamespace.

property autoInflateEnabled

autoInflateEnabled: boolean;

Is Auto Inflate enabled for the EventHub Namespace?

property capacity

capacity: number;

The Capacity / Throughput Units for a Standard SKU namespace.

property defaultPrimaryConnectionString

defaultPrimaryConnectionString: string;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryConnectionStringAlias

defaultPrimaryConnectionStringAlias: string;

The alias of the primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryKey

defaultPrimaryKey: string;

The primary access key for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionString

defaultSecondaryConnectionString: string;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionStringAlias

defaultSecondaryConnectionStringAlias: string;

The alias of the secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryKey

defaultSecondaryKey: string;

The secondary access key for the authorization rule RootManageSharedAccessKey.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kafkaEnabled

kafkaEnabled: boolean;

property location

location: string;

The Azure location where the EventHub Namespace exists

property maximumThroughputUnits

maximumThroughputUnits: number;

Specifies the maximum number of throughput units when Auto Inflate is Enabled.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

Defines which tier to use.

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the EventHub Namespace.

interface GetServiceBusNamespaceArgs

interface GetServiceBusNamespaceArgs

A collection of arguments for invoking getServiceBusNamespace.

property name

name: string;

Specifies the name of the ServiceBus Namespace.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the Resource Group where the ServiceBus Namespace exists.

interface GetServiceBusNamespaceResult

interface GetServiceBusNamespaceResult

A collection of values returned by getServiceBusNamespace.

property capacity

capacity: number;

The capacity of the ServiceBus Namespace.

property defaultPrimaryConnectionString

defaultPrimaryConnectionString: string;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryKey

defaultPrimaryKey: string;

The primary access key for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionString

defaultSecondaryConnectionString: string;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryKey

defaultSecondaryKey: string;

The secondary access key for the authorization rule RootManageSharedAccessKey.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property location

location: string;

The location of the Resource Group in which the ServiceBus Namespace exists.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

The Tier used for the ServiceBus Namespace.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to the resource.

property zoneRedundant

zoneRedundant: boolean;

Whether or not this ServiceBus Namespace is zone redundant.

type GetTopicFunctionArgs

DEPRECATED This type has moved to the [servicebus] module.

type GetTopicFunctionArgs = GetTopicFunctionArgs;

interface NamespaceArgs

interface NamespaceArgs

The set of arguments for constructing a Namespace resource.

property capacity

capacity?: pulumi.Input<number>;

Specifies the capacity. When sku is Premium, capacity can be 1, 2, 4 or 8. When sku is Basic or Standard, capacity can be 0 only.

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 ServiceBus Namespace resource . Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the namespace.

property sku

sku: pulumi.Input<string>;

Defines which tier to use. Options are basic, standard or premium. 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.

property zoneRedundant

zoneRedundant?: pulumi.Input<boolean>;

Whether or not this resource is zone redundant. sku needs to be Premium. Defaults to false.

interface NamespaceAuthorizationRuleArgs

interface NamespaceAuthorizationRuleArgs

The set of arguments for constructing a NamespaceAuthorizationRule resource.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

interface NamespaceAuthorizationRuleState

interface NamespaceAuthorizationRuleState

Input properties used for looking up and filtering NamespaceAuthorizationRule resources.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the ServiceBus Namespace authorization Rule.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the ServiceBus Namespace authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the ServiceBus Namespace authorization Rule.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the ServiceBus Namespace authorization Rule.

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

interface NamespaceState

interface NamespaceState

Input properties used for looking up and filtering Namespace resources.

property capacity

capacity?: pulumi.Input<number>;

Specifies the capacity. When sku is Premium, capacity can be 1, 2, 4 or 8. When sku is Basic or Standard, capacity can be 0 only.

property defaultPrimaryConnectionString

defaultPrimaryConnectionString?: pulumi.Input<string>;

The primary connection string for the authorization rule RootManageSharedAccessKey.

property defaultPrimaryKey

defaultPrimaryKey?: pulumi.Input<string>;

The primary access key for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryConnectionString

defaultSecondaryConnectionString?: pulumi.Input<string>;

The secondary connection string for the authorization rule RootManageSharedAccessKey.

property defaultSecondaryKey

defaultSecondaryKey?: pulumi.Input<string>;

The secondary access key for the authorization rule RootManageSharedAccessKey.

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 ServiceBus Namespace resource . Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the namespace.

property sku

sku?: pulumi.Input<string>;

Defines which tier to use. Options are basic, standard or premium. 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.

property zoneRedundant

zoneRedundant?: pulumi.Input<boolean>;

Whether or not this resource is zone redundant. sku needs to be Premium. Defaults to false.

interface QueueArgs

interface QueueArgs

The set of arguments for constructing a Queue resource.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

property deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: pulumi.Input<boolean>;

Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

The ISO 8601 timespan duration of the TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself.

property duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: pulumi.Input<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

property enableExpress

enableExpress?: pulumi.Input<boolean>;

Boolean flag which controls whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage. Defaults to false for Basic and Standard. For Premium, it MUST be set to false.

property enablePartitioning

enablePartitioning?: pulumi.Input<boolean>;

Boolean flag which controls whether to enable the queue to be partitioned across multiple message brokers. Changing this forces a new resource to be created. Defaults to false for Basic and Standard. For Premium, it MUST be set to true.

property lockDuration

lockDuration?: pulumi.Input<string>;

The ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. Maximum value is 5 minutes. Defaults to 1 minute. (PT1M)

property maxDeliveryCount

maxDeliveryCount?: pulumi.Input<number>;

Integer value which controls when a message is automatically deadlettered. Defaults to 10.

property maxSizeInMegabytes

maxSizeInMegabytes?: pulumi.Input<number>;

Integer value which controls the size of memory allocated for the queue. For supported values see the “Queue/topic size” section of this document.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

requiresDuplicateDetection?: pulumi.Input<boolean>;

Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

property requiresSession

requiresSession?: pulumi.Input<boolean>;

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

interface QueueAuthorizationRuleArgs

interface QueueAuthorizationRuleArgs

The set of arguments for constructing a QueueAuthorizationRule resource.

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.

property queueName

queueName: pulumi.Input<string>;

Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

interface QueueAuthorizationRuleState

interface QueueAuthorizationRuleState

Input properties used for looking up and filtering QueueAuthorizationRule resources.

property listen

listen?: pulumi.Input<boolean>;

Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Does this Authorization Rule have Manage permissions to the ServiceBus Queue? When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the Authorization Rule.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the Authorization Rule.

property queueName

queueName?: pulumi.Input<string>;

Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the Authorization Rule.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the Authorization Rule.

property send

send?: pulumi.Input<boolean>;

Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

type QueueEventSubscriptionArgs

DEPRECATED This type has moved to the [servicebus] module.

type QueueEventSubscriptionArgs = QueueEventSubscriptionArgs;

interface QueueState

interface QueueState

Input properties used for looking up and filtering Queue resources.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

property deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: pulumi.Input<boolean>;

Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

The ISO 8601 timespan duration of the TTL of messages sent to this queue. This is the default value used when TTL is not set on message itself.

property duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: pulumi.Input<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

property enableExpress

enableExpress?: pulumi.Input<boolean>;

property enablePartitioning

enablePartitioning?: pulumi.Input<boolean>;

property lockDuration

lockDuration?: pulumi.Input<string>;

The ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. Maximum value is 5 minutes. Defaults to 1 minute. (PT1M)

property maxDeliveryCount

maxDeliveryCount?: pulumi.Input<number>;

Integer value which controls when a message is automatically deadlettered. Defaults to 10.

property maxSizeInMegabytes

maxSizeInMegabytes?: pulumi.Input<number>;

Integer value which controls the size of memory allocated for the queue. For supported values see the “Queue/topic size” section of this document.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

requiresDuplicateDetection?: pulumi.Input<boolean>;

Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

property requiresSession

requiresSession?: pulumi.Input<boolean>;

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

type ResourceGroupEventGridCallbackSubscriptionArgs

DEPRECATED This type has moved to the [eventgrid] module.

type ResourceGroupEventGridCallbackSubscriptionArgs = ResourceGroupEventGridCallbackSubscriptionArgs;

type ServiceBusCallback

DEPRECATED This type has moved to the [servicebus] module.

type ServiceBusCallback = servicebus.ServiceBusCallback;

type ServiceBusContext

DEPRECATED This type has moved to the [servicebus] module.

type ServiceBusContext = ServiceBusContext;

type ServiceBusFunctionArgs

DEPRECATED This type has moved to the [servicebus] module.

type ServiceBusFunctionArgs = ServiceBusFunctionArgs;

type ServiceBusHostExtensions

DEPRECATED This type has moved to the [servicebus] module.

type ServiceBusHostExtensions = ServiceBusHostExtensions;

type ServiceBusHostSettings

DEPRECATED This type has moved to the [servicebus] module.

type ServiceBusHostSettings = ServiceBusHostSettings;

type StorageAccountEventGridCallbackSubscriptionArgs

DEPRECATED This type has moved to the [eventgrid] module.

type StorageAccountEventGridCallbackSubscriptionArgs = StorageAccountEventGridCallbackSubscriptionArgs<T>;

interface SubscriptionArgs

interface SubscriptionArgs

The set of arguments for constructing a Subscription resource.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The idle interval after which the topic is automatically deleted as an ISO 8601 duration. The minimum duration is 5 minutes or P5M.

property deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: pulumi.Input<boolean>;

Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to false.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

The Default message timespan to live as an ISO 8601 duration. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

property enableBatchedOperations

enableBatchedOperations?: pulumi.Input<boolean>;

Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.

property forwardDeadLetteredMessagesTo

forwardDeadLetteredMessagesTo?: pulumi.Input<string>;

The name of a Queue or Topic to automatically forward Dead Letter messages to.

property forwardTo

forwardTo?: pulumi.Input<string>;

The name of a Queue or Topic to automatically forward messages to.

property lockDuration

lockDuration?: pulumi.Input<string>;

The lock duration for the subscription as an ISO 8601 duration. The default value is 1 minute or P1M.

property maxDeliveryCount

maxDeliveryCount: pulumi.Input<number>;

The maximum number of deliveries.

property name

name?: pulumi.Input<string>;

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

property namespaceName

namespaceName: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

property requiresSession

requiresSession?: pulumi.Input<boolean>;

Boolean flag which controls whether this Subscription supports the concept of a session. Defaults to false. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property topicName

topicName: pulumi.Input<string>;

The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created.

interface SubscriptionRuleArgs

interface SubscriptionRuleArgs

The set of arguments for constructing a SubscriptionRule resource.

property action

action?: pulumi.Input<string>;

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

property correlationFilter

correlationFilter?: pulumi.Input<SubscriptionRuleCorrelationFilter>;

A correlationFilter block as documented below to be evaluated against a BrokeredMessage. Required when filterType is set to CorrelationFilter.

property filterType

filterType: pulumi.Input<string>;

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

property sqlFilter

sqlFilter?: pulumi.Input<string>;

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filterType is set to SqlFilter.

property subscriptionName

subscriptionName: pulumi.Input<string>;

The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

property topicName

topicName: pulumi.Input<string>;

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

interface SubscriptionRuleState

interface SubscriptionRuleState

Input properties used for looking up and filtering SubscriptionRule resources.

property action

action?: pulumi.Input<string>;

Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

property correlationFilter

correlationFilter?: pulumi.Input<SubscriptionRuleCorrelationFilter>;

A correlationFilter block as documented below to be evaluated against a BrokeredMessage. Required when filterType is set to CorrelationFilter.

property filterType

filterType?: pulumi.Input<string>;

Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

property sqlFilter

sqlFilter?: pulumi.Input<string>;

Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filterType is set to SqlFilter.

property subscriptionName

subscriptionName?: pulumi.Input<string>;

The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

property topicName

topicName?: pulumi.Input<string>;

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

interface SubscriptionState

interface SubscriptionState

Input properties used for looking up and filtering Subscription resources.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The idle interval after which the topic is automatically deleted as an ISO 8601 duration. The minimum duration is 5 minutes or P5M.

property deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: pulumi.Input<boolean>;

Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to false.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

property enableBatchedOperations

enableBatchedOperations?: pulumi.Input<boolean>;

Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.

property forwardDeadLetteredMessagesTo

forwardDeadLetteredMessagesTo?: pulumi.Input<string>;

The name of a Queue or Topic to automatically forward Dead Letter messages to.

property forwardTo

forwardTo?: pulumi.Input<string>;

The name of a Queue or Topic to automatically forward messages to.

property lockDuration

lockDuration?: pulumi.Input<string>;

The lock duration for the subscription as an ISO 8601 duration. The default value is 1 minute or P1M.

property maxDeliveryCount

maxDeliveryCount?: pulumi.Input<number>;

The maximum number of deliveries.

property name

name?: pulumi.Input<string>;

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

property namespaceName

namespaceName?: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

property requiresSession

requiresSession?: pulumi.Input<boolean>;

Boolean flag which controls whether this Subscription supports the concept of a session. Defaults to false. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property topicName

topicName?: pulumi.Input<string>;

The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created.

interface TopicArgs

interface TopicArgs

The set of arguments for constructing a Topic resource.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.

property duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: pulumi.Input<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (PT10M)

property enableBatchedOperations

enableBatchedOperations?: pulumi.Input<boolean>;

Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

property enableExpress

enableExpress?: pulumi.Input<boolean>;

Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. Defaults to false.

property enablePartitioning

enablePartitioning?: pulumi.Input<boolean>;

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Defaults to false. Changing this forces a new resource to be created.

property maxSizeInMegabytes

maxSizeInMegabytes?: pulumi.Input<number>;

Integer value which controls the size of memory allocated for the topic. For supported values see the “Queue/topic size” section of this document.

property name

name?: pulumi.Input<string>;

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

property namespaceName

namespaceName: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

requiresDuplicateDetection?: pulumi.Input<boolean>;

Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property status

status?: pulumi.Input<string>;

The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.

property supportOrdering

supportOrdering?: pulumi.Input<boolean>;

Boolean flag which controls whether the Topic supports ordering. Defaults to false.

interface TopicAuthorizationRuleArgs

interface TopicAuthorizationRuleArgs

The set of arguments for constructing a TopicAuthorizationRule resource.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

property topicName

topicName: pulumi.Input<string>;

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

interface TopicAuthorizationRuleState

interface TopicAuthorizationRuleState

Input properties used for looking up and filtering TopicAuthorizationRule resources.

property listen

listen?: pulumi.Input<boolean>;

Grants listen access to this this Authorization Rule. Defaults to false.

property manage

manage?: pulumi.Input<boolean>;

Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

property name

name?: pulumi.Input<string>;

Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

property namespaceName

namespaceName?: pulumi.Input<string>;

Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The Primary Connection String for the ServiceBus Topic authorization Rule.

property primaryKey

primaryKey?: pulumi.Input<string>;

The Primary Key for the ServiceBus Topic authorization Rule.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The Secondary Connection String for the ServiceBus Topic authorization Rule.

property secondaryKey

secondaryKey?: pulumi.Input<string>;

The Secondary Key for the ServiceBus Topic authorization Rule.

property send

send?: pulumi.Input<boolean>;

Grants send access to this this Authorization Rule. Defaults to false.

property topicName

topicName?: pulumi.Input<string>;

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

type TopicEventSubscriptionArgs

DEPRECATED This type has moved to the [servicebus] module.

type TopicEventSubscriptionArgs = TopicAuthorizationRuleArgs;

interface TopicState

interface TopicState

Input properties used for looking up and filtering Topic resources.

property autoDeleteOnIdle

autoDeleteOnIdle?: pulumi.Input<string>;

The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

property defaultMessageTtl

defaultMessageTtl?: pulumi.Input<string>;

The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.

property duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: pulumi.Input<string>;

The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (PT10M)

property enableBatchedOperations

enableBatchedOperations?: pulumi.Input<boolean>;

Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

property enableExpress

enableExpress?: pulumi.Input<boolean>;

Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. Defaults to false.

property enablePartitioning

enablePartitioning?: pulumi.Input<boolean>;

Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers. Defaults to false. Changing this forces a new resource to be created.

property maxSizeInMegabytes

maxSizeInMegabytes?: pulumi.Input<number>;

Integer value which controls the size of memory allocated for the topic. For supported values see the “Queue/topic size” section of this document.

property name

name?: pulumi.Input<string>;

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

property namespaceName

namespaceName?: pulumi.Input<string>;

The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

property requiresDuplicateDetection

requiresDuplicateDetection?: pulumi.Input<boolean>;

Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

property status

status?: pulumi.Input<string>;

The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.

property supportOrdering

supportOrdering?: pulumi.Input<boolean>;

Boolean flag which controls whether the Topic supports ordering. Defaults to false.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module eventhub

namespace events

Resources

Functions

Others

namespace events

Resources