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

servicebus¶

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.servicebus.AwaitableGetNamespaceAuthorizationRuleResult(id=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

class pulumi_azure.servicebus.AwaitableGetNamespaceResult(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.servicebus.AwaitableGetTopicAuthorizationRuleResult(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, topic_name=None)¶

class pulumi_azure.servicebus.GetNamespaceAuthorizationRuleResult(id=None, name=None, namespace_name=None, primary_connection_string=None, primary_key=None, resource_group_name=None, secondary_connection_string=None, secondary_key=None)¶

A collection of values returned by getNamespaceAuthorizationRule.

id = None¶: The provider-assigned unique ID for this managed resource.

primary_connection_string = None¶: The primary connection string for the authorization rule.

primary_key = None¶: The primary access key for the authorization rule.

secondary_connection_string = None¶: The secondary connection string for the authorization rule.

secondary_key = None¶: The secondary access key for the authorization rule.

class pulumi_azure.servicebus.GetNamespaceResult(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 getNamespace.

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¶: 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.servicebus.GetTopicAuthorizationRuleResult(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, topic_name=None)¶

A collection of values returned by getTopicAuthorizationRule.

id = None¶: The provider-assigned unique ID for this managed resource.

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.

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.

class pulumi_azure.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })

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. Changing this forces a new resource to be created.
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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: The primary connection string for the authorization rule RootManageSharedAccessKey.

default_primary_key: pulumi.Output[str] = None¶: The primary access key for the authorization rule RootManageSharedAccessKey.

default_secondary_connection_string: pulumi.Output[str] = None¶: The secondary connection string for the authorization rule RootManageSharedAccessKey.

default_secondary_key: pulumi.Output[str] = None¶: The secondary access key for the authorization rule RootManageSharedAccessKey.

location: pulumi.Output[str] = None¶: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Namespace resource . Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = None¶: The name of the resource group in which to create the namespace.

sku: pulumi.Output[str] = None¶: Defines which tier to use. Options are basic, standard or premium. Changing this forces a new resource to be created.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

zone_redundant: pulumi.Output[bool] = 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. Changing this forces a new resource to be created.
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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_namespace_authorization_rule = azure.servicebus.NamespaceAuthorizationRule("exampleNamespaceAuthorizationRule",
    namespace_name=example_namespace.name,
    resource_group_name=example_resource_group.name,
    listen=True,
    send=True,
    manage=False)

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: pulumi.Output[bool] = None¶: Grants listen access to this this Authorization Rule. Defaults to false.

manage: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

primary_connection_string: pulumi.Output[str] = None¶: The Primary Connection String for the ServiceBus Namespace authorization Rule.

primary_key: pulumi.Output[str] = None¶: The Primary Key for the ServiceBus Namespace authorization Rule.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Secondary Connection String for the ServiceBus Namespace authorization Rule.

secondary_key: pulumi.Output[str] = None¶: The Secondary Key for the ServiceBus Namespace authorization Rule.

send: pulumi.Output[bool] = 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.servicebus.NamespaceNetworkRuleSet(resource_name, opts=None, default_action=None, ip_rules=None, namespace_name=None, network_rules=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a ServiceBus Namespace Network Rule Set Set.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Premium",
    capacity=1)
example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    address_spaces=["172.17.0.0/16"],
    dns_servers=[
        "10.0.0.4",
        "10.0.0.5",
    ])
example_subnet = azure.network.Subnet("exampleSubnet",
    resource_group_name=example_resource_group.name,
    virtual_network_name=example_virtual_network.name,
    address_prefix="172.17.0.0/24",
    service_endpoints=["Microsoft.ServiceBus"])
