eventhub

class pulumi_azure.eventhub.EventGridTopic(resource_name, opts=None, location=None, name=None, resource_group_name=None, tags=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.
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.

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, location=None, message_retention=None, name=None, namespace_name=None, partition_count=None, resource_group_name=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.

:param pulumi.Input[str] location :param pulumi.Input[int] message_retention: 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. :param pulumi.Input[str] name: Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created. :param pulumi.Input[str] namespace_name: Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created. :param pulumi.Input[int] partition_count: Specifies the current number of shards on the Event Hub. Changing this forces a new resource to be created. :param pulumi.Input[str] resource_group_name: The name of the resource group in which the EventHub’s parent Namespace exists. Changing this forces a new resource to be created.

capture_description = None

A capture_description block as defined below.

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.

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, location=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=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.

:param pulumi.Input[str] location :param pulumi.Input[bool] manage: 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. :param pulumi.Input[str] name: Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created. :param pulumi.Input[str] namespace_name: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created. :param pulumi.Input[str] resource_group_name: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created. :param pulumi.Input[bool] send: 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.

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, location=None, name=None, namespace_name=None, resource_group_name=None, user_metadata=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.

:param pulumi.Input[str] location :param pulumi.Input[str] name: Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created. :param pulumi.Input[str] namespace_name: Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created. :param pulumi.Input[str] resource_group_name: 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. :param pulumi.Input[str] user_metadata: 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.

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, kafka_enabled=None, location=None, maximum_throughput_units=None, name=None, resource_group_name=None, sku=None, tags=None, __name__=None, __opts__=None)

Manage 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[int]) – Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.
  • kafka_enabled (pulumi.Input[bool]) – Is Kafka enabled for the EventHub Namespace? Defaults to false.
  • 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[int]) – 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.
  • 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.
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.

kafka_enabled = None

Is Kafka enabled for the EventHub Namespace? Defaults to false.

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.

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.

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, location=None, manage=None, name=None, namespace_name=None, resource_group_name=None, send=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.

:param pulumi.Input[str] location :param pulumi.Input[bool] manage: Grants manage access to this this Authorization Rule. When this property is true - both listen and send must be too. Defaults to false. :param pulumi.Input[str] name: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created. :param pulumi.Input[str] namespace_name: Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created. :param pulumi.Input[str] resource_group_name: The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created. :param pulumi.Input[bool] send: 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.

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.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, kafka_enabled=None, location=None, maximum_throughput_units=None, sku=None, tags=None, id=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.

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.

id = None

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

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, location=None, sku=None, tags=None, id=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.

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.

id = None

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

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

Manage a ServiceBus Namespace.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • capacity (pulumi.Input[int]) – Specifies the capacity, can only be set when sku is Premium namespace. Can be 1, 2 or 4.
  • 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.
capacity = None

Specifies the capacity, can only be set when sku is Premium namespace. Can be 1, 2 or 4.

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.

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

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_batched_operations=None, enable_express=None, enable_partitioning=None, location=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, support_ordering=None, __name__=None, __opts__=None)

Manage and manage 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)

:param pulumi.Input[bool] enable_batched_operations :param pulumi.Input[bool] enable_express: 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.
Parameters:
  • 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.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • 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[int]) – Integer value which controls when a message is automatically deadlettered. Defaults to 10.
  • max_size_in_megabytes (pulumi.Input[int]) – 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.

:param pulumi.Input[bool] support_ordering

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.

location = None

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

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.

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

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_filter_evaluation_exceptions=None, dead_lettering_on_message_expiration=None, default_message_ttl=None, enable_batched_operations=None, forward_to=None, location=None, lock_duration=None, max_delivery_count=None, name=None, namespace_name=None, requires_session=None, resource_group_name=None, topic_name=None, __name__=None, __opts__=None)

Manage 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 Subscription is automatically deleted, minimum of 5 minutes. Provided in the TimeSpan format.

:param pulumi.Input[bool] dead_lettering_on_filter_evaluation_exceptions :param pulumi.Input[bool] dead_lettering_on_message_expiration: Boolean flag which controls

whether the Subscription has dead letter support when a message expires. Defaults to false.
Parameters:
  • default_message_ttl (pulumi.Input[str]) – The TTL of messages sent to this Subscription if no TTL value is set on the message itself. Provided in the TimeSpan format.
  • enable_batched_operations (pulumi.Input[bool]) – Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.
  • forward_to (pulumi.Input[str]) – The name of a Queue or Topic to automatically forward messages to.
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • lock_duration (pulumi.Input[str]) – The lock duration for the subscription, maximum supported value is 5 minutes. Defaults to 1 minute.
  • max_delivery_count (pulumi.Input[int]) – 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 Subscription is automatically deleted, minimum of 5 minutes. Provided in the TimeSpan format.

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 TTL of messages sent to this Subscription if no TTL value is set on the message itself. Provided in the TimeSpan format.

enable_batched_operations = None

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

forward_to = None

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

location = None

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

lock_duration = None

The lock duration for the subscription, maximum supported value is 5 minutes. Defaults to 1 minute.

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.

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, __name__=None, __opts__=None)

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

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.

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_filtering_messages_before_publishing=None, enable_partitioning=None, location=None, max_size_in_megabytes=None, name=None, namespace_name=None, requires_duplicate_detection=None, resource_group_name=None, status=None, support_ordering=None, __name__=None, __opts__=None)

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

:param pulumi.Input[bool] enable_filtering_messages_before_publishing :param pulumi.Input[bool] enable_partitioning: 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.
Parameters:
  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
  • max_size_in_megabytes (pulumi.Input[int]) –

    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.

location = None

Specifies the supported Azure location where the resource exists. 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.

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

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_eventhub_namespace(name=None, resource_group_name=None)

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

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

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