Docs
PackagesWe recommend using Azure Native.
Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
azure.servicebus.getTopic
Explore with Pulumi AI
Use this data source to access information about an existing Service Bus Topic.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.servicebus.getTopic({
name: "existing",
namespaceId: "existing",
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.servicebus.get_topic(name="existing",
namespace_id="existing")
pulumi.export("id", example.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/servicebus"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := servicebus.LookupTopic(ctx, &servicebus.LookupTopicArgs{
Name: "existing",
NamespaceId: pulumi.StringRef("existing"),
}, nil)
if err != nil {
return err
}
ctx.Export("id", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ServiceBus.GetTopic.Invoke(new()
{
Name = "existing",
NamespaceId = "existing",
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getTopicResult => getTopicResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.servicebus.ServicebusFunctions;
import com.pulumi.azure.servicebus.inputs.GetTopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ServicebusFunctions.getTopic(GetTopicArgs.builder()
.name("existing")
.namespaceId("existing")
.build());
ctx.export("id", example.applyValue(getTopicResult -> getTopicResult.id()));
}
}
variables:
example:
fn::invoke:
Function: azure:servicebus:getTopic
Arguments:
name: existing
namespaceId: existing
outputs:
id: ${example.id}
Using getTopic
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>def get_topic(name: Optional[str] = None,
namespace_id: Optional[str] = None,
namespace_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(name: Optional[pulumi.Input[str]] = None,
namespace_id: Optional[pulumi.Input[str]] = None,
namespace_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput> Note: This function is named LookupTopic in the Go SDK.
public static class GetTopic
{
public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:servicebus/getTopic:getTopic
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The name of this Service Bus Topic.
- Namespace
Id string - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- Namespace
Name string - The name of the Service Bus Namespace.
- Resource
Group stringName The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
- Name string
- The name of this Service Bus Topic.
- Namespace
Id string - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- Namespace
Name string - The name of the Service Bus Namespace.
- Resource
Group stringName The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
- name String
- The name of this Service Bus Topic.
- namespace
Id String - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- namespace
Name String - The name of the Service Bus Namespace.
- resource
Group StringName The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
- name string
- The name of this Service Bus Topic.
- namespace
Id string - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- namespace
Name string - The name of the Service Bus Namespace.
- resource
Group stringName The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
- name str
- The name of this Service Bus Topic.
- namespace_
id str - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- namespace_
name str - The name of the Service Bus Namespace.
- resource_
group_ strname The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
- name String
- The name of this Service Bus Topic.
- namespace
Id String - The ID of the ServiceBus Namespace where the Service Bus Topic exists.
- namespace
Name String - The name of the Service Bus Namespace.
- resource
Group StringName The name of the Resource Group where the Service Bus Topic exists.
Note:
namespace_nameandresource_group_namehas been deprecated and will be removed in version 4.0 of the provider in favour ofnamespace_id.
getTopic Result
The following output properties are available:
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- Default
Message stringTtl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- Duplicate
Detection stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected.
- Enable
Batched boolOperations - Boolean flag which controls if server-side batched operations are enabled.
- Enable
Express bool - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- Enable
Partitioning bool - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- Id string
- The provider-assigned unique ID for this managed resource.
- Max
Size intIn Megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- Name string
- Requires
Duplicate boolDetection - Boolean flag which controls whether the Topic requires duplicate detection.
- Status string
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- Support
Ordering bool - Boolean flag which controls whether the Topic supports ordering.
- Namespace
Id string - Namespace
Name string - Resource
Group stringName
- Auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- Default
Message stringTtl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- Duplicate
Detection stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected.
- Enable
Batched boolOperations - Boolean flag which controls if server-side batched operations are enabled.
- Enable
Express bool - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- Enable
Partitioning bool - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- Id string
- The provider-assigned unique ID for this managed resource.
- Max
Size intIn Megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- Name string
- Requires
Duplicate boolDetection - Boolean flag which controls whether the Topic requires duplicate detection.
- Status string
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- Support
Ordering bool - Boolean flag which controls whether the Topic supports ordering.
- Namespace
Id string - Namespace
Name string - Resource
Group stringName
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- default
Message StringTtl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- duplicate
Detection StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected.
- enable
Batched BooleanOperations - Boolean flag which controls if server-side batched operations are enabled.
- enable
Express Boolean - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- enable
Partitioning Boolean - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- id String
- The provider-assigned unique ID for this managed resource.
- max
Size IntegerIn Megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- name String
- requires
Duplicate BooleanDetection - Boolean flag which controls whether the Topic requires duplicate detection.
- status String
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- support
Ordering Boolean - Boolean flag which controls whether the Topic supports ordering.
- namespace
Id String - namespace
Name String - resource
Group StringName
- auto
Delete stringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- default
Message stringTtl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- duplicate
Detection stringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected.
- enable
Batched booleanOperations - Boolean flag which controls if server-side batched operations are enabled.
- enable
Express boolean - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- enable
Partitioning boolean - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- id string
- The provider-assigned unique ID for this managed resource.
- max
Size numberIn Megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- name string
- requires
Duplicate booleanDetection - Boolean flag which controls whether the Topic requires duplicate detection.
- status string
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- support
Ordering boolean - Boolean flag which controls whether the Topic supports ordering.
- namespace
Id string - namespace
Name string - resource
Group stringName
- auto_
delete_ stron_ idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- default_
message_ strttl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- duplicate_
detection_ strhistory_ time_ window - The ISO 8601 timespan duration during which duplicates can be detected.
- enable_
batched_ booloperations - Boolean flag which controls if server-side batched operations are enabled.
- enable_
express bool - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- enable_
partitioning bool - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- id str
- The provider-assigned unique ID for this managed resource.
- max_
size_ intin_ megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- name str
- requires_
duplicate_ booldetection - Boolean flag which controls whether the Topic requires duplicate detection.
- status str
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- support_
ordering bool - Boolean flag which controls whether the Topic supports ordering.
- namespace_
id str - namespace_
name str - resource_
group_ strname
- auto
Delete StringOn Idle - The ISO 8601 timespan duration of the idle interval after which the Topic is automatically deleted, minimum of 5 minutes.
- default
Message StringTtl - The ISO 8601 timespan duration of TTL of messages sent to this topic if no TTL value is set on the message itself.
- duplicate
Detection StringHistory Time Window - The ISO 8601 timespan duration during which duplicates can be detected.
- enable
Batched BooleanOperations - Boolean flag which controls if server-side batched operations are enabled.
- enable
Express Boolean - Boolean flag which controls whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
- enable
Partitioning Boolean - Boolean flag which controls whether to enable the topic to be partitioned across multiple message brokers.
- id String
- The provider-assigned unique ID for this managed resource.
- max
Size NumberIn Megabytes - Integer value which controls the size of memory allocated for the topic. For supported values see the "Queue/topic size" section of this document.
- name String
- requires
Duplicate BooleanDetection - Boolean flag which controls whether the Topic requires duplicate detection.
- status String
- The Status of the Service Bus Topic. Acceptable values are Active or Disabled.
- support
Ordering Boolean - Boolean flag which controls whether the Topic supports ordering.
- namespace
Id String - namespace
Name String - resource
Group StringName
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.