example_namespace_network_rule_set = azure.servicebus.NamespaceNetworkRuleSet("exampleNamespaceNetworkRuleSet",
    namespace_name=example_namespace.name,
    resource_group_name=example_resource_group.name,
    default_action="Deny",
    network_rules=[{
        "subnet_id": example_subnet.id,
        "ignore_missing_vnet_service_endpoint": False,
    }],
    ip_rules=["1.1.1.1"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
default_action (pulumi.Input[str]) – Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
ip_rules (pulumi.Input[list]) – One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace.
namespace_name (pulumi.Input[str]) – Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created.
network_rules (pulumi.Input[list]) – One or more network_rules blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group where the ServiceBus Namespace Network Rule Set should exist. Changing this forces a new resource to be created.

The network_rules object supports the following:

ignore_missing_vnet_service_endpoint (pulumi.Input[bool]) - Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to false.
subnet_id (pulumi.Input[str]) - The Subnet ID which should be able to access this ServiceBus Namespace.

default_action: pulumi.Output[str] = None¶: Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.

ip_rules: pulumi.Output[list] = None¶: One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace.

namespace_name: pulumi.Output[str] = None¶: Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created.

network_rules: pulumi.Output[list] = None¶

One or more network_rules blocks as defined below.

ignore_missing_vnet_service_endpoint (bool) - Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to false.
subnet_id (str) - The Subnet ID which should be able to access this ServiceBus Namespace.

resource_group_name: pulumi.Output[str] = None¶: Specifies the name of the Resource Group where the ServiceBus Namespace Network Rule Set should exist. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, default_action=None, ip_rules=None, namespace_name=None, network_rules=None, resource_group_name=None)¶

Get an existing NamespaceNetworkRuleSet 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.
default_action (pulumi.Input[str]) – Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are Allow and Deny. Defaults to Deny.
ip_rules (pulumi.Input[list]) – One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace.
namespace_name (pulumi.Input[str]) – Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created.
network_rules (pulumi.Input[list]) – One or more network_rules blocks as defined below.
resource_group_name (pulumi.Input[str]) – Specifies the name of the Resource Group where the ServiceBus Namespace Network Rule Set should exist. Changing this forces a new resource to be created.

The network_rules object supports the following:

ignore_missing_vnet_service_endpoint (pulumi.Input[bool]) - Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to false.
subnet_id (pulumi.Input[str]) - The Subnet ID which should be able to access this ServiceBus Namespace.

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

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_queue = azure.servicebus.Queue("exampleQueue",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)

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: pulumi.Output[str] = 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: pulumi.Output[bool] = None¶: Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to false.

default_message_ttl: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ISO 8601 timespan duration during which duplicates can be detected. Default value is 10 minutes. (PT10M)

enable_express: pulumi.Output[bool] = 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: pulumi.Output[bool] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = None¶: Integer value which controls when a message is automatically deadlettered. Defaults to 10.

max_size_in_megabytes: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = None¶: The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created.

requires_duplicate_detection: pulumi.Output[bool] = 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: pulumi.Output[bool] = 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: pulumi.Output[str] = 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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_queue = azure.servicebus.Queue("exampleQueue",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_queue_authorization_rule = azure.servicebus.QueueAuthorizationRule("exampleQueueAuthorizationRule",
    namespace_name=example_namespace.name,
    queue_name=example_queue.name,
    resource_group_name=example_resource_group.name,
    listen=True,
    send=True,
    manage=False)

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: pulumi.Output[bool] = None¶: Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to false.

manage: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Primary Connection String for the Authorization Rule.

primary_key: pulumi.Output[str] = None¶: The Primary Key for the Authorization Rule.

queue_name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Secondary Connection String for the Authorization Rule.

secondary_key: pulumi.Output[str] = None¶: The Secondary Key for the Authorization Rule.

send: pulumi.Output[bool] = 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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_subscription = azure.servicebus.Subscription("exampleSubscription",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    max_delivery_count=1)

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: pulumi.Output[str] = 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: pulumi.Output[bool] = None¶: Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to false.

default_message_ttl: pulumi.Output[str] = 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: pulumi.Output[bool] = None¶: Boolean flag which controls whether the Subscription supports batched operations. Defaults to false.

forward_dead_lettered_messages_to: pulumi.Output[str] = None¶: The name of a Queue or Topic to automatically forward Dead Letter messages to.

forward_to: pulumi.Output[str] = None¶: The name of a Queue or Topic to automatically forward messages to.

lock_duration: pulumi.Output[str] = None¶: The lock duration for the subscription as an ISO 8601 duration. The default value is 1 minute or P1M.

max_delivery_count: pulumi.Output[float] = None¶: The maximum number of deliveries.

name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = None¶: The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created.

requires_session: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

topic_name: pulumi.Output[str] = 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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_subscription = azure.servicebus.Subscription("exampleSubscription",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    max_delivery_count=1)
example_subscription_rule = azure.servicebus.SubscriptionRule("exampleSubscriptionRule",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    subscription_name=example_subscription.name,
    filter_type="SqlFilter",
    sql_filter="colour = 'red'")

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)
example_subscription = azure.servicebus.Subscription("exampleSubscription",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    max_delivery_count=1)
example_subscription_rule = azure.servicebus.SubscriptionRule("exampleSubscriptionRule",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    subscription_name=example_subscription.name,
    filter_type="CorrelationFilter",
    correlation_filter={
        "correlationId": "high",
        "label": "red",
    })

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: pulumi.Output[str] = None¶: Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.

correlation_filter: pulumi.Output[dict] = 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: pulumi.Output[str] = None¶: Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.

name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.

sql_filter: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = 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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name,
    enable_partitioning=True)

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: pulumi.Output[str] = None¶: The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.

