eventhub

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.eventhub.AuthorizationRule(resource_name, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages a Event Hubs authorization Rule within an Event Hub.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

eventhub_name = None

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

listen = None

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

manage = None

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.

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the Event Hubs authorization Rule.

primary_key = None

The Primary Key for the Event Hubs authorization Rule.

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the Event Hubs Authorization Rule.

secondary_key = None

The Secondary Key for the Event Hubs Authorization Rule.

send = None

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

static get(resource_name, id, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the Event Hubs authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the Event Hubs authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the Event Hubs Authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the Event Hubs Authorization Rule.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.AwaitableGetAuthorizationRuleResult(eventhub_name=None, id=None, listen=None, location=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)
class pulumi_azure.eventhub.AwaitableGetConsumeGroupResult(eventhub_name=None, id=None, location=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None)
class pulumi_azure.eventhub.AwaitableGetEventhubNamespaceResult(auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, kafka_enabled=None, location=None, maximum_throughput_units=None, name=None, resource_group_name=None, sku=None, tags=None)
class pulumi_azure.eventhub.AwaitableGetNamespaceAuthorizationRuleResult(id=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)
class pulumi_azure.eventhub.AwaitableGetNamespaceResult(auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, kafka_enabled=None, location=None, maximum_throughput_units=None, name=None, resource_group_name=None, sku=None, tags=None)
class pulumi_azure.eventhub.AwaitableGetServiceBusNamespaceResult(capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, zone_redundant=None)
class pulumi_azure.eventhub.ConsumerGroup(resource_name, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None, __props__=None, __name__=None, __opts__=None)

Manages a Event Hubs Consumer Group as a nested resource within an Event Hub.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – 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.

  • user_metadata (pulumi.Input[str]) – Specifies the user metadata.

eventhub_name = None

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

name = None

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

namespace_name = None

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

resource_group_name = None

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.

user_metadata = None

Specifies the user metadata.

static get(resource_name, id, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – 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.

  • user_metadata (pulumi.Input[str]) – Specifies the user metadata.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.Domain(resource_name, opts=None, input_mapping_default_values=None, input_mapping_fields=None, input_schema=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an EventGrid Domain

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.

  • input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.

  • input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are cloudeventv01schema, customeventschema, or eventgridschema. Defaults to eventgridschema. Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

  • dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

  • dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

endpoint = None

The Endpoint associated with the EventGrid Domain.

input_mapping_default_values = None

A input_mapping_default_values block as defined below.

  • dataVersion (str) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (str) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (str) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_mapping_fields = None

A input_mapping_fields block as defined below.

  • dataVersion (str) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventTime (str) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (str) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • id (str) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (str) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • topic (str) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

input_schema = None

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

location = None

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

name = None

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

primary_access_key = None

The Primary Shared Access Key associated with the EventGrid Domain.

resource_group_name = None

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

secondary_access_key = None

The Secondary Shared Access Key associated with the EventGrid Domain.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, endpoint=None, input_mapping_default_values=None, input_mapping_fields=None, input_schema=None, location=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • endpoint (pulumi.Input[str]) – The Endpoint associated with the EventGrid Domain.

  • input_mapping_default_values (pulumi.Input[dict]) – A input_mapping_default_values block as defined below.

  • input_mapping_fields (pulumi.Input[dict]) – A input_mapping_fields block as defined below.

  • input_schema (pulumi.Input[str]) – Specifies the schema in which incoming events will be published to this domain. Allowed values are cloudeventv01schema, customeventschema, or eventgridschema. Defaults to eventgridschema. Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Domain resource. Changing this forces a new resource to be created.

  • primary_access_key (pulumi.Input[str]) – The Primary Shared Access Key associated with the EventGrid Domain.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Domain exists. Changing this forces a new resource to be created.

  • secondary_access_key (pulumi.Input[str]) – The Secondary Shared Access Key associated with the EventGrid Domain.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The input_mapping_default_values object supports the following:

  • dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

The input_mapping_fields object supports the following:

  • dataVersion (pulumi.Input[str]) - Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventTime (pulumi.Input[str]) - Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • eventType (pulumi.Input[str]) - Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • id (pulumi.Input[str]) - Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • subject (pulumi.Input[str]) - Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

  • topic (pulumi.Input[str]) - Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventGridTopic(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an EventGrid Topic

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

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/eventgrid_topic.html.markdown.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

endpoint = None

The Endpoint associated with the EventGrid Topic.

location = None

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

name = None

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

primary_access_key = None

The Primary Shared Access Key associated with the EventGrid Topic.

resource_group_name = None

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

secondary_access_key = None

The Secondary Shared Access Key associated with the EventGrid Topic.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, endpoint=None, location=None, name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • endpoint (pulumi.Input[str]) – The Endpoint associated with the EventGrid Topic.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.

  • primary_access_key (pulumi.Input[str]) – The Primary Shared Access Key associated with the EventGrid Topic.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.

  • secondary_access_key (pulumi.Input[str]) – The Secondary Shared Access Key associated with the EventGrid Topic.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventHub(resource_name, opts=None, capture_description=None, message_retention=None, name=None, namespace_name=None, partition_count=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Event Hubs as a nested resource within a Event Hubs namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • capture_description (pulumi.Input[dict]) – A capture_description block as defined below.

  • message_retention (pulumi.Input[float]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

  • partition_count (pulumi.Input[float]) – Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub’s parent Namespace exists. Changing this forces a new resource to be created.

The capture_description object supports the following:

  • destination (pulumi.Input[dict])

    • archiveNameFormat (pulumi.Input[str])

    • blobContainerName (pulumi.Input[str])

    • name (pulumi.Input[str]) - Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

    • storage_account_id (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • encoding (pulumi.Input[str])

  • interval_in_seconds (pulumi.Input[float])

  • sizeLimitInBytes (pulumi.Input[float])

  • skipEmptyArchives (pulumi.Input[bool])

capture_description = None

A capture_description block as defined below.

  • destination (dict)

    • archiveNameFormat (str)

    • blobContainerName (str)

    • name (str) - Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

    • storage_account_id (str)

  • enabled (bool)

  • encoding (str)

  • interval_in_seconds (float)

  • sizeLimitInBytes (float)

  • skipEmptyArchives (bool)

message_retention = None

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.

name = None

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

namespace_name = None

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

partition_count = None

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

partition_ids = None

The identifiers for partitions created for Event Hubs.

resource_group_name = None

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

static get(resource_name, id, opts=None, capture_description=None, message_retention=None, name=None, namespace_name=None, partition_count=None, partition_ids=None, resource_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • capture_description (pulumi.Input[dict]) – A capture_description block as defined below.

  • message_retention (pulumi.Input[float]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

  • partition_count (pulumi.Input[float]) – Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created.

  • partition_ids (pulumi.Input[list]) – The identifiers for partitions created for Event Hubs.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub’s parent Namespace exists. Changing this forces a new resource to be created.

The capture_description object supports the following:

  • destination (pulumi.Input[dict])

    • archiveNameFormat (pulumi.Input[str])

    • blobContainerName (pulumi.Input[str])

    • name (pulumi.Input[str]) - Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

    • storage_account_id (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

  • encoding (pulumi.Input[str])

  • interval_in_seconds (pulumi.Input[float])

  • sizeLimitInBytes (pulumi.Input[float])

  • skipEmptyArchives (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventHubAuthorizationRule(resource_name, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages a Event Hubs authorization Rule within an Event Hub.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

eventhub_name = None

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

listen = None

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

manage = None

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.

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the Event Hubs authorization Rule.

primary_key = None

The Primary Key for the Event Hubs authorization Rule.

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the Event Hubs Authorization Rule.

secondary_key = None

The Secondary Key for the Event Hubs Authorization Rule.

send = None

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

static get(resource_name, id, opts=None, eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Listen to the Event Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the Event Hubs authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the Event Hubs authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the Event Hubs Authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the Event Hubs Authorization Rule.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have permissions to Send to the Event Hub? Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventHubConsumerGroup(resource_name, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None, __props__=None, __name__=None, __opts__=None)

Manages a Event Hubs Consumer Group as a nested resource within an Event Hub.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – 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.

  • user_metadata (pulumi.Input[str]) – Specifies the user metadata.

eventhub_name = None

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

name = None

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

namespace_name = None

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

resource_group_name = None

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.

user_metadata = None

Specifies the user metadata.

static get(resource_name, id, opts=None, eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • eventhub_name (pulumi.Input[str]) – Specifies the name of the EventHub. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – 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.

  • user_metadata (pulumi.Input[str]) – Specifies the user metadata.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventHubNamespace(resource_name, opts=None, auto_inflate_enabled=None, capacity=None, location=None, maximum_throughput_units=None, name=None, network_rulesets=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an EventHub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_inflate_enabled (pulumi.Input[bool]) – Is Auto Inflate enabled for the EventHub Namespace?

  • capacity (pulumi.Input[float]) – Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • maximum_throughput_units (pulumi.Input[float]) – Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

  • network_rulesets (pulumi.Input[dict]) – A network_rulesets block as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • sku (pulumi.Input[str]) – Defines which tier to use. Valid options are Basic and Standard.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The network_rulesets object supports the following:

  • default_action (pulumi.Input[str])

  • ip_rules (pulumi.Input[list])

    • action (pulumi.Input[str])

    • ipMask (pulumi.Input[str])

  • virtual_network_rules (pulumi.Input[list])

    • ignoreMissingVirtualNetworkServiceEndpoint (pulumi.Input[bool])

    • subnet_id (pulumi.Input[str])

auto_inflate_enabled = None

Is Auto Inflate enabled for the EventHub Namespace?

capacity = None

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

default_primary_connection_string = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key = None

The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

location = None

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

maximum_throughput_units = None

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

name = None

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

network_rulesets = None

A network_rulesets block as defined below.

  • default_action (str)

  • ip_rules (list)

    • action (str)

    • ipMask (str)

  • virtual_network_rules (list)

    • ignoreMissingVirtualNetworkServiceEndpoint (bool)

    • subnet_id (str)

resource_group_name = None

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

sku = None

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

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, location=None, maximum_throughput_units=None, name=None, network_rulesets=None, resource_group_name=None, sku=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_inflate_enabled (pulumi.Input[bool]) – Is Auto Inflate enabled for the EventHub Namespace?

  • capacity (pulumi.Input[float]) – Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.

  • default_primary_connection_string (pulumi.Input[str]) – The primary connection string for the authorization rule RootManageSharedAccessKey.

  • default_primary_key (pulumi.Input[str]) – The primary access key for the authorization rule RootManageSharedAccessKey.

  • default_secondary_connection_string (pulumi.Input[str]) – The secondary connection string for the authorization rule RootManageSharedAccessKey.

  • default_secondary_key (pulumi.Input[str]) – The secondary access key for the authorization rule RootManageSharedAccessKey.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • maximum_throughput_units (pulumi.Input[float]) – Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.

  • name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.

  • network_rulesets (pulumi.Input[dict]) – A network_rulesets block as defined below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • sku (pulumi.Input[str]) – Defines which tier to use. Valid options are Basic and Standard.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The network_rulesets object supports the following:

  • default_action (pulumi.Input[str])

  • ip_rules (pulumi.Input[list])

    • action (pulumi.Input[str])

    • ipMask (pulumi.Input[str])

  • virtual_network_rules (pulumi.Input[list])

    • ignoreMissingVirtualNetworkServiceEndpoint (pulumi.Input[bool])

    • subnet_id (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventHubNamespaceAuthorizationRule(resource_name, opts=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages an Authorization Rule for an Event Hub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

listen = None

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

manage = None

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

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the Authorization Rule.

primary_key = None

The Primary Key for the Authorization Rule.

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the Authorization Rule.

secondary_key = None

The Secondary Key for the Authorization Rule.

send = None

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

static get(resource_name, id, opts=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the Authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the Authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the Authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the Authorization Rule.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventSubscription(resource_name, opts=None, event_delivery_schema=None, eventhub_endpoint=None, hybrid_connection_endpoint=None, included_event_types=None, labels=None, name=None, retry_policy=None, scope=None, storage_blob_dead_letter_destination=None, storage_queue_endpoint=None, subject_filter=None, topic_name=None, webhook_endpoint=None, __props__=None, __name__=None, __opts__=None)

Manages an EventGrid Event Subscription

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • event_delivery_schema (pulumi.Input[str]) – Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventV01Schema, CustomInputSchema.

  • eventhub_endpoint (pulumi.Input[dict]) – A eventhub_endpoint block as defined below.

  • hybrid_connection_endpoint (pulumi.Input[dict]) – A hybrid_connection_endpoint block as defined below.

  • included_event_types (pulumi.Input[list]) – A list of applicable event types that need to be part of the event subscription.

  • labels (pulumi.Input[list]) – A list of labels to assign to the event subscription.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

  • retry_policy (pulumi.Input[dict]) – A retry_policy block as defined below.

  • scope (pulumi.Input[str]) – Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

  • storage_blob_dead_letter_destination (pulumi.Input[dict]) – A storage_blob_dead_letter_destination block as defined below.

  • storage_queue_endpoint (pulumi.Input[dict]) – A storage_queue_endpoint block as defined below.

  • subject_filter (pulumi.Input[dict]) – A subject_filter block as defined below.

  • topic_name (pulumi.Input[str]) – Specifies the name of the topic to associate with the event subscription.

  • webhook_endpoint (pulumi.Input[dict]) – A webhook_endpoint block as defined below.

The eventhub_endpoint object supports the following:

  • eventhub_id (pulumi.Input[str]) - Specifies the id of the eventhub where the Event Subscription will receive events.

The hybrid_connection_endpoint object supports the following:

  • hybridConnectionId (pulumi.Input[str]) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

The retry_policy object supports the following:

  • eventTimeToLive (pulumi.Input[float]) - Specifies the time to live (in minutes) for events.

  • maxDeliveryAttempts (pulumi.Input[float]) - Specifies the maximum number of delivery retry attempts for events.

The storage_blob_dead_letter_destination object supports the following:

  • storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.

  • storageBlobContainerName (pulumi.Input[str]) - Specifies the name of the Storage blob container that is the destination of the deadletter events

The storage_queue_endpoint object supports the following:

  • queue_name (pulumi.Input[str]) - Specifies the name of the storage queue where the Event Subscriptio will receive events.

  • storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.

The subject_filter object supports the following:

  • caseSensitive (pulumi.Input[bool]) - Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.

  • subjectBeginsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path prefix.

  • subjectEndsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path suffix.

The webhook_endpoint object supports the following:

  • url (pulumi.Input[str]) - Specifies the url of the webhook where the Event Subscription will receive events.

event_delivery_schema = None

Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventV01Schema, CustomInputSchema.

eventhub_endpoint = None

A eventhub_endpoint block as defined below.

  • eventhub_id (str) - Specifies the id of the eventhub where the Event Subscription will receive events.

hybrid_connection_endpoint = None

A hybrid_connection_endpoint block as defined below.

  • hybridConnectionId (str) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

included_event_types = None

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

labels = None

A list of labels to assign to the event subscription.

name = None

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

retry_policy = None

A retry_policy block as defined below.

  • eventTimeToLive (float) - Specifies the time to live (in minutes) for events.

  • maxDeliveryAttempts (float) - Specifies the maximum number of delivery retry attempts for events.

scope = None

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

storage_blob_dead_letter_destination = None

A storage_blob_dead_letter_destination block as defined below.

  • storage_account_id (str) - Specifies the id of the storage account id where the storage blob is located.

  • storageBlobContainerName (str) - Specifies the name of the Storage blob container that is the destination of the deadletter events

storage_queue_endpoint = None

A storage_queue_endpoint block as defined below.

  • queue_name (str) - Specifies the name of the storage queue where the Event Subscriptio will receive events.

  • storage_account_id (str) - Specifies the id of the storage account id where the storage blob is located.

subject_filter = None

A subject_filter block as defined below.

  • caseSensitive (bool) - Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.

  • subjectBeginsWith (str) - A string to filter events for an event subscription based on a resource path prefix.

  • subjectEndsWith (str) - A string to filter events for an event subscription based on a resource path suffix.

topic_name = None

Specifies the name of the topic to associate with the event subscription.

webhook_endpoint = None

A webhook_endpoint block as defined below.

  • url (str) - Specifies the url of the webhook where the Event Subscription will receive events.

static get(resource_name, id, opts=None, event_delivery_schema=None, eventhub_endpoint=None, hybrid_connection_endpoint=None, included_event_types=None, labels=None, name=None, retry_policy=None, scope=None, storage_blob_dead_letter_destination=None, storage_queue_endpoint=None, subject_filter=None, topic_name=None, webhook_endpoint=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • event_delivery_schema (pulumi.Input[str]) – Specifies the event delivery schema for the event subscription. Possible values include: EventGridSchema, CloudEventV01Schema, CustomInputSchema.

  • eventhub_endpoint (pulumi.Input[dict]) – A eventhub_endpoint block as defined below.

  • hybrid_connection_endpoint (pulumi.Input[dict]) – A hybrid_connection_endpoint block as defined below.

  • included_event_types (pulumi.Input[list]) – A list of applicable event types that need to be part of the event subscription.

  • labels (pulumi.Input[list]) – A list of labels to assign to the event subscription.

  • name (pulumi.Input[str]) – Specifies the name of the EventGrid Event Subscription resource. Changing this forces a new resource to be created.

  • retry_policy (pulumi.Input[dict]) – A retry_policy block as defined below.

  • scope (pulumi.Input[str]) – Specifies the scope at which the EventGrid Event Subscription should be created. Changing this forces a new resource to be created.

  • storage_blob_dead_letter_destination (pulumi.Input[dict]) – A storage_blob_dead_letter_destination block as defined below.

  • storage_queue_endpoint (pulumi.Input[dict]) – A storage_queue_endpoint block as defined below.

  • subject_filter (pulumi.Input[dict]) – A subject_filter block as defined below.

  • topic_name (pulumi.Input[str]) – Specifies the name of the topic to associate with the event subscription.

  • webhook_endpoint (pulumi.Input[dict]) – A webhook_endpoint block as defined below.

The eventhub_endpoint object supports the following:

  • eventhub_id (pulumi.Input[str]) - Specifies the id of the eventhub where the Event Subscription will receive events.

The hybrid_connection_endpoint object supports the following:

  • hybridConnectionId (pulumi.Input[str]) - Specifies the id of the hybrid connection where the Event Subscription will receive events.

The retry_policy object supports the following:

  • eventTimeToLive (pulumi.Input[float]) - Specifies the time to live (in minutes) for events.

  • maxDeliveryAttempts (pulumi.Input[float]) - Specifies the maximum number of delivery retry attempts for events.

The storage_blob_dead_letter_destination object supports the following:

  • storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.

  • storageBlobContainerName (pulumi.Input[str]) - Specifies the name of the Storage blob container that is the destination of the deadletter events

The storage_queue_endpoint object supports the following:

  • queue_name (pulumi.Input[str]) - Specifies the name of the storage queue where the Event Subscriptio will receive events.

  • storage_account_id (pulumi.Input[str]) - Specifies the id of the storage account id where the storage blob is located.

The subject_filter object supports the following:

  • caseSensitive (pulumi.Input[bool]) - Specifies if subject_begins_with and subject_ends_with case sensitive. This value defaults to false.

  • subjectBeginsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path prefix.

  • subjectEndsWith (pulumi.Input[str]) - A string to filter events for an event subscription based on a resource path suffix.

The webhook_endpoint object supports the following:

  • url (pulumi.Input[str]) - Specifies the url of the webhook where the Event Subscription will receive events.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.EventhubNamespaceDisasterRecoveryConfig(resource_name, opts=None, alternate_name=None, name=None, namespace_name=None, partner_namespace_id=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages an Disaster Recovery Config for an Event Hub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • alternate_name (pulumi.Input[str]) – An alternate name to use when the Disaster Recovery Config’s name is the same as the replicated namespace’s name.

  • name (pulumi.Input[str]) – Specifies the name of the Disaster Recovery Config. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the primary EventHub Namespace to replicate. Changing this forces a new resource to be created.

  • partner_namespace_id (pulumi.Input[str]) – The ID of the EventHub Namespace to replicate to.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Disaster Recovery Config exists. Changing this forces a new resource to be created.

alternate_name = None

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

name = None

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

namespace_name = None

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

partner_namespace_id = None

The ID of the EventHub Namespace to replicate to.

resource_group_name = None

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

static get(resource_name, id, opts=None, alternate_name=None, name=None, namespace_name=None, partner_namespace_id=None, resource_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • alternate_name (pulumi.Input[str]) – An alternate name to use when the Disaster Recovery Config’s name is the same as the replicated namespace’s name.

  • name (pulumi.Input[str]) – Specifies the name of the Disaster Recovery Config. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the primary EventHub Namespace to replicate. Changing this forces a new resource to be created.

  • partner_namespace_id (pulumi.Input[str]) – The ID of the EventHub Namespace to replicate to.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the Disaster Recovery Config exists. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.GetAuthorizationRuleResult(eventhub_name=None, id=None, listen=None, location=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

A collection of values returned by getAuthorizationRule.

id = None

id is the provider-assigned unique ID for this managed resource.

primary_connection_string = None

The Primary Connection String for the Event Hubs Authorization Rule.

primary_key = None

The Primary Key for the Event Hubs Authorization Rule.

secondary_connection_string = None

The Secondary Connection String for the Event Hubs Authorization Rule.

secondary_key = None

The Secondary Key for the Event Hubs Authorization Rule.

class pulumi_azure.eventhub.GetConsumeGroupResult(eventhub_name=None, id=None, location=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=None)

A collection of values returned by getConsumeGroup.

id = None

id is the provider-assigned unique ID for this managed resource.

user_metadata = None

Specifies the user metadata.

class pulumi_azure.eventhub.GetEventhubNamespaceResult(auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, kafka_enabled=None, location=None, maximum_throughput_units=None, name=None, resource_group_name=None, sku=None, tags=None)

A collection of values returned by getEventhubNamespace.

auto_inflate_enabled = None

Is Auto Inflate enabled for the EventHub Namespace?

capacity = None

The Capacity / Throughput Units for a Standard SKU namespace.

default_primary_connection_string = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key = None

The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

id = None

id is the provider-assigned unique ID for this managed resource.

location = None

The Azure location where the EventHub Namespace exists

maximum_throughput_units = None

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

sku = None

Defines which tier to use.

tags = None

A mapping of tags to assign to the EventHub Namespace.

class pulumi_azure.eventhub.GetNamespaceAuthorizationRuleResult(id=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

A collection of values returned by getNamespaceAuthorizationRule.

id = None

id is the provider-assigned unique ID for this managed resource.

listen = None

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

manage = None

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

namespace_name = None

The name of the EventHub Namespace.

primary_connection_string = None

The Primary Connection String for the Event Hubs authorization Rule.

primary_key = None

The Primary Key for the Event Hubs authorization Rule.

secondary_connection_string = None

The Secondary Connection String for the Event Hubs authorization Rule.

secondary_key = None

The Secondary Key for the Event Hubs authorization Rule.

send = None

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

class pulumi_azure.eventhub.GetNamespaceResult(auto_inflate_enabled=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, kafka_enabled=None, location=None, maximum_throughput_units=None, name=None, resource_group_name=None, sku=None, tags=None)

A collection of values returned by getNamespace.

auto_inflate_enabled = None

Is Auto Inflate enabled for the EventHub Namespace?

capacity = None

The Capacity / Throughput Units for a Standard SKU namespace.

default_primary_connection_string = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key = None

The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

id = None

id is the provider-assigned unique ID for this managed resource.

location = None

The Azure location where the EventHub Namespace exists

maximum_throughput_units = None

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

sku = None

Defines which tier to use.

tags = None

A mapping of tags to assign to the EventHub Namespace.

class pulumi_azure.eventhub.GetServiceBusNamespaceResult(capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, id=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, zone_redundant=None)

A collection of values returned by getServiceBusNamespace.

capacity = None

The capacity of the ServiceBus Namespace.

default_primary_connection_string = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key = None

The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

id = None

id is the provider-assigned unique ID for this managed resource.

location = None

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

sku = None

The Tier used for the ServiceBus Namespace.

tags = None

A mapping of tags assigned to the resource.

zone_redundant = None

Whether or not this ServiceBus Namespace is zone redundant.

class pulumi_azure.eventhub.Namespace(resource_name, opts=None, capacity=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, zone_redundant=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • capacity (pulumi.Input[float]) – 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.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace resource . Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace.

  • sku (pulumi.Input[str]) – Defines which tier to use. Options are basic, standard or premium.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • zone_redundant (pulumi.Input[bool]) – Whether or not this resource is zone redundant. sku needs to be Premium. Defaults to false.

capacity = None

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.

default_primary_connection_string = None

The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key = None

The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string = None

The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key = None

The secondary access key for the authorization rule RootManageSharedAccessKey.

location = None

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

name = None

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

resource_group_name = None

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

sku = None

Defines which tier to use. Options are basic, standard or premium.

tags = None

A mapping of tags to assign to the resource.

zone_redundant = None

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

static get(resource_name, id, opts=None, capacity=None, default_primary_connection_string=None, default_primary_key=None, default_secondary_connection_string=None, default_secondary_key=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, zone_redundant=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • capacity (pulumi.Input[float]) – 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.

  • default_primary_connection_string (pulumi.Input[str]) – The primary connection string for the authorization rule RootManageSharedAccessKey.

  • default_primary_key (pulumi.Input[str]) – The primary access key for the authorization rule RootManageSharedAccessKey.

  • default_secondary_connection_string (pulumi.Input[str]) – The secondary connection string for the authorization rule RootManageSharedAccessKey.

  • default_secondary_key (pulumi.Input[str]) – The secondary access key for the authorization rule RootManageSharedAccessKey.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace resource . Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace.

  • sku (pulumi.Input[str]) – Defines which tier to use. Options are basic, standard or premium.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • zone_redundant (pulumi.Input[bool]) – Whether or not this resource is zone redundant. sku needs to be Premium. Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.NamespaceAuthorizationRule(resource_name, opts=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Namespace authorization Rule within a ServiceBus.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

listen = None

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

manage = None

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

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the ServiceBus Namespace authorization Rule.

primary_key = None

The Primary Key for the ServiceBus Namespace authorization Rule.

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the ServiceBus Namespace authorization Rule.

secondary_key = None

The Secondary Key for the ServiceBus Namespace authorization Rule.

send = None

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

static get(resource_name, id, opts=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the ServiceBus Namespace authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the ServiceBus Namespace authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the ServiceBus Namespace authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the ServiceBus Namespace authorization Rule.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.Queue(resource_name, opts=None, auto_delete_on_idle=None, dead_lettering_on_message_expiration=None, default_message_ttl=None, duplicate_detection_history_time_window=None, enable_express=None, enable_partitioning=None, lock_duration=None, max_delivery_count=None, max_size_in_megabytes=None, name=None, namespace_name=None, requires_duplicate_detection=None, requires_session=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Queue.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) – The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

  • dead_lettering_on_message_expiration (pulumi.Input[bool]) – Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

  • default_message_ttl (pulumi.Input[str]) – 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.

  • duplicate_detection_history_time_window (pulumi.Input[str]) – The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

  • enable_express (pulumi.Input[bool]) – 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.

  • enable_partitioning (pulumi.Input[bool]) – 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.

  • lock_duration (pulumi.Input[str]) – 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)

  • max_delivery_count (pulumi.Input[float]) – Integer value which controls when a message is automatically deadlettered. Defaults to 10.

  • max_size_in_megabytes (pulumi.Input[float]) – Integer value which controls the size of memory allocated for the queue. For supported values see the “Queue/topic size” section of this document.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

  • requires_duplicate_detection (pulumi.Input[bool]) – Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

  • requires_session (pulumi.Input[bool]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

auto_delete_on_idle = None

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

dead_lettering_on_message_expiration = None

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

default_message_ttl = None

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.

duplicate_detection_history_time_window = None

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

enable_express = None

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.

enable_partitioning = None

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.

lock_duration = None

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)

max_delivery_count = None

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

max_size_in_megabytes = None

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

name = None

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

namespace_name = None

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

requires_duplicate_detection = None

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

requires_session = None

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.

resource_group_name = None

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

static get(resource_name, id, opts=None, auto_delete_on_idle=None, dead_lettering_on_message_expiration=None, default_message_ttl=None, duplicate_detection_history_time_window=None, enable_express=None, enable_partitioning=None, lock_duration=None, max_delivery_count=None, max_size_in_megabytes=None, name=None, namespace_name=None, requires_duplicate_detection=None, requires_session=None, resource_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) – The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes.

  • dead_lettering_on_message_expiration (pulumi.Input[bool]) – Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

  • default_message_ttl (pulumi.Input[str]) – 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.

  • duplicate_detection_history_time_window (pulumi.Input[str]) – The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

  • enable_express (pulumi.Input[bool]) – 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.

  • enable_partitioning (pulumi.Input[bool]) – 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.

  • lock_duration (pulumi.Input[str]) – 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)

  • max_delivery_count (pulumi.Input[float]) – Integer value which controls when a message is automatically deadlettered. Defaults to 10.

  • max_size_in_megabytes (pulumi.Input[float]) –

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

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

  • requires_duplicate_detection (pulumi.Input[bool]) – Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to false.

  • requires_session (pulumi.Input[bool]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.QueueAuthorizationRule(resource_name, opts=None, listen=None, manage=None, name=None, namespace_name=None, queue_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages an Authorization Rule for a ServiceBus Queue.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.

  • queue_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

listen = None

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

manage = None

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.

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the Authorization Rule.

primary_key = None

The Primary Key for the Authorization Rule.

queue_name = None

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

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the Authorization Rule.

secondary_key = None

The Secondary Key for the Authorization Rule.

send = None

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

static get(resource_name, id, opts=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, queue_name=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

  • manage (pulumi.Input[bool]) – 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.

  • name (pulumi.Input[str]) – Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the Authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the Authorization Rule.

  • queue_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the Authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the Authorization Rule.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.Subscription(resource_name, opts=None, auto_delete_on_idle=None, dead_lettering_on_message_expiration=None, default_message_ttl=None, enable_batched_operations=None, forward_dead_lettered_messages_to=None, forward_to=None, lock_duration=None, max_delivery_count=None, name=None, namespace_name=None, requires_session=None, resource_group_name=None, topic_name=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Subscription.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) – The idle interval after which the topic is automatically deleted as an ISO 8601 duration. The minimum duration is 5 minutes or P5M.

  • dead_lettering_on_message_expiration (pulumi.Input[bool]) – Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to false.

  • default_message_ttl (pulumi.Input[str]) –

    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.

  • enable_batched_operations (pulumi.Input[bool]) – Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.

  • forward_dead_lettered_messages_to (pulumi.Input[str]) – The name of a Queue or Topic to automatically forward Dead Letter messages to.

  • forward_to (pulumi.Input[str]) – The name of a Queue or Topic to automatically forward messages to.

  • lock_duration (pulumi.Input[str]) –

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

  • max_delivery_count (pulumi.Input[float]) – The maximum number of deliveries.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

  • requires_session (pulumi.Input[bool]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • topic_name (pulumi.Input[str]) – The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created.

auto_delete_on_idle = None

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

dead_lettering_on_message_expiration = None

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

default_message_ttl = None

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.

enable_batched_operations = None

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

forward_dead_lettered_messages_to = None

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

forward_to = None

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

lock_duration = None

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

max_delivery_count = None

The maximum number of deliveries.

name = None

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

namespace_name = None

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

requires_session = None

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.

resource_group_name = None

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

topic_name = None

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

static get(resource_name, id, opts=None, auto_delete_on_idle=None, dead_lettering_on_message_expiration=None, default_message_ttl=None, enable_batched_operations=None, forward_dead_lettered_messages_to=None, forward_to=None, lock_duration=None, max_delivery_count=None, name=None, namespace_name=None, requires_session=None, resource_group_name=None, topic_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) –

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

  • dead_lettering_on_message_expiration (pulumi.Input[bool]) – Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to false.

  • default_message_ttl (pulumi.Input[str]) –

    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.

  • enable_batched_operations (pulumi.Input[bool]) – Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.

  • forward_dead_lettered_messages_to (pulumi.Input[str]) – The name of a Queue or Topic to automatically forward Dead Letter messages to.

  • forward_to (pulumi.Input[str]) – The name of a Queue or Topic to automatically forward messages to.

  • lock_duration (pulumi.Input[str]) –

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

  • max_delivery_count (pulumi.Input[float]) – The maximum number of deliveries.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

  • requires_session (pulumi.Input[bool]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • topic_name (pulumi.Input[str]) – The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.SubscriptionRule(resource_name, opts=None, action=None, correlation_filter=None, filter_type=None, name=None, namespace_name=None, resource_group_name=None, sql_filter=None, subscription_name=None, topic_name=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Subscription Rule.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[str]) – Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

  • correlation_filter (pulumi.Input[dict]) – A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

  • filter_type (pulumi.Input[str]) – Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • sql_filter (pulumi.Input[str]) – Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

  • subscription_name (pulumi.Input[str]) – The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

  • topic_name (pulumi.Input[str]) – The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created.

The correlation_filter object supports the following:

  • content_type (pulumi.Input[str]) - Content type of the message.

  • correlationId (pulumi.Input[str]) - Identifier of the correlation.

  • label (pulumi.Input[str]) - Application specific label.

  • messageId (pulumi.Input[str]) - Identifier of the message.

  • replyTo (pulumi.Input[str]) - Address of the queue to reply to.

  • replyToSessionId (pulumi.Input[str]) - Session identifier to reply to.

  • sessionId (pulumi.Input[str]) - Session identifier.

  • to (pulumi.Input[str]) - Address to send to.

action = None

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

correlation_filter = None

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

  • content_type (str) - Content type of the message.

  • correlationId (str) - Identifier of the correlation.

  • label (str) - Application specific label.

  • messageId (str) - Identifier of the message.

  • replyTo (str) - Address of the queue to reply to.

  • replyToSessionId (str) - Session identifier to reply to.

  • sessionId (str) - Session identifier.

  • to (str) - Address to send to.

filter_type = None

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

name = None

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

namespace_name = None

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

resource_group_name = None

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

sql_filter = None

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

subscription_name = None

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

topic_name = None

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

static get(resource_name, id, opts=None, action=None, correlation_filter=None, filter_type=None, name=None, namespace_name=None, resource_group_name=None, sql_filter=None, subscription_name=None, topic_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • action (pulumi.Input[str]) – Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

  • correlation_filter (pulumi.Input[dict]) – A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.

  • filter_type (pulumi.Input[str]) – Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • sql_filter (pulumi.Input[str]) – Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.

  • subscription_name (pulumi.Input[str]) – The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.

  • topic_name (pulumi.Input[str]) – The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created.

The correlation_filter object supports the following:

  • content_type (pulumi.Input[str]) - Content type of the message.

  • correlationId (pulumi.Input[str]) - Identifier of the correlation.

  • label (pulumi.Input[str]) - Application specific label.

  • messageId (pulumi.Input[str]) - Identifier of the message.

  • replyTo (pulumi.Input[str]) - Address of the queue to reply to.

  • replyToSessionId (pulumi.Input[str]) - Session identifier to reply to.

  • sessionId (pulumi.Input[str]) - Session identifier.

  • to (pulumi.Input[str]) - Address to send to.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.Topic(resource_name, opts=None, auto_delete_on_idle=None, default_message_ttl=None, duplicate_detection_history_time_window=None, enable_batched_operations=None, enable_express=None, enable_partitioning=None, max_size_in_megabytes=None, name=None, namespace_name=None, requires_duplicate_detection=None, resource_group_name=None, status=None, support_ordering=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Topic.

Note Topics can only be created in Namespaces with an SKU of standard or higher.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) – The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

  • default_message_ttl (pulumi.Input[str]) – The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.

  • duplicate_detection_history_time_window (pulumi.Input[str]) – The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (PT10M)

  • enable_batched_operations (pulumi.Input[bool]) – Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

  • enable_express (pulumi.Input[bool]) – 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.

  • enable_partitioning (pulumi.Input[bool]) – 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.

  • max_size_in_megabytes (pulumi.Input[float]) –

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

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

  • requires_duplicate_detection (pulumi.Input[bool]) – Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • status (pulumi.Input[str]) – The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.

  • support_ordering (pulumi.Input[bool]) – Boolean flag which controls whether the Topic supports ordering. Defaults to false.

auto_delete_on_idle = None

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

default_message_ttl = None

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

duplicate_detection_history_time_window = None

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

enable_batched_operations = None

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

enable_express = None

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.

enable_partitioning = None

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.

max_size_in_megabytes = None

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

name = None

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

namespace_name = None

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

requires_duplicate_detection = None

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

resource_group_name = None

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

status = None

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

support_ordering = None

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

static get(resource_name, id, opts=None, auto_delete_on_idle=None, default_message_ttl=None, duplicate_detection_history_time_window=None, enable_batched_operations=None, enable_express=None, enable_partitioning=None, max_size_in_megabytes=None, name=None, namespace_name=None, requires_duplicate_detection=None, resource_group_name=None, status=None, support_ordering=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_delete_on_idle (pulumi.Input[str]) – The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

  • default_message_ttl (pulumi.Input[str]) – The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.

  • duplicate_detection_history_time_window (pulumi.Input[str]) – The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (PT10M)

  • enable_batched_operations (pulumi.Input[bool]) – Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

  • enable_express (pulumi.Input[bool]) – 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.

  • enable_partitioning (pulumi.Input[bool]) – 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.

  • max_size_in_megabytes (pulumi.Input[float]) –

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

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

  • requires_duplicate_detection (pulumi.Input[bool]) – Boolean flag which controls whether the Topic requires duplicate detection. Defaults to false. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

  • status (pulumi.Input[str]) – The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.

  • support_ordering (pulumi.Input[bool]) – Boolean flag which controls whether the Topic supports ordering. Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.eventhub.TopicAuthorizationRule(resource_name, opts=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, topic_name=None, __props__=None, __name__=None, __opts__=None)

Manages a ServiceBus Topic authorization Rule within a ServiceBus Topic.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

  • topic_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

listen = None

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

manage = None

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

name = None

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

namespace_name = None

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

primary_connection_string = None

The Primary Connection String for the ServiceBus Topic authorization Rule.

primary_key = None

The Primary Key for the ServiceBus Topic authorization Rule.

resource_group_name = None

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

secondary_connection_string = None

The Secondary Connection String for the ServiceBus Topic authorization Rule.

secondary_key = None

The Secondary Key for the ServiceBus Topic authorization Rule.

send = None

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

topic_name = None

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

static get(resource_name, id, opts=None, listen=None, manage=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None, send=None, topic_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Grants listen access to this this Authorization Rule. Defaults to false.

  • manage (pulumi.Input[bool]) – Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false.

  • name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

  • primary_connection_string (pulumi.Input[str]) – The Primary Connection String for the ServiceBus Topic authorization Rule.

  • primary_key (pulumi.Input[str]) – The Primary Key for the ServiceBus Topic authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.

  • secondary_connection_string (pulumi.Input[str]) – The Secondary Connection String for the ServiceBus Topic authorization Rule.

  • secondary_key (pulumi.Input[str]) – The Secondary Key for the ServiceBus Topic authorization Rule.

  • send (pulumi.Input[bool]) – Grants send access to this this Authorization Rule. Defaults to false.

  • topic_name (pulumi.Input[str]) – Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.eventhub.get_authorization_rule(eventhub_name=None, listen=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=None, opts=None)

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

Parameters
  • eventhub_name (str) – Specifies the name of the EventHub.

  • name (str) – Specifies the name of the EventHub Authorization Rule resource. be created.

  • namespace_name (str) – Specifies the name of the grandparent EventHub Namespace.

  • resource_group_name (str) – The name of the resource group in which the EventHub Authorization Rule’s grandparent Namespace exists.

pulumi_azure.eventhub.get_consume_group(eventhub_name=None, name=None, namespace_name=None, resource_group_name=None, opts=None)

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

Parameters
  • eventhub_name (str) – Specifies the name of the EventHub.

  • name (str) – Specifies the name of the EventHub Consumer Group resource.

  • namespace_name (str) – Specifies the name of the grandparent EventHub Namespace.

  • resource_group_name (str) – The name of the resource group in which the EventHub Consumer Group’s grandparent Namespace exists.

pulumi_azure.eventhub.get_eventhub_namespace(name=None, resource_group_name=None, opts=None)

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

Parameters
  • name (str) – The name of the EventHub Namespace.

  • resource_group_name (str) – The Name of the Resource Group where the EventHub Namespace exists.

pulumi_azure.eventhub.get_namespace(name=None, resource_group_name=None, opts=None)

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

Parameters
  • name (str) – The name of the EventHub Namespace.

  • resource_group_name (str) – The Name of the Resource Group where the EventHub Namespace exists.

pulumi_azure.eventhub.get_namespace_authorization_rule(name=None, namespace_name=None, resource_group_name=None, opts=None)

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

Parameters
  • name (str) – The name of the EventHub Authorization Rule resource.

  • resource_group_name (str) – The name of the resource group in which the EventHub Namespace exists.

pulumi_azure.eventhub.get_service_bus_namespace(name=None, resource_group_name=None, opts=None)

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

Parameters
  • name (str) – Specifies the name of the ServiceBus Namespace.

  • resource_group_name (str) – Specifies the name of the Resource Group where the ServiceBus Namespace exists.