1. Packages
  2. Azure Native v2
  3. API Docs
  4. relay
  5. getNamespace
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.relay.getNamespace

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Returns the description for the specified namespace. Azure REST API version: 2021-11-01.

Other available API versions: 2024-01-01.

Using getNamespace

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 getNamespace(args: GetNamespaceArgs, opts?: InvokeOptions): Promise<GetNamespaceResult>
function getNamespaceOutput(args: GetNamespaceOutputArgs, opts?: InvokeOptions): Output<GetNamespaceResult>
Copy
def get_namespace(namespace_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetNamespaceResult
def get_namespace_output(namespace_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetNamespaceResult]
Copy
func LookupNamespace(ctx *Context, args *LookupNamespaceArgs, opts ...InvokeOption) (*LookupNamespaceResult, error)
func LookupNamespaceOutput(ctx *Context, args *LookupNamespaceOutputArgs, opts ...InvokeOption) LookupNamespaceResultOutput
Copy

> Note: This function is named LookupNamespace in the Go SDK.

public static class GetNamespace 
{
    public static Task<GetNamespaceResult> InvokeAsync(GetNamespaceArgs args, InvokeOptions? opts = null)
    public static Output<GetNamespaceResult> Invoke(GetNamespaceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNamespaceResult> getNamespace(GetNamespaceArgs args, InvokeOptions options)
public static Output<GetNamespaceResult> getNamespace(GetNamespaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:relay:getNamespace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.

getNamespace Result

The following output properties are available:

CreatedAt string
The time the namespace was created.
Id string
Resource ID.
Location string
Resource location.
MetricId string
Identifier for Azure Insights metrics.
Name string
Resource name.
ProvisioningState string
Provisioning state of the Namespace.
ServiceBusEndpoint string
Endpoint you can use to perform Service Bus operations.
Status string
Status of the Namespace.
SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
The system meta data relating to this resource.
Type string
Resource type.
UpdatedAt string
The time the namespace was updated.
PrivateEndpointConnections List<Pulumi.AzureNative.Relay.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connections.
PublicNetworkAccess string
This determines if traffic is allowed over public network. By default it is enabled.
Sku Pulumi.AzureNative.Relay.Outputs.SkuResponse
SKU of the namespace.
Tags Dictionary<string, string>
Resource tags.
CreatedAt string
The time the namespace was created.
Id string
Resource ID.
Location string
Resource location.
MetricId string
Identifier for Azure Insights metrics.
Name string
Resource name.
ProvisioningState string
Provisioning state of the Namespace.
ServiceBusEndpoint string
Endpoint you can use to perform Service Bus operations.
Status string
Status of the Namespace.
SystemData SystemDataResponse
The system meta data relating to this resource.
Type string
Resource type.
UpdatedAt string
The time the namespace was updated.
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connections.
PublicNetworkAccess string
This determines if traffic is allowed over public network. By default it is enabled.
Sku SkuResponse
SKU of the namespace.
Tags map[string]string
Resource tags.
createdAt String
The time the namespace was created.
id String
Resource ID.
location String
Resource location.
metricId String
Identifier for Azure Insights metrics.
name String
Resource name.
provisioningState String
Provisioning state of the Namespace.
serviceBusEndpoint String
Endpoint you can use to perform Service Bus operations.
status String
Status of the Namespace.
systemData SystemDataResponse
The system meta data relating to this resource.
type String
Resource type.
updatedAt String
The time the namespace was updated.
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connections.
publicNetworkAccess String
This determines if traffic is allowed over public network. By default it is enabled.
sku SkuResponse
SKU of the namespace.
tags Map<String,String>
Resource tags.
createdAt string
The time the namespace was created.
id string
Resource ID.
location string
Resource location.
metricId string
Identifier for Azure Insights metrics.
name string
Resource name.
provisioningState string
Provisioning state of the Namespace.
serviceBusEndpoint string
Endpoint you can use to perform Service Bus operations.
status string
Status of the Namespace.
systemData SystemDataResponse
The system meta data relating to this resource.
type string
Resource type.
updatedAt string
The time the namespace was updated.
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connections.
publicNetworkAccess string
This determines if traffic is allowed over public network. By default it is enabled.
sku SkuResponse
SKU of the namespace.
tags {[key: string]: string}
Resource tags.
created_at str
The time the namespace was created.
id str
Resource ID.
location str
Resource location.
metric_id str
Identifier for Azure Insights metrics.
name str
Resource name.
provisioning_state str
Provisioning state of the Namespace.
service_bus_endpoint str
Endpoint you can use to perform Service Bus operations.
status str
Status of the Namespace.
system_data SystemDataResponse
The system meta data relating to this resource.
type str
Resource type.
updated_at str
The time the namespace was updated.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connections.
public_network_access str
This determines if traffic is allowed over public network. By default it is enabled.
sku SkuResponse
SKU of the namespace.
tags Mapping[str, str]
Resource tags.
createdAt String
The time the namespace was created.
id String
Resource ID.
location String
Resource location.
metricId String
Identifier for Azure Insights metrics.
name String
Resource name.
provisioningState String
Provisioning state of the Namespace.
serviceBusEndpoint String
Endpoint you can use to perform Service Bus operations.
status String
Status of the Namespace.
systemData Property Map
The system meta data relating to this resource.
type String
Resource type.
updatedAt String
The time the namespace was updated.
privateEndpointConnections List<Property Map>
List of private endpoint connections.
publicNetworkAccess String
This determines if traffic is allowed over public network. By default it is enabled.
sku Property Map
SKU of the namespace.
tags Map<String>
Resource tags.

Supporting Types

ConnectionStateResponse

Description string
Description of the connection state.
Status string
Status of the connection.
Description string
Description of the connection state.
Status string
Status of the connection.
description String
Description of the connection state.
status String
Status of the connection.
description string
Description of the connection state.
status string
Status of the connection.
description str
Description of the connection state.
status str
Status of the connection.
description String
Description of the connection state.
status String
Status of the connection.

PrivateEndpointConnectionResponse

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location This property is required. string
The geo-location where the resource lives
Name This property is required. string
The name of the resource
SystemData This property is required. Pulumi.AzureNative.Relay.Inputs.SystemDataResponse
The system meta data relating to this resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
PrivateEndpoint Pulumi.AzureNative.Relay.Inputs.PrivateEndpointResponse
The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Relay.Inputs.ConnectionStateResponse
Details about the state of the connection.
ProvisioningState string
Provisioning state of the Private Endpoint Connection.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location This property is required. string
The geo-location where the resource lives
Name This property is required. string
The name of the resource
SystemData This property is required. SystemDataResponse
The system meta data relating to this resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
PrivateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
PrivateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
ProvisioningState string
Provisioning state of the Private Endpoint Connection.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location This property is required. String
The geo-location where the resource lives
name This property is required. String
The name of the resource
systemData This property is required. SystemDataResponse
The system meta data relating to this resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
provisioningState String
Provisioning state of the Private Endpoint Connection.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location This property is required. string
The geo-location where the resource lives
name This property is required. string
The name of the resource
systemData This property is required. SystemDataResponse
The system meta data relating to this resource.
type This property is required. string
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState ConnectionStateResponse
Details about the state of the connection.
provisioningState string
Provisioning state of the Private Endpoint Connection.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location This property is required. str
The geo-location where the resource lives
name This property is required. str
The name of the resource
system_data This property is required. SystemDataResponse
The system meta data relating to this resource.
type This property is required. str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
private_endpoint PrivateEndpointResponse
The Private Endpoint resource for this Connection.
private_link_service_connection_state ConnectionStateResponse
Details about the state of the connection.
provisioning_state str
Provisioning state of the Private Endpoint Connection.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location This property is required. String
The geo-location where the resource lives
name This property is required. String
The name of the resource
systemData This property is required. Property Map
The system meta data relating to this resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
privateEndpoint Property Map
The Private Endpoint resource for this Connection.
privateLinkServiceConnectionState Property Map
Details about the state of the connection.
provisioningState String
Provisioning state of the Private Endpoint Connection.

PrivateEndpointResponse

Id string
The ARM identifier for Private Endpoint.
Id string
The ARM identifier for Private Endpoint.
id String
The ARM identifier for Private Endpoint.
id string
The ARM identifier for Private Endpoint.
id str
The ARM identifier for Private Endpoint.
id String
The ARM identifier for Private Endpoint.

SkuResponse

Name This property is required. string
Name of this SKU.
Tier string
The tier of this SKU.
Name This property is required. string
Name of this SKU.
Tier string
The tier of this SKU.
name This property is required. String
Name of this SKU.
tier String
The tier of this SKU.
name This property is required. string
Name of this SKU.
tier string
The tier of this SKU.
name This property is required. str
Name of this SKU.
tier str
The tier of this SKU.
name This property is required. String
Name of this SKU.
tier String
The tier of this SKU.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi