@kengachu-pulumi/azure-native-servicebus
Version:
Pulumi Azure Native package for servicebus
138 lines (137 loc) • 4.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
* Gets a description for the specified namespace.
*
* Uses Azure REST API version 2024-01-01.
*
* Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native servicebus [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNamespace(args: GetNamespaceArgs, opts?: pulumi.InvokeOptions): Promise<GetNamespaceResult>;
export interface GetNamespaceArgs {
/**
* The namespace name
*/
namespaceName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Description of a namespace resource.
*/
export interface GetNamespaceResult {
/**
* Alternate name for namespace
*/
readonly alternateName?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The time the namespace was created
*/
readonly createdAt: string;
/**
* This property disables SAS authentication for the Service Bus namespace.
*/
readonly disableLocalAuth?: boolean;
/**
* Properties of BYOK Encryption description
*/
readonly encryption?: types.outputs.EncryptionResponse;
/**
* Resource Id
*/
readonly id: string;
/**
* Properties of BYOK Identity description
*/
readonly identity?: types.outputs.IdentityResponse;
/**
* The Geo-location where the resource lives
*/
readonly location: string;
/**
* Identifier for Azure Insights metrics
*/
readonly metricId: string;
/**
* The minimum TLS version for the cluster to support, e.g. '1.2'
*/
readonly minimumTlsVersion?: string;
/**
* Resource name
*/
readonly name: string;
/**
* The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4
*/
readonly premiumMessagingPartitions?: number;
/**
* List of private endpoint connections.
*/
readonly privateEndpointConnections?: types.outputs.PrivateEndpointConnectionResponse[];
/**
* Provisioning state of the namespace.
*/
readonly provisioningState: string;
/**
* This determines if traffic is allowed over public network. By default it is enabled.
*/
readonly publicNetworkAccess?: string;
/**
* Endpoint you can use to perform Service Bus operations.
*/
readonly serviceBusEndpoint: string;
/**
* Properties of SKU
*/
readonly sku?: types.outputs.SBSkuResponse;
/**
* Status of the namespace.
*/
readonly status: string;
/**
* The system meta data relating to this resource.
*/
readonly systemData: types.outputs.SystemDataResponse;
/**
* Resource tags
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type
*/
readonly type: string;
/**
* The time the namespace was updated.
*/
readonly updatedAt: string;
/**
* Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.
*/
readonly zoneRedundant?: boolean;
}
/**
* Gets a description for the specified namespace.
*
* Uses Azure REST API version 2024-01-01.
*
* Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native servicebus [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getNamespaceOutput(args: GetNamespaceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNamespaceResult>;
export interface GetNamespaceOutputArgs {
/**
* The namespace name
*/
namespaceName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}