Documentation
¶
Index ¶
- type LookupNamespaceArgs
- type LookupNamespaceAuthorizationRuleArgs
- type LookupNamespaceAuthorizationRuleResult
- type LookupNamespaceResult
- type LookupQueueAuthorizationRuleArgs
- type LookupQueueAuthorizationRuleResult
- type LookupSubscriptionArgs
- type LookupSubscriptionResult
- type LookupTopicAuthorizationRuleArgs
- type LookupTopicAuthorizationRuleResult
- type Namespace
- type NamespaceArgs
- type NamespaceAuthorizationRule
- func (NamespaceAuthorizationRule) ElementType() reflect.Type
- func (i NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutput() NamespaceAuthorizationRuleOutput
- func (i NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutputWithContext(ctx context.Context) NamespaceAuthorizationRuleOutput
- type NamespaceAuthorizationRuleArgs
- type NamespaceAuthorizationRuleInput
- type NamespaceAuthorizationRuleOutput
- func (NamespaceAuthorizationRuleOutput) ElementType() reflect.Type
- func (o NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutput() NamespaceAuthorizationRuleOutput
- func (o NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutputWithContext(ctx context.Context) NamespaceAuthorizationRuleOutput
- type NamespaceAuthorizationRuleState
- type NamespaceInput
- type NamespaceNetworkRuleSet
- type NamespaceNetworkRuleSetArgs
- type NamespaceNetworkRuleSetInput
- type NamespaceNetworkRuleSetNetworkRule
- type NamespaceNetworkRuleSetNetworkRuleArgs
- func (NamespaceNetworkRuleSetNetworkRuleArgs) ElementType() reflect.Type
- func (i NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutput() NamespaceNetworkRuleSetNetworkRuleOutput
- func (i NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleOutput
- type NamespaceNetworkRuleSetNetworkRuleArray
- func (NamespaceNetworkRuleSetNetworkRuleArray) ElementType() reflect.Type
- func (i NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput() NamespaceNetworkRuleSetNetworkRuleArrayOutput
- func (i NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleArrayOutput
- type NamespaceNetworkRuleSetNetworkRuleArrayInput
- type NamespaceNetworkRuleSetNetworkRuleArrayOutput
- func (NamespaceNetworkRuleSetNetworkRuleArrayOutput) ElementType() reflect.Type
- func (o NamespaceNetworkRuleSetNetworkRuleArrayOutput) Index(i pulumi.IntInput) NamespaceNetworkRuleSetNetworkRuleOutput
- func (o NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput() NamespaceNetworkRuleSetNetworkRuleArrayOutput
- func (o NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleArrayOutput
- type NamespaceNetworkRuleSetNetworkRuleInput
- type NamespaceNetworkRuleSetNetworkRuleOutput
- func (NamespaceNetworkRuleSetNetworkRuleOutput) ElementType() reflect.Type
- func (o NamespaceNetworkRuleSetNetworkRuleOutput) IgnoreMissingVnetServiceEndpoint() pulumi.BoolPtrOutput
- func (o NamespaceNetworkRuleSetNetworkRuleOutput) SubnetId() pulumi.StringOutput
- func (o NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutput() NamespaceNetworkRuleSetNetworkRuleOutput
- func (o NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleOutput
- type NamespaceNetworkRuleSetOutput
- type NamespaceNetworkRuleSetState
- type NamespaceOutput
- type NamespaceState
- type Queue
- type QueueArgs
- type QueueAuthorizationRule
- type QueueAuthorizationRuleArgs
- type QueueAuthorizationRuleInput
- type QueueAuthorizationRuleOutput
- type QueueAuthorizationRuleState
- type QueueInput
- type QueueOutput
- type QueueState
- type Subscription
- type SubscriptionArgs
- type SubscriptionInput
- type SubscriptionOutput
- type SubscriptionRule
- type SubscriptionRuleArgs
- type SubscriptionRuleCorrelationFilter
- type SubscriptionRuleCorrelationFilterArgs
- func (SubscriptionRuleCorrelationFilterArgs) ElementType() reflect.Type
- func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutput() SubscriptionRuleCorrelationFilterOutput
- func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterOutput
- func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
- func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
- type SubscriptionRuleCorrelationFilterInput
- type SubscriptionRuleCorrelationFilterOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ContentType() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) CorrelationId() pulumi.StringPtrOutput
- func (SubscriptionRuleCorrelationFilterOutput) ElementType() reflect.Type
- func (o SubscriptionRuleCorrelationFilterOutput) Label() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) MessageId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) Properties() pulumi.StringMapOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ReplyTo() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ReplyToSessionId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) SessionId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) To() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutput() SubscriptionRuleCorrelationFilterOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
- func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
- type SubscriptionRuleCorrelationFilterPtrInput
- type SubscriptionRuleCorrelationFilterPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) ContentType() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) CorrelationId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) Elem() SubscriptionRuleCorrelationFilterOutput
- func (SubscriptionRuleCorrelationFilterPtrOutput) ElementType() reflect.Type
- func (o SubscriptionRuleCorrelationFilterPtrOutput) Label() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) MessageId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) Properties() pulumi.StringMapOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) ReplyTo() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) ReplyToSessionId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) SessionId() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) To() pulumi.StringPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
- func (o SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
- type SubscriptionRuleInput
- type SubscriptionRuleOutput
- type SubscriptionRuleState
- type SubscriptionState
- type Topic
- type TopicArgs
- type TopicAuthorizationRule
- type TopicAuthorizationRuleArgs
- type TopicAuthorizationRuleInput
- type TopicAuthorizationRuleOutput
- type TopicAuthorizationRuleState
- type TopicInput
- type TopicOutput
- type TopicState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LookupNamespaceArgs ¶
type LookupNamespaceArgs struct { // Specifies the name of the ServiceBus Namespace. Name string `pulumi:"name"` // Specifies the name of the Resource Group where the ServiceBus Namespace exists. ResourceGroupName string `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getNamespace.
type LookupNamespaceAuthorizationRuleArgs ¶
type LookupNamespaceAuthorizationRuleArgs struct { // Specifies the name of the ServiceBus Namespace Authorization Rule. Name string `pulumi:"name"` // Specifies the name of the ServiceBus Namespace. NamespaceName string `pulumi:"namespaceName"` // Specifies the name of the Resource Group where the ServiceBus Namespace exists. ResourceGroupName string `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getNamespaceAuthorizationRule.
type LookupNamespaceAuthorizationRuleResult ¶
type LookupNamespaceAuthorizationRuleResult struct { // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Name string `pulumi:"name"` NamespaceName string `pulumi:"namespaceName"` // The primary connection string for the authorization rule. PrimaryConnectionString string `pulumi:"primaryConnectionString"` // The primary access key for the authorization rule. PrimaryKey string `pulumi:"primaryKey"` ResourceGroupName string `pulumi:"resourceGroupName"` // The secondary connection string for the authorization rule. SecondaryConnectionString string `pulumi:"secondaryConnectionString"` // The secondary access key for the authorization rule. SecondaryKey string `pulumi:"secondaryKey"` }
A collection of values returned by getNamespaceAuthorizationRule.
func LookupNamespaceAuthorizationRule ¶
func LookupNamespaceAuthorizationRule(ctx *pulumi.Context, args *LookupNamespaceAuthorizationRuleArgs, opts ...pulumi.InvokeOption) (*LookupNamespaceAuthorizationRuleResult, error)
Use this data source to access information about an existing ServiceBus Namespace Authorization Rule.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := servicebus.LookupNamespaceAuthorizationRule(ctx, &servicebus.LookupNamespaceAuthorizationRuleArgs{ Name: "examplerule", NamespaceName: "examplenamespace", ResourceGroupName: "example-resources", }, nil) if err != nil { return err } ctx.Export("ruleId", example.Id) return nil }) }
```
type LookupNamespaceResult ¶
type LookupNamespaceResult struct { // The capacity of the ServiceBus Namespace. Capacity int `pulumi:"capacity"` // The primary connection string for the authorization // rule `RootManageSharedAccessKey`. DefaultPrimaryConnectionString string `pulumi:"defaultPrimaryConnectionString"` // The primary access key for the authorization rule `RootManageSharedAccessKey`. DefaultPrimaryKey string `pulumi:"defaultPrimaryKey"` // The secondary connection string for the // authorization rule `RootManageSharedAccessKey`. DefaultSecondaryConnectionString string `pulumi:"defaultSecondaryConnectionString"` // The secondary access key for the authorization rule `RootManageSharedAccessKey`. DefaultSecondaryKey string `pulumi:"defaultSecondaryKey"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The location of the Resource Group in which the ServiceBus Namespace exists. Location string `pulumi:"location"` Name string `pulumi:"name"` ResourceGroupName string `pulumi:"resourceGroupName"` // The Tier used for the ServiceBus Namespace. Sku string `pulumi:"sku"` // A mapping of tags assigned to the resource. Tags map[string]string `pulumi:"tags"` // Whether or not this ServiceBus Namespace is zone redundant. ZoneRedundant bool `pulumi:"zoneRedundant"` }
A collection of values returned by getNamespace.
func LookupNamespace ¶
func LookupNamespace(ctx *pulumi.Context, args *LookupNamespaceArgs, opts ...pulumi.InvokeOption) (*LookupNamespaceResult, error)
Use this data source to access information about an existing ServiceBus Namespace.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := servicebus.LookupNamespace(ctx, &servicebus.LookupNamespaceArgs{ Name: "examplenamespace", ResourceGroupName: "example-resources", }, nil) if err != nil { return err } ctx.Export("location", example.Location) return nil }) }
```
type LookupQueueAuthorizationRuleArgs ¶ added in v3.22.0
type LookupQueueAuthorizationRuleArgs struct { // The name of this ServiceBus Queue Authorisation Rule. Name string `pulumi:"name"` // The name of the ServiceBus Namespace. NamespaceName string `pulumi:"namespaceName"` // The name of the ServiceBus Queue. QueueName string `pulumi:"queueName"` // The name of the Resource Group where the ServiceBus Queue Authorisation Rule exists. ResourceGroupName string `pulumi:"resourceGroupName"` }
A collection of arguments for invoking getQueueAuthorizationRule.
type LookupQueueAuthorizationRuleResult ¶ added in v3.22.0
type LookupQueueAuthorizationRuleResult struct { // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Listen bool `pulumi:"listen"` Manage bool `pulumi:"manage"` Name string `pulumi:"name"` NamespaceName string `pulumi:"namespaceName"` // The Primary Connection String for the ServiceBus Queue authorization Rule. PrimaryConnectionString string `pulumi:"primaryConnectionString"` // The Primary Key for the ServiceBus Queue authorization Rule. PrimaryKey string `pulumi:"primaryKey"` QueueName string `pulumi:"queueName"` ResourceGroupName string `pulumi:"resourceGroupName"` // The Secondary Connection String for the ServiceBus Queue authorization Rule. SecondaryConnectionString string `pulumi:"secondaryConnectionString"` // The Secondary Key for the ServiceBus Queue authorization Rule. SecondaryKey string `pulumi:"secondaryKey"` Send bool `pulumi:"send"` }
A collection of values returned by getQueueAuthorizationRule.
func LookupQueueAuthorizationRule ¶ added in v3.22.0
func LookupQueueAuthorizationRule(ctx *pulumi.Context, args *LookupQueueAuthorizationRuleArgs, opts ...pulumi.InvokeOption) (*LookupQueueAuthorizationRuleResult, error)
Use this data source to access information about an existing ServiceBus Queue Authorisation Rule within a ServiceBus Queue.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { example, err := servicebus.LookupQueueAuthorizationRule(ctx, &servicebus.LookupQueueAuthorizationRuleArgs{ Name: "example-tfex_name", ResourceGroupName: "example-resources", QueueName: "example-servicebus_queue", NamespaceName: "example-namespace", }, nil) if err != nil { return err } ctx.Export("id", example.Id) return nil }) }
```
type LookupSubscriptionArgs ¶ added in v3.32.0
type LookupSubscriptionArgs struct { // Specifies the name of the ServiceBus Subscription. Name string `pulumi:"name"` // The name of the ServiceBus Namespace. NamespaceName string `pulumi:"namespaceName"` // Specifies the name of the Resource Group where the ServiceBus Namespace exists. ResourceGroupName string `pulumi:"resourceGroupName"` // The name of the ServiceBus Topic. TopicName string `pulumi:"topicName"` }
A collection of arguments for invoking getSubscription.
type LookupSubscriptionResult ¶ added in v3.32.0
type LookupSubscriptionResult struct { // The idle interval after which the topic is automatically deleted. AutoDeleteOnIdle string `pulumi:"autoDeleteOnIdle"` // Does the ServiceBus Subscription have dead letter support on filter evaluation exceptions? DeadLetteringOnFilterEvaluationError bool `pulumi:"deadLetteringOnFilterEvaluationError"` // Does the Service Bus Subscription have dead letter support when a message expires? DeadLetteringOnMessageExpiration bool `pulumi:"deadLetteringOnMessageExpiration"` // The Default message timespan to live. 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. DefaultMessageTtl string `pulumi:"defaultMessageTtl"` // Are batched operations enabled on this ServiceBus Subscription? EnableBatchedOperations bool `pulumi:"enableBatchedOperations"` // The name of a Queue or Topic to automatically forward Dead Letter messages to. ForwardDeadLetteredMessagesTo string `pulumi:"forwardDeadLetteredMessagesTo"` // The name of a ServiceBus Queue or ServiceBus Topic where messages are automatically forwarded. ForwardTo string `pulumi:"forwardTo"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The lock duration for the subscription. LockDuration string `pulumi:"lockDuration"` // The maximum number of deliveries. MaxDeliveryCount int `pulumi:"maxDeliveryCount"` Name string `pulumi:"name"` NamespaceName string `pulumi:"namespaceName"` // Whether or not this ServiceBus Subscription supports session. RequiresSession bool `pulumi:"requiresSession"` ResourceGroupName string `pulumi:"resourceGroupName"` TopicName string `pulumi:"topicName"` }
A collection of values returned by getSubscription.
func LookupSubscription ¶ added in v3.32.0
func LookupSubscription(ctx *pulumi.Context, args *LookupSubscriptionArgs, opts ...pulumi.InvokeOption) (*LookupSubscriptionResult, error)
Use this data source to access information about an existing ServiceBus Subscription.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := servicebus.LookupSubscription(ctx, &servicebus.LookupSubscriptionArgs{ Name: "examplesubscription", ResourceGroupName: "exampleresources", NamespaceName: "examplenamespace", TopicName: "exampletopic", }, nil) if err != nil { return err } ctx.Export("servicebusSubscription", data.Azurerm_servicebus_namespace.Example) return nil }) }
```
type LookupTopicAuthorizationRuleArgs ¶
type LookupTopicAuthorizationRuleArgs struct { // The name of the ServiceBus Topic Authorization Rule resource. Name string `pulumi:"name"` // The name of the ServiceBus Namespace. NamespaceName string `pulumi:"namespaceName"` // The name of the resource group in which the ServiceBus Namespace exists. ResourceGroupName string `pulumi:"resourceGroupName"` // The name of the ServiceBus Topic. TopicName string `pulumi:"topicName"` }
A collection of arguments for invoking getTopicAuthorizationRule.
type LookupTopicAuthorizationRuleResult ¶
type LookupTopicAuthorizationRuleResult struct { // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Listen bool `pulumi:"listen"` Manage bool `pulumi:"manage"` Name string `pulumi:"name"` NamespaceName string `pulumi:"namespaceName"` // The Primary Connection String for the ServiceBus Topic authorization Rule. PrimaryConnectionString string `pulumi:"primaryConnectionString"` // The Primary Key for the ServiceBus Topic authorization Rule. PrimaryKey string `pulumi:"primaryKey"` ResourceGroupName string `pulumi:"resourceGroupName"` // The Secondary Connection String for the ServiceBus Topic authorization Rule. SecondaryConnectionString string `pulumi:"secondaryConnectionString"` // The Secondary Key for the ServiceBus Topic authorization Rule. SecondaryKey string `pulumi:"secondaryKey"` Send bool `pulumi:"send"` TopicName string `pulumi:"topicName"` }
A collection of values returned by getTopicAuthorizationRule.
func LookupTopicAuthorizationRule ¶
func LookupTopicAuthorizationRule(ctx *pulumi.Context, args *LookupTopicAuthorizationRuleArgs, opts ...pulumi.InvokeOption) (*LookupTopicAuthorizationRuleResult, error)
Use this data source to access information about a ServiceBus Topic Authorization Rule within a ServiceBus Topic.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := servicebus.LookupTopicAuthorizationRule(ctx, &servicebus.LookupTopicAuthorizationRuleArgs{ Name: "example-tfex_name", NamespaceName: "example-namespace", ResourceGroupName: "example-resources", TopicName: "example-servicebus_topic", }, nil) if err != nil { return err } ctx.Export("servicebusAuthorizationRuleId", data.Azurem_servicebus_topic_authorization_rule.Example.Id) return nil }) }
```
type Namespace ¶
type Namespace struct { pulumi.CustomResourceState // 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. Capacity pulumi.IntPtrOutput `pulumi:"capacity"` // The primary connection string for the authorization // rule `RootManageSharedAccessKey`. DefaultPrimaryConnectionString pulumi.StringOutput `pulumi:"defaultPrimaryConnectionString"` // The primary access key for the authorization rule `RootManageSharedAccessKey`. DefaultPrimaryKey pulumi.StringOutput `pulumi:"defaultPrimaryKey"` // The secondary connection string for the // authorization rule `RootManageSharedAccessKey`. DefaultSecondaryConnectionString pulumi.StringOutput `pulumi:"defaultSecondaryConnectionString"` // The secondary access key for the authorization rule `RootManageSharedAccessKey`. DefaultSecondaryKey pulumi.StringOutput `pulumi:"defaultSecondaryKey"` // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location pulumi.StringOutput `pulumi:"location"` // Specifies the name of the ServiceBus Namespace resource . Changing this forces a // new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the resource group in which to // create the namespace. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // Defines which tier to use. Options are basic, standard or premium. Changing this forces a new resource to be created. Sku pulumi.StringOutput `pulumi:"sku"` // A mapping of tags to assign to the resource. Tags pulumi.StringMapOutput `pulumi:"tags"` // Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Defaults to `false`. ZoneRedundant pulumi.BoolPtrOutput `pulumi:"zoneRedundant"` }
Manages a ServiceBus Namespace.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } _, err = servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Namespace can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/namespace:Namespace example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1
```
func GetNamespace ¶
func GetNamespace(ctx *pulumi.Context, name string, id pulumi.IDInput, state *NamespaceState, opts ...pulumi.ResourceOption) (*Namespace, error)
GetNamespace gets an existing Namespace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewNamespace ¶
func NewNamespace(ctx *pulumi.Context, name string, args *NamespaceArgs, opts ...pulumi.ResourceOption) (*Namespace, error)
NewNamespace registers a new resource with the given unique name, arguments, and options.
func (Namespace) ElementType ¶ added in v3.31.1
func (Namespace) ToNamespaceOutput ¶ added in v3.31.1
func (i Namespace) ToNamespaceOutput() NamespaceOutput
func (Namespace) ToNamespaceOutputWithContext ¶ added in v3.31.1
func (i Namespace) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput
type NamespaceArgs ¶
type NamespaceArgs struct { // 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. Capacity pulumi.IntPtrInput // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace resource . Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // The name of the resource group in which to // create the namespace. ResourceGroupName pulumi.StringInput // Defines which tier to use. Options are basic, standard or premium. Changing this forces a new resource to be created. Sku pulumi.StringInput // A mapping of tags to assign to the resource. Tags pulumi.StringMapInput // Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Defaults to `false`. ZoneRedundant pulumi.BoolPtrInput }
The set of arguments for constructing a Namespace resource.
func (NamespaceArgs) ElementType ¶
func (NamespaceArgs) ElementType() reflect.Type
type NamespaceAuthorizationRule ¶
type NamespaceAuthorizationRule struct { pulumi.CustomResourceState // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrOutput `pulumi:"listen"` // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrOutput `pulumi:"manage"` // Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // The Primary Connection String for the ServiceBus Namespace authorization Rule. PrimaryConnectionString pulumi.StringOutput `pulumi:"primaryConnectionString"` // The Primary Key for the ServiceBus Namespace authorization Rule. PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"` // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The Secondary Connection String for the ServiceBus Namespace authorization Rule. SecondaryConnectionString pulumi.StringOutput `pulumi:"secondaryConnectionString"` // The Secondary Key for the ServiceBus Namespace authorization Rule. SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"` // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrOutput `pulumi:"send"` }
Manages a ServiceBus Namespace authorization Rule within a ServiceBus.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West US"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } _, err = servicebus.NewNamespaceAuthorizationRule(ctx, "exampleNamespaceAuthorizationRule", &servicebus.NamespaceAuthorizationRuleArgs{ NamespaceName: exampleNamespace.Name, ResourceGroupName: exampleResourceGroup.Name, Listen: pulumi.Bool(true), Send: pulumi.Bool(true), Manage: pulumi.Bool(false), }) if err != nil { return err } return nil }) }
```
## Import
ServiceBus Namespace authorization rules can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/namespaceAuthorizationRule:NamespaceAuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ServiceBus/namespaces/namespace1/AuthorizationRules/rule1
```
func GetNamespaceAuthorizationRule ¶
func GetNamespaceAuthorizationRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *NamespaceAuthorizationRuleState, opts ...pulumi.ResourceOption) (*NamespaceAuthorizationRule, error)
GetNamespaceAuthorizationRule gets an existing NamespaceAuthorizationRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewNamespaceAuthorizationRule ¶
func NewNamespaceAuthorizationRule(ctx *pulumi.Context, name string, args *NamespaceAuthorizationRuleArgs, opts ...pulumi.ResourceOption) (*NamespaceAuthorizationRule, error)
NewNamespaceAuthorizationRule registers a new resource with the given unique name, arguments, and options.
func (NamespaceAuthorizationRule) ElementType ¶ added in v3.31.1
func (NamespaceAuthorizationRule) ElementType() reflect.Type
func (NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutput ¶ added in v3.31.1
func (i NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutput() NamespaceAuthorizationRuleOutput
func (NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (i NamespaceAuthorizationRule) ToNamespaceAuthorizationRuleOutputWithContext(ctx context.Context) NamespaceAuthorizationRuleOutput
type NamespaceAuthorizationRuleArgs ¶
type NamespaceAuthorizationRuleArgs struct { // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrInput // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrInput // Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrInput }
The set of arguments for constructing a NamespaceAuthorizationRule resource.
func (NamespaceAuthorizationRuleArgs) ElementType ¶
func (NamespaceAuthorizationRuleArgs) ElementType() reflect.Type
type NamespaceAuthorizationRuleInput ¶ added in v3.31.1
type NamespaceAuthorizationRuleInput interface { pulumi.Input ToNamespaceAuthorizationRuleOutput() NamespaceAuthorizationRuleOutput ToNamespaceAuthorizationRuleOutputWithContext(ctx context.Context) NamespaceAuthorizationRuleOutput }
type NamespaceAuthorizationRuleOutput ¶ added in v3.31.1
type NamespaceAuthorizationRuleOutput struct {
*pulumi.OutputState
}
func (NamespaceAuthorizationRuleOutput) ElementType ¶ added in v3.31.1
func (NamespaceAuthorizationRuleOutput) ElementType() reflect.Type
func (NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutput ¶ added in v3.31.1
func (o NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutput() NamespaceAuthorizationRuleOutput
func (NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (o NamespaceAuthorizationRuleOutput) ToNamespaceAuthorizationRuleOutputWithContext(ctx context.Context) NamespaceAuthorizationRuleOutput
type NamespaceAuthorizationRuleState ¶
type NamespaceAuthorizationRuleState struct { // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrInput // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrInput // Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // The Primary Connection String for the ServiceBus Namespace authorization Rule. PrimaryConnectionString pulumi.StringPtrInput // The Primary Key for the ServiceBus Namespace authorization Rule. PrimaryKey pulumi.StringPtrInput // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The Secondary Connection String for the ServiceBus Namespace authorization Rule. SecondaryConnectionString pulumi.StringPtrInput // The Secondary Key for the ServiceBus Namespace authorization Rule. SecondaryKey pulumi.StringPtrInput // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrInput }
func (NamespaceAuthorizationRuleState) ElementType ¶
func (NamespaceAuthorizationRuleState) ElementType() reflect.Type
type NamespaceInput ¶ added in v3.31.1
type NamespaceInput interface { pulumi.Input ToNamespaceOutput() NamespaceOutput ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput }
type NamespaceNetworkRuleSet ¶ added in v3.2.0
type NamespaceNetworkRuleSet struct { pulumi.CustomResourceState // Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`. DefaultAction pulumi.StringPtrOutput `pulumi:"defaultAction"` // One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace. IpRules pulumi.StringArrayOutput `pulumi:"ipRules"` // Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // One or more `networkRules` blocks as defined below. NetworkRules NamespaceNetworkRuleSetNetworkRuleArrayOutput `pulumi:"networkRules"` // 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. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` }
Manages a ServiceBus Namespace Network Rule Set Set.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/network" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Premium"), Capacity: pulumi.Int(1), }) if err != nil { return err } exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, AddressSpaces: pulumi.StringArray{ pulumi.String("172.17.0.0/16"), }, DnsServers: pulumi.StringArray{ pulumi.String("10.0.0.4"), pulumi.String("10.0.0.5"), }, }) if err != nil { return err } exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{ ResourceGroupName: exampleResourceGroup.Name, VirtualNetworkName: exampleVirtualNetwork.Name, AddressPrefixes: pulumi.StringArray{ pulumi.String("172.17.0.0/24"), }, ServiceEndpoints: pulumi.StringArray{ pulumi.String("Microsoft.ServiceBus"), }, }) if err != nil { return err } _, err = servicebus.NewNamespaceNetworkRuleSet(ctx, "exampleNamespaceNetworkRuleSet", &servicebus.NamespaceNetworkRuleSetArgs{ NamespaceName: exampleNamespace.Name, ResourceGroupName: exampleResourceGroup.Name, DefaultAction: pulumi.String("Deny"), NetworkRules: servicebus.NamespaceNetworkRuleSetNetworkRuleArray{ &servicebus.NamespaceNetworkRuleSetNetworkRuleArgs{ SubnetId: exampleSubnet.ID(), IgnoreMissingVnetServiceEndpoint: pulumi.Bool(false), }, }, IpRules: pulumi.StringArray{ pulumi.String("1.1.1.1"), }, }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Namespace can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/namespaceNetworkRuleSet:NamespaceNetworkRuleSet example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Servicebus/namespaces/sbns1/networkrulesets/default
```
func GetNamespaceNetworkRuleSet ¶ added in v3.2.0
func GetNamespaceNetworkRuleSet(ctx *pulumi.Context, name string, id pulumi.IDInput, state *NamespaceNetworkRuleSetState, opts ...pulumi.ResourceOption) (*NamespaceNetworkRuleSet, error)
GetNamespaceNetworkRuleSet gets an existing NamespaceNetworkRuleSet resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewNamespaceNetworkRuleSet ¶ added in v3.2.0
func NewNamespaceNetworkRuleSet(ctx *pulumi.Context, name string, args *NamespaceNetworkRuleSetArgs, opts ...pulumi.ResourceOption) (*NamespaceNetworkRuleSet, error)
NewNamespaceNetworkRuleSet registers a new resource with the given unique name, arguments, and options.
func (NamespaceNetworkRuleSet) ElementType ¶ added in v3.31.1
func (NamespaceNetworkRuleSet) ElementType() reflect.Type
func (NamespaceNetworkRuleSet) ToNamespaceNetworkRuleSetOutput ¶ added in v3.31.1
func (i NamespaceNetworkRuleSet) ToNamespaceNetworkRuleSetOutput() NamespaceNetworkRuleSetOutput
func (NamespaceNetworkRuleSet) ToNamespaceNetworkRuleSetOutputWithContext ¶ added in v3.31.1
func (i NamespaceNetworkRuleSet) ToNamespaceNetworkRuleSetOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetOutput
type NamespaceNetworkRuleSetArgs ¶ added in v3.2.0
type NamespaceNetworkRuleSetArgs struct { // Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`. DefaultAction pulumi.StringPtrInput // One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace. IpRules pulumi.StringArrayInput // Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // One or more `networkRules` blocks as defined below. NetworkRules NamespaceNetworkRuleSetNetworkRuleArrayInput // 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. ResourceGroupName pulumi.StringInput }
The set of arguments for constructing a NamespaceNetworkRuleSet resource.
func (NamespaceNetworkRuleSetArgs) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetArgs) ElementType() reflect.Type
type NamespaceNetworkRuleSetInput ¶ added in v3.31.1
type NamespaceNetworkRuleSetInput interface { pulumi.Input ToNamespaceNetworkRuleSetOutput() NamespaceNetworkRuleSetOutput ToNamespaceNetworkRuleSetOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetOutput }
type NamespaceNetworkRuleSetNetworkRule ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRule struct { // Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to `false`. IgnoreMissingVnetServiceEndpoint *bool `pulumi:"ignoreMissingVnetServiceEndpoint"` // The Subnet ID which should be able to access this ServiceBus Namespace. SubnetId string `pulumi:"subnetId"` }
type NamespaceNetworkRuleSetNetworkRuleArgs ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleArgs struct { // Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to `false`. IgnoreMissingVnetServiceEndpoint pulumi.BoolPtrInput `pulumi:"ignoreMissingVnetServiceEndpoint"` // The Subnet ID which should be able to access this ServiceBus Namespace. SubnetId pulumi.StringInput `pulumi:"subnetId"` }
func (NamespaceNetworkRuleSetNetworkRuleArgs) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetNetworkRuleArgs) ElementType() reflect.Type
func (NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutput ¶ added in v3.2.0
func (i NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutput() NamespaceNetworkRuleSetNetworkRuleOutput
func (NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext ¶ added in v3.2.0
func (i NamespaceNetworkRuleSetNetworkRuleArgs) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleOutput
type NamespaceNetworkRuleSetNetworkRuleArray ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleArray []NamespaceNetworkRuleSetNetworkRuleInput
func (NamespaceNetworkRuleSetNetworkRuleArray) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetNetworkRuleArray) ElementType() reflect.Type
func (NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput ¶ added in v3.2.0
func (i NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput() NamespaceNetworkRuleSetNetworkRuleArrayOutput
func (NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext ¶ added in v3.2.0
func (i NamespaceNetworkRuleSetNetworkRuleArray) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleArrayOutput
type NamespaceNetworkRuleSetNetworkRuleArrayInput ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleArrayInput interface { pulumi.Input ToNamespaceNetworkRuleSetNetworkRuleArrayOutput() NamespaceNetworkRuleSetNetworkRuleArrayOutput ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext(context.Context) NamespaceNetworkRuleSetNetworkRuleArrayOutput }
NamespaceNetworkRuleSetNetworkRuleArrayInput is an input type that accepts NamespaceNetworkRuleSetNetworkRuleArray and NamespaceNetworkRuleSetNetworkRuleArrayOutput values. You can construct a concrete instance of `NamespaceNetworkRuleSetNetworkRuleArrayInput` via:
NamespaceNetworkRuleSetNetworkRuleArray{ NamespaceNetworkRuleSetNetworkRuleArgs{...} }
type NamespaceNetworkRuleSetNetworkRuleArrayOutput ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleArrayOutput struct{ *pulumi.OutputState }
func (NamespaceNetworkRuleSetNetworkRuleArrayOutput) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetNetworkRuleArrayOutput) ElementType() reflect.Type
func (NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutput() NamespaceNetworkRuleSetNetworkRuleArrayOutput
func (NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleArrayOutput) ToNamespaceNetworkRuleSetNetworkRuleArrayOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleArrayOutput
type NamespaceNetworkRuleSetNetworkRuleInput ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleInput interface { pulumi.Input ToNamespaceNetworkRuleSetNetworkRuleOutput() NamespaceNetworkRuleSetNetworkRuleOutput ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext(context.Context) NamespaceNetworkRuleSetNetworkRuleOutput }
NamespaceNetworkRuleSetNetworkRuleInput is an input type that accepts NamespaceNetworkRuleSetNetworkRuleArgs and NamespaceNetworkRuleSetNetworkRuleOutput values. You can construct a concrete instance of `NamespaceNetworkRuleSetNetworkRuleInput` via:
NamespaceNetworkRuleSetNetworkRuleArgs{...}
type NamespaceNetworkRuleSetNetworkRuleOutput ¶ added in v3.2.0
type NamespaceNetworkRuleSetNetworkRuleOutput struct{ *pulumi.OutputState }
func (NamespaceNetworkRuleSetNetworkRuleOutput) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetNetworkRuleOutput) ElementType() reflect.Type
func (NamespaceNetworkRuleSetNetworkRuleOutput) IgnoreMissingVnetServiceEndpoint ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleOutput) IgnoreMissingVnetServiceEndpoint() pulumi.BoolPtrOutput
Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to `false`.
func (NamespaceNetworkRuleSetNetworkRuleOutput) SubnetId ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleOutput) SubnetId() pulumi.StringOutput
The Subnet ID which should be able to access this ServiceBus Namespace.
func (NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutput ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutput() NamespaceNetworkRuleSetNetworkRuleOutput
func (NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext ¶ added in v3.2.0
func (o NamespaceNetworkRuleSetNetworkRuleOutput) ToNamespaceNetworkRuleSetNetworkRuleOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetNetworkRuleOutput
type NamespaceNetworkRuleSetOutput ¶ added in v3.31.1
type NamespaceNetworkRuleSetOutput struct {
*pulumi.OutputState
}
func (NamespaceNetworkRuleSetOutput) ElementType ¶ added in v3.31.1
func (NamespaceNetworkRuleSetOutput) ElementType() reflect.Type
func (NamespaceNetworkRuleSetOutput) ToNamespaceNetworkRuleSetOutput ¶ added in v3.31.1
func (o NamespaceNetworkRuleSetOutput) ToNamespaceNetworkRuleSetOutput() NamespaceNetworkRuleSetOutput
func (NamespaceNetworkRuleSetOutput) ToNamespaceNetworkRuleSetOutputWithContext ¶ added in v3.31.1
func (o NamespaceNetworkRuleSetOutput) ToNamespaceNetworkRuleSetOutputWithContext(ctx context.Context) NamespaceNetworkRuleSetOutput
type NamespaceNetworkRuleSetState ¶ added in v3.2.0
type NamespaceNetworkRuleSetState struct { // Specifies the default action for the ServiceBus Namespace Network Rule Set. Possible values are `Allow` and `Deny`. Defaults to `Deny`. DefaultAction pulumi.StringPtrInput // One or more IP Addresses, or CIDR Blocks which should be able to access the ServiceBus Namespace. IpRules pulumi.StringArrayInput // Specifies the ServiceBus Namespace name to which to attach the ServiceBus Namespace Network Rule Set. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // One or more `networkRules` blocks as defined below. NetworkRules NamespaceNetworkRuleSetNetworkRuleArrayInput // 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. ResourceGroupName pulumi.StringPtrInput }
func (NamespaceNetworkRuleSetState) ElementType ¶ added in v3.2.0
func (NamespaceNetworkRuleSetState) ElementType() reflect.Type
type NamespaceOutput ¶ added in v3.31.1
type NamespaceOutput struct {
*pulumi.OutputState
}
func (NamespaceOutput) ElementType ¶ added in v3.31.1
func (NamespaceOutput) ElementType() reflect.Type
func (NamespaceOutput) ToNamespaceOutput ¶ added in v3.31.1
func (o NamespaceOutput) ToNamespaceOutput() NamespaceOutput
func (NamespaceOutput) ToNamespaceOutputWithContext ¶ added in v3.31.1
func (o NamespaceOutput) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput
type NamespaceState ¶
type NamespaceState struct { // 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. Capacity pulumi.IntPtrInput // The primary connection string for the authorization // rule `RootManageSharedAccessKey`. DefaultPrimaryConnectionString pulumi.StringPtrInput // The primary access key for the authorization rule `RootManageSharedAccessKey`. DefaultPrimaryKey pulumi.StringPtrInput // The secondary connection string for the // authorization rule `RootManageSharedAccessKey`. DefaultSecondaryConnectionString pulumi.StringPtrInput // The secondary access key for the authorization rule `RootManageSharedAccessKey`. DefaultSecondaryKey pulumi.StringPtrInput // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace resource . Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // The name of the resource group in which to // create the namespace. ResourceGroupName pulumi.StringPtrInput // Defines which tier to use. Options are basic, standard or premium. Changing this forces a new resource to be created. Sku pulumi.StringPtrInput // A mapping of tags to assign to the resource. Tags pulumi.StringMapInput // Whether or not this resource is zone redundant. `sku` needs to be `Premium`. Defaults to `false`. ZoneRedundant pulumi.BoolPtrInput }
func (NamespaceState) ElementType ¶
func (NamespaceState) ElementType() reflect.Type
type Queue ¶
type Queue struct { pulumi.CustomResourceState // The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringOutput `pulumi:"autoDeleteOnIdle"` // Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrOutput `pulumi:"deadLetteringOnMessageExpiration"` // 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. DefaultMessageTtl pulumi.StringOutput `pulumi:"defaultMessageTtl"` // The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (`PT10M`). DuplicateDetectionHistoryTimeWindow pulumi.StringOutput `pulumi:"duplicateDetectionHistoryTimeWindow"` // Boolean flag which controls whether server-side batched operations are enabled. Defaults to `true`. EnableBatchedOperations pulumi.BoolPtrOutput `pulumi:"enableBatchedOperations"` // 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`. EnableExpress pulumi.BoolPtrOutput `pulumi:"enableExpress"` // 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`. EnablePartitioning pulumi.BoolPtrOutput `pulumi:"enablePartitioning"` // The name of a Queue or Topic to automatically forward dead lettered messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrOutput `pulumi:"forwardDeadLetteredMessagesTo"` // The name of a Queue or Topic to automatically forward messages to. Please [see the documentation](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-auto-forwarding) for more information. ForwardTo pulumi.StringPtrOutput `pulumi:"forwardTo"` // 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`). LockDuration pulumi.StringOutput `pulumi:"lockDuration"` // Integer value which controls when a message is automatically dead lettered. Defaults to `10`. MaxDeliveryCount pulumi.IntPtrOutput `pulumi:"maxDeliveryCount"` // Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue or topic size" section of [Service Bus Quotas](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). Defaults to `1024`. MaxSizeInMegabytes pulumi.IntOutput `pulumi:"maxSizeInMegabytes"` // Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to `false`. RequiresDuplicateDetection pulumi.BoolPtrOutput `pulumi:"requiresDuplicateDetection"` // 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`. RequiresSession pulumi.BoolPtrOutput `pulumi:"requiresSession"` // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The status of the Queue. Possible values are `Active`, `Creating`, `Deleting`, `Disabled`, `ReceiveDisabled`, `Renaming`, `SendDisabled`, `Unknown`. Note that `Restoring` is not accepted. Defaults to `Active`. Status pulumi.StringPtrOutput `pulumi:"status"` }
Manages a ServiceBus Queue.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } _, err = servicebus.NewQueue(ctx, "exampleQueue", &servicebus.QueueArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Queue can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/queue:Queue example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/queues/snqueue1
```
func GetQueue ¶
func GetQueue(ctx *pulumi.Context, name string, id pulumi.IDInput, state *QueueState, opts ...pulumi.ResourceOption) (*Queue, error)
GetQueue gets an existing Queue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewQueue ¶
func NewQueue(ctx *pulumi.Context, name string, args *QueueArgs, opts ...pulumi.ResourceOption) (*Queue, error)
NewQueue registers a new resource with the given unique name, arguments, and options.
func (Queue) ElementType ¶ added in v3.31.1
func (Queue) ToQueueOutput ¶ added in v3.31.1
func (i Queue) ToQueueOutput() QueueOutput
func (Queue) ToQueueOutputWithContext ¶ added in v3.31.1
func (i Queue) ToQueueOutputWithContext(ctx context.Context) QueueOutput
type QueueArgs ¶
type QueueArgs struct { // The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringPtrInput // Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrInput // 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. DefaultMessageTtl pulumi.StringPtrInput // The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (`PT10M`). DuplicateDetectionHistoryTimeWindow pulumi.StringPtrInput // Boolean flag which controls whether server-side batched operations are enabled. Defaults to `true`. EnableBatchedOperations pulumi.BoolPtrInput // 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`. EnableExpress pulumi.BoolPtrInput // 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`. EnablePartitioning pulumi.BoolPtrInput // The name of a Queue or Topic to automatically forward dead lettered messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrInput // The name of a Queue or Topic to automatically forward messages to. Please [see the documentation](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-auto-forwarding) for more information. ForwardTo pulumi.StringPtrInput // 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`). LockDuration pulumi.StringPtrInput // Integer value which controls when a message is automatically dead lettered. Defaults to `10`. MaxDeliveryCount pulumi.IntPtrInput // Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue or topic size" section of [Service Bus Quotas](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). Defaults to `1024`. MaxSizeInMegabytes pulumi.IntPtrInput // Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to `false`. RequiresDuplicateDetection pulumi.BoolPtrInput // 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`. RequiresSession pulumi.BoolPtrInput // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // The status of the Queue. Possible values are `Active`, `Creating`, `Deleting`, `Disabled`, `ReceiveDisabled`, `Renaming`, `SendDisabled`, `Unknown`. Note that `Restoring` is not accepted. Defaults to `Active`. Status pulumi.StringPtrInput }
The set of arguments for constructing a Queue resource.
func (QueueArgs) ElementType ¶
type QueueAuthorizationRule ¶
type QueueAuthorizationRule struct { pulumi.CustomResourceState // Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to `false`. Listen pulumi.BoolPtrOutput `pulumi:"listen"` // 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`. Manage pulumi.BoolPtrOutput `pulumi:"manage"` // Specifies the name of the Authorization Rule. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // The Primary Connection String for the Authorization Rule. PrimaryConnectionString pulumi.StringOutput `pulumi:"primaryConnectionString"` // The Primary Key for the Authorization Rule. PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"` // Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created. QueueName pulumi.StringOutput `pulumi:"queueName"` // The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The Secondary Connection String for the Authorization Rule. SecondaryConnectionString pulumi.StringOutput `pulumi:"secondaryConnectionString"` // The Secondary Key for the Authorization Rule. SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"` // Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to `false`. Send pulumi.BoolPtrOutput `pulumi:"send"` }
Manages an Authorization Rule for a ServiceBus Queue.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West US"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } exampleQueue, err := servicebus.NewQueue(ctx, "exampleQueue", &servicebus.QueueArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } _, err = servicebus.NewQueueAuthorizationRule(ctx, "exampleQueueAuthorizationRule", &servicebus.QueueAuthorizationRuleArgs{ NamespaceName: exampleNamespace.Name, QueueName: exampleQueue.Name, ResourceGroupName: exampleResourceGroup.Name, Listen: pulumi.Bool(true), Send: pulumi.Bool(true), Manage: pulumi.Bool(false), }) if err != nil { return err } return nil }) }
```
## Import
ServiceBus Queue Authorization Rules can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/queueAuthorizationRule:QueueAuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ServiceBus/namespaces/namespace1/queues/queue1/authorizationRules/rule1
```
func GetQueueAuthorizationRule ¶
func GetQueueAuthorizationRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *QueueAuthorizationRuleState, opts ...pulumi.ResourceOption) (*QueueAuthorizationRule, error)
GetQueueAuthorizationRule gets an existing QueueAuthorizationRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewQueueAuthorizationRule ¶
func NewQueueAuthorizationRule(ctx *pulumi.Context, name string, args *QueueAuthorizationRuleArgs, opts ...pulumi.ResourceOption) (*QueueAuthorizationRule, error)
NewQueueAuthorizationRule registers a new resource with the given unique name, arguments, and options.
func (QueueAuthorizationRule) ElementType ¶ added in v3.31.1
func (QueueAuthorizationRule) ElementType() reflect.Type
func (QueueAuthorizationRule) ToQueueAuthorizationRuleOutput ¶ added in v3.31.1
func (i QueueAuthorizationRule) ToQueueAuthorizationRuleOutput() QueueAuthorizationRuleOutput
func (QueueAuthorizationRule) ToQueueAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (i QueueAuthorizationRule) ToQueueAuthorizationRuleOutputWithContext(ctx context.Context) QueueAuthorizationRuleOutput
type QueueAuthorizationRuleArgs ¶
type QueueAuthorizationRuleArgs struct { // Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to `false`. Listen pulumi.BoolPtrInput // 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`. Manage pulumi.BoolPtrInput // Specifies the name of the Authorization Rule. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created. QueueName pulumi.StringInput // The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to `false`. Send pulumi.BoolPtrInput }
The set of arguments for constructing a QueueAuthorizationRule resource.
func (QueueAuthorizationRuleArgs) ElementType ¶
func (QueueAuthorizationRuleArgs) ElementType() reflect.Type
type QueueAuthorizationRuleInput ¶ added in v3.31.1
type QueueAuthorizationRuleInput interface { pulumi.Input ToQueueAuthorizationRuleOutput() QueueAuthorizationRuleOutput ToQueueAuthorizationRuleOutputWithContext(ctx context.Context) QueueAuthorizationRuleOutput }
type QueueAuthorizationRuleOutput ¶ added in v3.31.1
type QueueAuthorizationRuleOutput struct {
*pulumi.OutputState
}
func (QueueAuthorizationRuleOutput) ElementType ¶ added in v3.31.1
func (QueueAuthorizationRuleOutput) ElementType() reflect.Type
func (QueueAuthorizationRuleOutput) ToQueueAuthorizationRuleOutput ¶ added in v3.31.1
func (o QueueAuthorizationRuleOutput) ToQueueAuthorizationRuleOutput() QueueAuthorizationRuleOutput
func (QueueAuthorizationRuleOutput) ToQueueAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (o QueueAuthorizationRuleOutput) ToQueueAuthorizationRuleOutputWithContext(ctx context.Context) QueueAuthorizationRuleOutput
type QueueAuthorizationRuleState ¶
type QueueAuthorizationRuleState struct { // Does this Authorization Rule have Listen permissions to the ServiceBus Queue? Defaults to `false`. Listen pulumi.BoolPtrInput // 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`. Manage pulumi.BoolPtrInput // Specifies the name of the Authorization Rule. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // The Primary Connection String for the Authorization Rule. PrimaryConnectionString pulumi.StringPtrInput // The Primary Key for the Authorization Rule. PrimaryKey pulumi.StringPtrInput // Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created. QueueName pulumi.StringPtrInput // The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The Secondary Connection String for the Authorization Rule. SecondaryConnectionString pulumi.StringPtrInput // The Secondary Key for the Authorization Rule. SecondaryKey pulumi.StringPtrInput // Does this Authorization Rule have Send permissions to the ServiceBus Queue? Defaults to `false`. Send pulumi.BoolPtrInput }
func (QueueAuthorizationRuleState) ElementType ¶
func (QueueAuthorizationRuleState) ElementType() reflect.Type
type QueueInput ¶ added in v3.31.1
type QueueInput interface { pulumi.Input ToQueueOutput() QueueOutput ToQueueOutputWithContext(ctx context.Context) QueueOutput }
type QueueOutput ¶ added in v3.31.1
type QueueOutput struct {
*pulumi.OutputState
}
func (QueueOutput) ElementType ¶ added in v3.31.1
func (QueueOutput) ElementType() reflect.Type
func (QueueOutput) ToQueueOutput ¶ added in v3.31.1
func (o QueueOutput) ToQueueOutput() QueueOutput
func (QueueOutput) ToQueueOutputWithContext ¶ added in v3.31.1
func (o QueueOutput) ToQueueOutputWithContext(ctx context.Context) QueueOutput
type QueueState ¶
type QueueState struct { // The ISO 8601 timespan duration of the idle interval after which the Queue is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringPtrInput // Boolean flag which controls whether the Queue has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrInput // 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. DefaultMessageTtl pulumi.StringPtrInput // The ISO 8601 timespan duration during which duplicates can be detected. Defaults to 10 minutes (`PT10M`). DuplicateDetectionHistoryTimeWindow pulumi.StringPtrInput // Boolean flag which controls whether server-side batched operations are enabled. Defaults to `true`. EnableBatchedOperations pulumi.BoolPtrInput // 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`. EnableExpress pulumi.BoolPtrInput // 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`. EnablePartitioning pulumi.BoolPtrInput // The name of a Queue or Topic to automatically forward dead lettered messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrInput // The name of a Queue or Topic to automatically forward messages to. Please [see the documentation](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-auto-forwarding) for more information. ForwardTo pulumi.StringPtrInput // 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`). LockDuration pulumi.StringPtrInput // Integer value which controls when a message is automatically dead lettered. Defaults to `10`. MaxDeliveryCount pulumi.IntPtrInput // Integer value which controls the size of memory allocated for the queue. For supported values see the "Queue or topic size" section of [Service Bus Quotas](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). Defaults to `1024`. MaxSizeInMegabytes pulumi.IntPtrInput // Specifies the name of the ServiceBus Queue resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create this queue in. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // Boolean flag which controls whether the Queue requires duplicate detection. Changing this forces a new resource to be created. Defaults to `false`. RequiresDuplicateDetection pulumi.BoolPtrInput // 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`. RequiresSession pulumi.BoolPtrInput // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The status of the Queue. Possible values are `Active`, `Creating`, `Deleting`, `Disabled`, `ReceiveDisabled`, `Renaming`, `SendDisabled`, `Unknown`. Note that `Restoring` is not accepted. Defaults to `Active`. Status pulumi.StringPtrInput }
func (QueueState) ElementType ¶
func (QueueState) ElementType() reflect.Type
type Subscription ¶
type Subscription struct { pulumi.CustomResourceState // The idle interval after which the topic is automatically deleted as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The minimum duration is `5` minutes or `P5M`. AutoDeleteOnIdle pulumi.StringOutput `pulumi:"autoDeleteOnIdle"` // Boolean flag which controls whether the Subscription has dead letter support on filter evaluation exceptions. Defaults to `true`. DeadLetteringOnFilterEvaluationError pulumi.BoolPtrOutput `pulumi:"deadLetteringOnFilterEvaluationError"` // Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrOutput `pulumi:"deadLetteringOnMessageExpiration"` // The Default message timespan to live as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. DefaultMessageTtl pulumi.StringOutput `pulumi:"defaultMessageTtl"` // Boolean flag which controls whether the Subscription supports batched operations. Defaults to `false`. EnableBatchedOperations pulumi.BoolPtrOutput `pulumi:"enableBatchedOperations"` // The name of a Queue or Topic to automatically forward Dead Letter messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrOutput `pulumi:"forwardDeadLetteredMessagesTo"` // The name of a Queue or Topic to automatically forward messages to. ForwardTo pulumi.StringPtrOutput `pulumi:"forwardTo"` // The lock duration for the subscription as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The default value is `1` minute or `P1M`. LockDuration pulumi.StringOutput `pulumi:"lockDuration"` // The maximum number of deliveries. MaxDeliveryCount pulumi.IntOutput `pulumi:"maxDeliveryCount"` // Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // 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. RequiresSession pulumi.BoolPtrOutput `pulumi:"requiresSession"` // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The status of the Subscription. Possible values are `Active`,`ReceiveDisabled`, or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrOutput `pulumi:"status"` // The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created. TopicName pulumi.StringOutput `pulumi:"topicName"` }
Manages a ServiceBus Subscription.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } _, err = servicebus.NewSubscription(ctx, "exampleSubscription", &servicebus.SubscriptionArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, MaxDeliveryCount: pulumi.Int(1), }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Subscriptions can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/subscription:Subscription example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/topics/sntopic1/subscriptions/sbsub1
```
func GetSubscription ¶
func GetSubscription(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SubscriptionState, opts ...pulumi.ResourceOption) (*Subscription, error)
GetSubscription gets an existing Subscription resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSubscription ¶
func NewSubscription(ctx *pulumi.Context, name string, args *SubscriptionArgs, opts ...pulumi.ResourceOption) (*Subscription, error)
NewSubscription registers a new resource with the given unique name, arguments, and options.
func (Subscription) ElementType ¶ added in v3.31.1
func (Subscription) ElementType() reflect.Type
func (Subscription) ToSubscriptionOutput ¶ added in v3.31.1
func (i Subscription) ToSubscriptionOutput() SubscriptionOutput
func (Subscription) ToSubscriptionOutputWithContext ¶ added in v3.31.1
func (i Subscription) ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput
type SubscriptionArgs ¶
type SubscriptionArgs struct { // The idle interval after which the topic is automatically deleted as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The minimum duration is `5` minutes or `P5M`. AutoDeleteOnIdle pulumi.StringPtrInput // Boolean flag which controls whether the Subscription has dead letter support on filter evaluation exceptions. Defaults to `true`. DeadLetteringOnFilterEvaluationError pulumi.BoolPtrInput // Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrInput // The Default message timespan to live as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. DefaultMessageTtl pulumi.StringPtrInput // Boolean flag which controls whether the Subscription supports batched operations. Defaults to `false`. EnableBatchedOperations pulumi.BoolPtrInput // The name of a Queue or Topic to automatically forward Dead Letter messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrInput // The name of a Queue or Topic to automatically forward messages to. ForwardTo pulumi.StringPtrInput // The lock duration for the subscription as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The default value is `1` minute or `P1M`. LockDuration pulumi.StringPtrInput // The maximum number of deliveries. MaxDeliveryCount pulumi.IntInput // Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // 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. RequiresSession pulumi.BoolPtrInput // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // The status of the Subscription. Possible values are `Active`,`ReceiveDisabled`, or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrInput // The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created. TopicName pulumi.StringInput }
The set of arguments for constructing a Subscription resource.
func (SubscriptionArgs) ElementType ¶
func (SubscriptionArgs) ElementType() reflect.Type
type SubscriptionInput ¶ added in v3.31.1
type SubscriptionInput interface { pulumi.Input ToSubscriptionOutput() SubscriptionOutput ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput }
type SubscriptionOutput ¶ added in v3.31.1
type SubscriptionOutput struct {
*pulumi.OutputState
}
func (SubscriptionOutput) ElementType ¶ added in v3.31.1
func (SubscriptionOutput) ElementType() reflect.Type
func (SubscriptionOutput) ToSubscriptionOutput ¶ added in v3.31.1
func (o SubscriptionOutput) ToSubscriptionOutput() SubscriptionOutput
func (SubscriptionOutput) ToSubscriptionOutputWithContext ¶ added in v3.31.1
func (o SubscriptionOutput) ToSubscriptionOutputWithContext(ctx context.Context) SubscriptionOutput
type SubscriptionRule ¶
type SubscriptionRule struct { pulumi.CustomResourceState // Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage. Action pulumi.StringPtrOutput `pulumi:"action"` // A `correlationFilter` block as documented below to be evaluated against a BrokeredMessage. Required when `filterType` is set to `CorrelationFilter`. CorrelationFilter SubscriptionRuleCorrelationFilterPtrOutput `pulumi:"correlationFilter"` // Type of filter to be applied to a BrokeredMessage. Possible values are `SqlFilter` and `CorrelationFilter`. FilterType pulumi.StringOutput `pulumi:"filterType"` // Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when `filterType` is set to `SqlFilter`. SqlFilter pulumi.StringPtrOutput `pulumi:"sqlFilter"` // The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created. SubscriptionName pulumi.StringOutput `pulumi:"subscriptionName"` // The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created. TopicName pulumi.StringOutput `pulumi:"topicName"` }
Manages a ServiceBus Subscription Rule.
## Example Usage ### SQL Filter)
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } exampleSubscription, err := servicebus.NewSubscription(ctx, "exampleSubscription", &servicebus.SubscriptionArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, MaxDeliveryCount: pulumi.Int(1), }) if err != nil { return err } _, err = servicebus.NewSubscriptionRule(ctx, "exampleSubscriptionRule", &servicebus.SubscriptionRuleArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, SubscriptionName: exampleSubscription.Name, FilterType: pulumi.String("SqlFilter"), SqlFilter: pulumi.String("colour = 'red'"), }) if err != nil { return err } return nil }) }
``` ### Correlation Filter)
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } exampleSubscription, err := servicebus.NewSubscription(ctx, "exampleSubscription", &servicebus.SubscriptionArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, MaxDeliveryCount: pulumi.Int(1), }) if err != nil { return err } _, err = servicebus.NewSubscriptionRule(ctx, "exampleSubscriptionRule", &servicebus.SubscriptionRuleArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, SubscriptionName: exampleSubscription.Name, FilterType: pulumi.String("CorrelationFilter"), CorrelationFilter: &servicebus.SubscriptionRuleCorrelationFilterArgs{ CorrelationId: pulumi.String("high"), Label: pulumi.String("red"), Properties: pulumi.StringMap{ "customProperty": pulumi.String("value"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Subscription Rule can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/subscriptionRule:SubscriptionRule example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/topics/sntopic1/subscriptions/sbsub1/rules/sbrule1
```
func GetSubscriptionRule ¶
func GetSubscriptionRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SubscriptionRuleState, opts ...pulumi.ResourceOption) (*SubscriptionRule, error)
GetSubscriptionRule gets an existing SubscriptionRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSubscriptionRule ¶
func NewSubscriptionRule(ctx *pulumi.Context, name string, args *SubscriptionRuleArgs, opts ...pulumi.ResourceOption) (*SubscriptionRule, error)
NewSubscriptionRule registers a new resource with the given unique name, arguments, and options.
func (SubscriptionRule) ElementType ¶ added in v3.31.1
func (SubscriptionRule) ElementType() reflect.Type
func (SubscriptionRule) ToSubscriptionRuleOutput ¶ added in v3.31.1
func (i SubscriptionRule) ToSubscriptionRuleOutput() SubscriptionRuleOutput
func (SubscriptionRule) ToSubscriptionRuleOutputWithContext ¶ added in v3.31.1
func (i SubscriptionRule) ToSubscriptionRuleOutputWithContext(ctx context.Context) SubscriptionRuleOutput
type SubscriptionRuleArgs ¶
type SubscriptionRuleArgs struct { // Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage. Action pulumi.StringPtrInput // A `correlationFilter` block as documented below to be evaluated against a BrokeredMessage. Required when `filterType` is set to `CorrelationFilter`. CorrelationFilter SubscriptionRuleCorrelationFilterPtrInput // Type of filter to be applied to a BrokeredMessage. Possible values are `SqlFilter` and `CorrelationFilter`. FilterType pulumi.StringInput // Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when `filterType` is set to `SqlFilter`. SqlFilter pulumi.StringPtrInput // The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created. SubscriptionName pulumi.StringInput // The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created. TopicName pulumi.StringInput }
The set of arguments for constructing a SubscriptionRule resource.
func (SubscriptionRuleArgs) ElementType ¶
func (SubscriptionRuleArgs) ElementType() reflect.Type
type SubscriptionRuleCorrelationFilter ¶
type SubscriptionRuleCorrelationFilter struct { // Content type of the message. ContentType *string `pulumi:"contentType"` // Identifier of the correlation. CorrelationId *string `pulumi:"correlationId"` // Application specific label. Label *string `pulumi:"label"` // Identifier of the message. MessageId *string `pulumi:"messageId"` // A list of user defined properties to be included in the filter. Specified as a map of name/value pairs. Properties map[string]string `pulumi:"properties"` // Address of the queue to reply to. ReplyTo *string `pulumi:"replyTo"` // Session identifier to reply to. ReplyToSessionId *string `pulumi:"replyToSessionId"` // Session identifier. SessionId *string `pulumi:"sessionId"` // Address to send to. To *string `pulumi:"to"` }
type SubscriptionRuleCorrelationFilterArgs ¶
type SubscriptionRuleCorrelationFilterArgs struct { // Content type of the message. ContentType pulumi.StringPtrInput `pulumi:"contentType"` // Identifier of the correlation. CorrelationId pulumi.StringPtrInput `pulumi:"correlationId"` // Application specific label. Label pulumi.StringPtrInput `pulumi:"label"` // Identifier of the message. MessageId pulumi.StringPtrInput `pulumi:"messageId"` // A list of user defined properties to be included in the filter. Specified as a map of name/value pairs. Properties pulumi.StringMapInput `pulumi:"properties"` // Address of the queue to reply to. ReplyTo pulumi.StringPtrInput `pulumi:"replyTo"` // Session identifier to reply to. ReplyToSessionId pulumi.StringPtrInput `pulumi:"replyToSessionId"` // Session identifier. SessionId pulumi.StringPtrInput `pulumi:"sessionId"` // Address to send to. To pulumi.StringPtrInput `pulumi:"to"` }
func (SubscriptionRuleCorrelationFilterArgs) ElementType ¶
func (SubscriptionRuleCorrelationFilterArgs) ElementType() reflect.Type
func (SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutput ¶
func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutput() SubscriptionRuleCorrelationFilterOutput
func (SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutputWithContext ¶
func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterOutput
func (SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutput ¶
func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
func (SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext ¶
func (i SubscriptionRuleCorrelationFilterArgs) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
type SubscriptionRuleCorrelationFilterInput ¶
type SubscriptionRuleCorrelationFilterInput interface { pulumi.Input ToSubscriptionRuleCorrelationFilterOutput() SubscriptionRuleCorrelationFilterOutput ToSubscriptionRuleCorrelationFilterOutputWithContext(context.Context) SubscriptionRuleCorrelationFilterOutput }
SubscriptionRuleCorrelationFilterInput is an input type that accepts SubscriptionRuleCorrelationFilterArgs and SubscriptionRuleCorrelationFilterOutput values. You can construct a concrete instance of `SubscriptionRuleCorrelationFilterInput` via:
SubscriptionRuleCorrelationFilterArgs{...}
type SubscriptionRuleCorrelationFilterOutput ¶
type SubscriptionRuleCorrelationFilterOutput struct{ *pulumi.OutputState }
func (SubscriptionRuleCorrelationFilterOutput) ContentType ¶
func (o SubscriptionRuleCorrelationFilterOutput) ContentType() pulumi.StringPtrOutput
Content type of the message.
func (SubscriptionRuleCorrelationFilterOutput) CorrelationId ¶
func (o SubscriptionRuleCorrelationFilterOutput) CorrelationId() pulumi.StringPtrOutput
Identifier of the correlation.
func (SubscriptionRuleCorrelationFilterOutput) ElementType ¶
func (SubscriptionRuleCorrelationFilterOutput) ElementType() reflect.Type
func (SubscriptionRuleCorrelationFilterOutput) Label ¶
func (o SubscriptionRuleCorrelationFilterOutput) Label() pulumi.StringPtrOutput
Application specific label.
func (SubscriptionRuleCorrelationFilterOutput) MessageId ¶
func (o SubscriptionRuleCorrelationFilterOutput) MessageId() pulumi.StringPtrOutput
Identifier of the message.
func (SubscriptionRuleCorrelationFilterOutput) Properties ¶ added in v3.24.0
func (o SubscriptionRuleCorrelationFilterOutput) Properties() pulumi.StringMapOutput
A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.
func (SubscriptionRuleCorrelationFilterOutput) ReplyTo ¶
func (o SubscriptionRuleCorrelationFilterOutput) ReplyTo() pulumi.StringPtrOutput
Address of the queue to reply to.
func (SubscriptionRuleCorrelationFilterOutput) ReplyToSessionId ¶
func (o SubscriptionRuleCorrelationFilterOutput) ReplyToSessionId() pulumi.StringPtrOutput
Session identifier to reply to.
func (SubscriptionRuleCorrelationFilterOutput) SessionId ¶
func (o SubscriptionRuleCorrelationFilterOutput) SessionId() pulumi.StringPtrOutput
Session identifier.
func (SubscriptionRuleCorrelationFilterOutput) To ¶
func (o SubscriptionRuleCorrelationFilterOutput) To() pulumi.StringPtrOutput
Address to send to.
func (SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutput ¶
func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutput() SubscriptionRuleCorrelationFilterOutput
func (SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutputWithContext ¶
func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterOutput
func (SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutput ¶
func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
func (SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext ¶
func (o SubscriptionRuleCorrelationFilterOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
type SubscriptionRuleCorrelationFilterPtrInput ¶
type SubscriptionRuleCorrelationFilterPtrInput interface { pulumi.Input ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(context.Context) SubscriptionRuleCorrelationFilterPtrOutput }
SubscriptionRuleCorrelationFilterPtrInput is an input type that accepts SubscriptionRuleCorrelationFilterArgs, SubscriptionRuleCorrelationFilterPtr and SubscriptionRuleCorrelationFilterPtrOutput values. You can construct a concrete instance of `SubscriptionRuleCorrelationFilterPtrInput` via:
SubscriptionRuleCorrelationFilterArgs{...} or: nil
func SubscriptionRuleCorrelationFilterPtr ¶
func SubscriptionRuleCorrelationFilterPtr(v *SubscriptionRuleCorrelationFilterArgs) SubscriptionRuleCorrelationFilterPtrInput
type SubscriptionRuleCorrelationFilterPtrOutput ¶
type SubscriptionRuleCorrelationFilterPtrOutput struct{ *pulumi.OutputState }
func (SubscriptionRuleCorrelationFilterPtrOutput) ContentType ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) ContentType() pulumi.StringPtrOutput
Content type of the message.
func (SubscriptionRuleCorrelationFilterPtrOutput) CorrelationId ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) CorrelationId() pulumi.StringPtrOutput
Identifier of the correlation.
func (SubscriptionRuleCorrelationFilterPtrOutput) ElementType ¶
func (SubscriptionRuleCorrelationFilterPtrOutput) ElementType() reflect.Type
func (SubscriptionRuleCorrelationFilterPtrOutput) Label ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) Label() pulumi.StringPtrOutput
Application specific label.
func (SubscriptionRuleCorrelationFilterPtrOutput) MessageId ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) MessageId() pulumi.StringPtrOutput
Identifier of the message.
func (SubscriptionRuleCorrelationFilterPtrOutput) Properties ¶ added in v3.24.0
func (o SubscriptionRuleCorrelationFilterPtrOutput) Properties() pulumi.StringMapOutput
A list of user defined properties to be included in the filter. Specified as a map of name/value pairs.
func (SubscriptionRuleCorrelationFilterPtrOutput) ReplyTo ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) ReplyTo() pulumi.StringPtrOutput
Address of the queue to reply to.
func (SubscriptionRuleCorrelationFilterPtrOutput) ReplyToSessionId ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) ReplyToSessionId() pulumi.StringPtrOutput
Session identifier to reply to.
func (SubscriptionRuleCorrelationFilterPtrOutput) SessionId ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) SessionId() pulumi.StringPtrOutput
Session identifier.
func (SubscriptionRuleCorrelationFilterPtrOutput) To ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) To() pulumi.StringPtrOutput
Address to send to.
func (SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutput ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutput() SubscriptionRuleCorrelationFilterPtrOutput
func (SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext ¶
func (o SubscriptionRuleCorrelationFilterPtrOutput) ToSubscriptionRuleCorrelationFilterPtrOutputWithContext(ctx context.Context) SubscriptionRuleCorrelationFilterPtrOutput
type SubscriptionRuleInput ¶ added in v3.31.1
type SubscriptionRuleInput interface { pulumi.Input ToSubscriptionRuleOutput() SubscriptionRuleOutput ToSubscriptionRuleOutputWithContext(ctx context.Context) SubscriptionRuleOutput }
type SubscriptionRuleOutput ¶ added in v3.31.1
type SubscriptionRuleOutput struct {
*pulumi.OutputState
}
func (SubscriptionRuleOutput) ElementType ¶ added in v3.31.1
func (SubscriptionRuleOutput) ElementType() reflect.Type
func (SubscriptionRuleOutput) ToSubscriptionRuleOutput ¶ added in v3.31.1
func (o SubscriptionRuleOutput) ToSubscriptionRuleOutput() SubscriptionRuleOutput
func (SubscriptionRuleOutput) ToSubscriptionRuleOutputWithContext ¶ added in v3.31.1
func (o SubscriptionRuleOutput) ToSubscriptionRuleOutputWithContext(ctx context.Context) SubscriptionRuleOutput
type SubscriptionRuleState ¶
type SubscriptionRuleState struct { // Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage. Action pulumi.StringPtrInput // A `correlationFilter` block as documented below to be evaluated against a BrokeredMessage. Required when `filterType` is set to `CorrelationFilter`. CorrelationFilter SubscriptionRuleCorrelationFilterPtrInput // Type of filter to be applied to a BrokeredMessage. Possible values are `SqlFilter` and `CorrelationFilter`. FilterType pulumi.StringPtrInput // Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when `filterType` is set to `SqlFilter`. SqlFilter pulumi.StringPtrInput // The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created. SubscriptionName pulumi.StringPtrInput // The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created. TopicName pulumi.StringPtrInput }
func (SubscriptionRuleState) ElementType ¶
func (SubscriptionRuleState) ElementType() reflect.Type
type SubscriptionState ¶
type SubscriptionState struct { // The idle interval after which the topic is automatically deleted as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The minimum duration is `5` minutes or `P5M`. AutoDeleteOnIdle pulumi.StringPtrInput // Boolean flag which controls whether the Subscription has dead letter support on filter evaluation exceptions. Defaults to `true`. DeadLetteringOnFilterEvaluationError pulumi.BoolPtrInput // Boolean flag which controls whether the Subscription has dead letter support when a message expires. Defaults to `false`. DeadLetteringOnMessageExpiration pulumi.BoolPtrInput // The Default message timespan to live as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. DefaultMessageTtl pulumi.StringPtrInput // Boolean flag which controls whether the Subscription supports batched operations. Defaults to `false`. EnableBatchedOperations pulumi.BoolPtrInput // The name of a Queue or Topic to automatically forward Dead Letter messages to. ForwardDeadLetteredMessagesTo pulumi.StringPtrInput // The name of a Queue or Topic to automatically forward messages to. ForwardTo pulumi.StringPtrInput // The lock duration for the subscription as an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). The default value is `1` minute or `P1M`. LockDuration pulumi.StringPtrInput // The maximum number of deliveries. MaxDeliveryCount pulumi.IntPtrInput // Specifies the name of the ServiceBus Subscription resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create this Subscription in. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // 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. RequiresSession pulumi.BoolPtrInput // The name of the resource group in which to create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The status of the Subscription. Possible values are `Active`,`ReceiveDisabled`, or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrInput // The name of the ServiceBus Topic to create this Subscription in. Changing this forces a new resource to be created. TopicName pulumi.StringPtrInput }
func (SubscriptionState) ElementType ¶
func (SubscriptionState) ElementType() reflect.Type
type Topic ¶
type Topic struct { pulumi.CustomResourceState // The ISO 8601 timespan duration of the idle interval after which the // Topic is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringOutput `pulumi:"autoDeleteOnIdle"` // The ISO 8601 timespan duration of TTL of messages sent to this topic if no // TTL value is set on the message itself. DefaultMessageTtl pulumi.StringOutput `pulumi:"defaultMessageTtl"` // The ISO 8601 timespan duration during which // duplicates can be detected. Defaults to 10 minutes. (`PT10M`) DuplicateDetectionHistoryTimeWindow pulumi.StringOutput `pulumi:"duplicateDetectionHistoryTimeWindow"` // Boolean flag which controls if server-side // batched operations are enabled. Defaults to false. EnableBatchedOperations pulumi.BoolPtrOutput `pulumi:"enableBatchedOperations"` // 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. EnableExpress pulumi.BoolPtrOutput `pulumi:"enableExpress"` // 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. EnablePartitioning pulumi.BoolPtrOutput `pulumi:"enablePartitioning"` // Integer value which controls the size of // memory allocated for the topic. For supported values see the "Queue/topic size" // section of [this document](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). MaxSizeInMegabytes pulumi.IntOutput `pulumi:"maxSizeInMegabytes"` // Specifies the name of the ServiceBus Topic resource. Changing this forces a // new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // The name of the ServiceBus Namespace to create // this topic in. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // Boolean flag which controls whether // the Topic requires duplicate detection. Defaults to false. Changing this forces // a new resource to be created. RequiresDuplicateDetection pulumi.BoolPtrOutput `pulumi:"requiresDuplicateDetection"` // The name of the resource group in which to // create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The Status of the Service Bus Topic. Acceptable values are `Active` or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrOutput `pulumi:"status"` // Boolean flag which controls whether the Topic // supports ordering. Defaults to false. SupportOrdering pulumi.BoolPtrOutput `pulumi:"supportOrdering"` }
Manages a ServiceBus Topic.
**Note** Topics can only be created in Namespaces with an SKU of `standard` or higher.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West Europe"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } _, err = servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, EnablePartitioning: pulumi.Bool(true), }) if err != nil { return err } return nil }) }
```
## Import
Service Bus Topics can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/topic:Topic example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/microsoft.servicebus/namespaces/sbns1/topics/sntopic1
```
func GetTopic ¶
func GetTopic(ctx *pulumi.Context, name string, id pulumi.IDInput, state *TopicState, opts ...pulumi.ResourceOption) (*Topic, error)
GetTopic gets an existing Topic resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTopic ¶
func NewTopic(ctx *pulumi.Context, name string, args *TopicArgs, opts ...pulumi.ResourceOption) (*Topic, error)
NewTopic registers a new resource with the given unique name, arguments, and options.
func (Topic) ElementType ¶ added in v3.31.1
func (Topic) ToTopicOutput ¶ added in v3.31.1
func (i Topic) ToTopicOutput() TopicOutput
func (Topic) ToTopicOutputWithContext ¶ added in v3.31.1
func (i Topic) ToTopicOutputWithContext(ctx context.Context) TopicOutput
type TopicArgs ¶
type TopicArgs struct { // The ISO 8601 timespan duration of the idle interval after which the // Topic is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringPtrInput // The ISO 8601 timespan duration of TTL of messages sent to this topic if no // TTL value is set on the message itself. DefaultMessageTtl pulumi.StringPtrInput // The ISO 8601 timespan duration during which // duplicates can be detected. Defaults to 10 minutes. (`PT10M`) DuplicateDetectionHistoryTimeWindow pulumi.StringPtrInput // Boolean flag which controls if server-side // batched operations are enabled. Defaults to false. EnableBatchedOperations pulumi.BoolPtrInput // 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. EnableExpress pulumi.BoolPtrInput // 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. EnablePartitioning pulumi.BoolPtrInput // Integer value which controls the size of // memory allocated for the topic. For supported values see the "Queue/topic size" // section of [this document](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). MaxSizeInMegabytes pulumi.IntPtrInput // Specifies the name of the ServiceBus Topic resource. Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create // this topic in. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // Boolean flag which controls whether // the Topic requires duplicate detection. Defaults to false. Changing this forces // a new resource to be created. RequiresDuplicateDetection pulumi.BoolPtrInput // The name of the resource group in which to // create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // The Status of the Service Bus Topic. Acceptable values are `Active` or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrInput // Boolean flag which controls whether the Topic // supports ordering. Defaults to false. SupportOrdering pulumi.BoolPtrInput }
The set of arguments for constructing a Topic resource.
func (TopicArgs) ElementType ¶
type TopicAuthorizationRule ¶
type TopicAuthorizationRule struct { pulumi.CustomResourceState // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrOutput `pulumi:"listen"` // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrOutput `pulumi:"manage"` // Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringOutput `pulumi:"name"` // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringOutput `pulumi:"namespaceName"` // The Primary Connection String for the ServiceBus Topic authorization Rule. PrimaryConnectionString pulumi.StringOutput `pulumi:"primaryConnectionString"` // The Primary Key for the ServiceBus Topic authorization Rule. PrimaryKey pulumi.StringOutput `pulumi:"primaryKey"` // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"` // The Secondary Connection String for the ServiceBus Topic authorization Rule. SecondaryConnectionString pulumi.StringOutput `pulumi:"secondaryConnectionString"` // The Secondary Key for the ServiceBus Topic authorization Rule. SecondaryKey pulumi.StringOutput `pulumi:"secondaryKey"` // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrOutput `pulumi:"send"` // Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created. TopicName pulumi.StringOutput `pulumi:"topicName"` }
Manages a ServiceBus Topic authorization Rule within a ServiceBus Topic.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core" "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/servicebus" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{ Location: pulumi.String("West US"), }) if err != nil { return err } exampleNamespace, err := servicebus.NewNamespace(ctx, "exampleNamespace", &servicebus.NamespaceArgs{ Location: exampleResourceGroup.Location, ResourceGroupName: exampleResourceGroup.Name, Sku: pulumi.String("Standard"), Tags: pulumi.StringMap{ "source": pulumi.String("example"), }, }) if err != nil { return err } exampleTopic, err := servicebus.NewTopic(ctx, "exampleTopic", &servicebus.TopicArgs{ ResourceGroupName: exampleResourceGroup.Name, NamespaceName: exampleNamespace.Name, }) if err != nil { return err } _, err = servicebus.NewTopicAuthorizationRule(ctx, "exampleTopicAuthorizationRule", &servicebus.TopicAuthorizationRuleArgs{ NamespaceName: exampleNamespace.Name, TopicName: exampleTopic.Name, ResourceGroupName: exampleResourceGroup.Name, Listen: pulumi.Bool(true), Send: pulumi.Bool(false), Manage: pulumi.Bool(false), }) if err != nil { return err } return nil }) }
```
## Import
ServiceBus Topic authorization rules can be imported using the `resource id`, e.g.
```sh
$ pulumi import azure:servicebus/topicAuthorizationRule:TopicAuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ServiceBus/namespaces/namespace1/topics/topic1/authorizationRules/rule1
```
func GetTopicAuthorizationRule ¶
func GetTopicAuthorizationRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *TopicAuthorizationRuleState, opts ...pulumi.ResourceOption) (*TopicAuthorizationRule, error)
GetTopicAuthorizationRule gets an existing TopicAuthorizationRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewTopicAuthorizationRule ¶
func NewTopicAuthorizationRule(ctx *pulumi.Context, name string, args *TopicAuthorizationRuleArgs, opts ...pulumi.ResourceOption) (*TopicAuthorizationRule, error)
NewTopicAuthorizationRule registers a new resource with the given unique name, arguments, and options.
func (TopicAuthorizationRule) ElementType ¶ added in v3.31.1
func (TopicAuthorizationRule) ElementType() reflect.Type
func (TopicAuthorizationRule) ToTopicAuthorizationRuleOutput ¶ added in v3.31.1
func (i TopicAuthorizationRule) ToTopicAuthorizationRuleOutput() TopicAuthorizationRuleOutput
func (TopicAuthorizationRule) ToTopicAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (i TopicAuthorizationRule) ToTopicAuthorizationRuleOutputWithContext(ctx context.Context) TopicAuthorizationRuleOutput
type TopicAuthorizationRuleArgs ¶
type TopicAuthorizationRuleArgs struct { // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrInput // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrInput // Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringInput // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringInput // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrInput // Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created. TopicName pulumi.StringInput }
The set of arguments for constructing a TopicAuthorizationRule resource.
func (TopicAuthorizationRuleArgs) ElementType ¶
func (TopicAuthorizationRuleArgs) ElementType() reflect.Type
type TopicAuthorizationRuleInput ¶ added in v3.31.1
type TopicAuthorizationRuleInput interface { pulumi.Input ToTopicAuthorizationRuleOutput() TopicAuthorizationRuleOutput ToTopicAuthorizationRuleOutputWithContext(ctx context.Context) TopicAuthorizationRuleOutput }
type TopicAuthorizationRuleOutput ¶ added in v3.31.1
type TopicAuthorizationRuleOutput struct {
*pulumi.OutputState
}
func (TopicAuthorizationRuleOutput) ElementType ¶ added in v3.31.1
func (TopicAuthorizationRuleOutput) ElementType() reflect.Type
func (TopicAuthorizationRuleOutput) ToTopicAuthorizationRuleOutput ¶ added in v3.31.1
func (o TopicAuthorizationRuleOutput) ToTopicAuthorizationRuleOutput() TopicAuthorizationRuleOutput
func (TopicAuthorizationRuleOutput) ToTopicAuthorizationRuleOutputWithContext ¶ added in v3.31.1
func (o TopicAuthorizationRuleOutput) ToTopicAuthorizationRuleOutputWithContext(ctx context.Context) TopicAuthorizationRuleOutput
type TopicAuthorizationRuleState ¶
type TopicAuthorizationRuleState struct { // Grants listen access to this this Authorization Rule. Defaults to `false`. Listen pulumi.BoolPtrInput // Grants manage access to this this Authorization Rule. When this property is `true` - both `listen` and `send` must be too. Defaults to `false`. Manage pulumi.BoolPtrInput // Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created. Name pulumi.StringPtrInput // Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // The Primary Connection String for the ServiceBus Topic authorization Rule. PrimaryConnectionString pulumi.StringPtrInput // The Primary Key for the ServiceBus Topic authorization Rule. PrimaryKey pulumi.StringPtrInput // The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The Secondary Connection String for the ServiceBus Topic authorization Rule. SecondaryConnectionString pulumi.StringPtrInput // The Secondary Key for the ServiceBus Topic authorization Rule. SecondaryKey pulumi.StringPtrInput // Grants send access to this this Authorization Rule. Defaults to `false`. Send pulumi.BoolPtrInput // Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created. TopicName pulumi.StringPtrInput }
func (TopicAuthorizationRuleState) ElementType ¶
func (TopicAuthorizationRuleState) ElementType() reflect.Type
type TopicInput ¶ added in v3.31.1
type TopicInput interface { pulumi.Input ToTopicOutput() TopicOutput ToTopicOutputWithContext(ctx context.Context) TopicOutput }
type TopicOutput ¶ added in v3.31.1
type TopicOutput struct {
*pulumi.OutputState
}
func (TopicOutput) ElementType ¶ added in v3.31.1
func (TopicOutput) ElementType() reflect.Type
func (TopicOutput) ToTopicOutput ¶ added in v3.31.1
func (o TopicOutput) ToTopicOutput() TopicOutput
func (TopicOutput) ToTopicOutputWithContext ¶ added in v3.31.1
func (o TopicOutput) ToTopicOutputWithContext(ctx context.Context) TopicOutput
type TopicState ¶
type TopicState struct { // The ISO 8601 timespan duration of the idle interval after which the // Topic is automatically deleted, minimum of 5 minutes. AutoDeleteOnIdle pulumi.StringPtrInput // The ISO 8601 timespan duration of TTL of messages sent to this topic if no // TTL value is set on the message itself. DefaultMessageTtl pulumi.StringPtrInput // The ISO 8601 timespan duration during which // duplicates can be detected. Defaults to 10 minutes. (`PT10M`) DuplicateDetectionHistoryTimeWindow pulumi.StringPtrInput // Boolean flag which controls if server-side // batched operations are enabled. Defaults to false. EnableBatchedOperations pulumi.BoolPtrInput // 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. EnableExpress pulumi.BoolPtrInput // 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. EnablePartitioning pulumi.BoolPtrInput // Integer value which controls the size of // memory allocated for the topic. For supported values see the "Queue/topic size" // section of [this document](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-quotas). MaxSizeInMegabytes pulumi.IntPtrInput // Specifies the name of the ServiceBus Topic resource. Changing this forces a // new resource to be created. Name pulumi.StringPtrInput // The name of the ServiceBus Namespace to create // this topic in. Changing this forces a new resource to be created. NamespaceName pulumi.StringPtrInput // Boolean flag which controls whether // the Topic requires duplicate detection. Defaults to false. Changing this forces // a new resource to be created. RequiresDuplicateDetection pulumi.BoolPtrInput // The name of the resource group in which to // create the namespace. Changing this forces a new resource to be created. ResourceGroupName pulumi.StringPtrInput // The Status of the Service Bus Topic. Acceptable values are `Active` or `Disabled`. Defaults to `Active`. Status pulumi.StringPtrInput // Boolean flag which controls whether the Topic // supports ordering. Defaults to false. SupportOrdering pulumi.BoolPtrInput }
func (TopicState) ElementType ¶
func (TopicState) ElementType() reflect.Type
Source Files
¶
- getNamespace.go
- getNamespaceAuthorizationRule.go
- getQueueAuthorizationRule.go
- getSubscription.go
- getTopicAuthorizationRule.go
- namespace.go
- namespaceAuthorizationRule.go
- namespaceNetworkRuleSet.go
- pulumiTypes.go
- queue.go
- queueAuthorizationRule.go
- subscription.go
- subscriptionRule.go
- topic.go
- topicAuthorizationRule.go