default_message_ttl: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes. (PT10M)

enable_batched_operations: pulumi.Output[bool] = None¶: Boolean flag which controls if server-side batched operations are enabled. Defaults to false.

enable_express: pulumi.Output[bool] = 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: pulumi.Output[bool] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Topic resource. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = None¶: The name of the ServiceBus Namespace to create this topic in. Changing this forces a new resource to be created.

requires_duplicate_detection: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.

status: pulumi.Output[str] = None¶: The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.

support_ordering: pulumi.Output[bool] = 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.servicebus.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.

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_namespace = azure.servicebus.Namespace("exampleNamespace",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku="Standard",
    tags={
        "source": "example",
    })
example_topic = azure.servicebus.Topic("exampleTopic",
    resource_group_name=example_resource_group.name,
    namespace_name=example_namespace.name)
example_topic_authorization_rule = azure.servicebus.TopicAuthorizationRule("exampleTopicAuthorizationRule",
    namespace_name=example_namespace.name,
    topic_name=example_topic.name,
    resource_group_name=example_resource_group.name,
    listen=True,
    send=False,
    manage=False)

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: pulumi.Output[bool] = None¶: Grants listen access to this this Authorization Rule. Defaults to false.

manage: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.

namespace_name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.

primary_connection_string: pulumi.Output[str] = None¶: The Primary Connection String for the ServiceBus Topic authorization Rule.

primary_key: pulumi.Output[str] = None¶: The Primary Key for the ServiceBus Topic authorization Rule.

resource_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The Secondary Connection String for the ServiceBus Topic authorization Rule.

secondary_key: pulumi.Output[str] = None¶: The Secondary Key for the ServiceBus Topic authorization Rule.

send: pulumi.Output[bool] = None¶: Grants send access to this this Authorization Rule. Defaults to false.

topic_name: pulumi.Output[str] = None¶: Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.

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.servicebus.get_namespace(name=None, resource_group_name=None, opts=None)¶

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

import pulumi
import pulumi_azure as azure

example = azure.servicebus.get_namespace(name="examplenamespace",
    resource_group_name="example-resources")
pulumi.export("location", example.location)

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.

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

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

import pulumi
import pulumi_azure as azure

example = azure.servicebus.get_namespace_authorization_rule(name="examplerule",
    namespace_name="examplenamespace",
    resource_group_name="example-resources")
pulumi.export("ruleId", example.id)

Parameters

name (str) – Specifies the name of the ServiceBus Namespace Authorization Rule.
namespace_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.

pulumi_azure.servicebus.get_topic_authorization_rule(name=None, namespace_name=None, resource_group_name=None, topic_name=None, opts=None)¶

Use this data source to access information about a ServiceBus Topic Authorization Rule within a ServiceBus Topic.

import pulumi
import pulumi_azure as azure

example = azure.servicebus.get_topic_authorization_rule(name="example-tfex_name",
    namespace_name="example-namespace",
    resource_group_name="example-resources",
    topic_name="example-servicebus_topic")
pulumi.export("servicebusAuthorizationRuleId", data["azurem_servicebus_topic_authorization_rule"]["example"]["id"])

Parameters

name (str) – The name of the ServiceBus Topic Authorization Rule resource.
namespace_name (str) – The name of the ServiceBus Namespace.
resource_group_name (str) – The name of the resource group in which the ServiceBus Namespace exists.
topic_name (str) – The name of the ServiceBus Topic.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

servicebus¶

On This Page