@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Single Namespace item in List or Get Operation
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-10-01-preview.
*
* 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, 2024-05-01-preview, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native eventhub [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Namespace extends pulumi.CustomResource {
/**
* Get an existing Namespace resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Namespace;
/**
* Returns true if the given object is an instance of Namespace. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Namespace;
/**
* Alternate name specified when alias and namespace names are same.
*/
readonly alternateName: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Cluster ARM ID of the Namespace.
*/
readonly clusterArmId: pulumi.Output<string | undefined>;
/**
* The time the Namespace was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* This property disables SAS authentication for the Event Hubs namespace.
*/
readonly disableLocalAuth: pulumi.Output<boolean | undefined>;
/**
* Properties of BYOK Encryption description
*/
readonly encryption: pulumi.Output<outputs.eventhub.EncryptionResponse | undefined>;
/**
* Properties of BYOK Identity description
*/
readonly identity: pulumi.Output<outputs.eventhub.IdentityResponse | undefined>;
/**
* Value that indicates whether AutoInflate is enabled for eventhub namespace.
*/
readonly isAutoInflateEnabled: pulumi.Output<boolean | undefined>;
/**
* Value that indicates whether Kafka is enabled for eventhub namespace.
*/
readonly kafkaEnabled: pulumi.Output<boolean | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)
*/
readonly maximumThroughputUnits: pulumi.Output<number | undefined>;
/**
* Identifier for Azure Insights metrics.
*/
readonly metricId: pulumi.Output<string>;
/**
* The minimum TLS version for the cluster to support, e.g. '1.2'
*/
readonly minimumTlsVersion: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* List of private endpoint connections.
*/
readonly privateEndpointConnections: pulumi.Output<outputs.eventhub.PrivateEndpointConnectionResponse[] | undefined>;
/**
* Provisioning state of the Namespace.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* This determines if traffic is allowed over public network. By default it is enabled.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* Endpoint you can use to perform Service Bus operations.
*/
readonly serviceBusEndpoint: pulumi.Output<string>;
/**
* Properties of sku resource
*/
readonly sku: pulumi.Output<outputs.eventhub.SkuResponse | undefined>;
/**
* Status of the Namespace.
*/
readonly status: pulumi.Output<string>;
/**
* The system meta data relating to this resource.
*/
readonly systemData: pulumi.Output<outputs.eventhub.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* The time the Namespace was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.
*/
readonly zoneRedundant: pulumi.Output<boolean | undefined>;
/**
* Create a Namespace resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NamespaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Namespace resource.
*/
export interface NamespaceArgs {
/**
* Alternate name specified when alias and namespace names are same.
*/
alternateName?: pulumi.Input<string>;
/**
* Cluster ARM ID of the Namespace.
*/
clusterArmId?: pulumi.Input<string>;
/**
* This property disables SAS authentication for the Event Hubs namespace.
*/
disableLocalAuth?: pulumi.Input<boolean>;
/**
* Properties of BYOK Encryption description
*/
encryption?: pulumi.Input<inputs.eventhub.EncryptionArgs>;
/**
* Properties of BYOK Identity description
*/
identity?: pulumi.Input<inputs.eventhub.IdentityArgs>;
/**
* Value that indicates whether AutoInflate is enabled for eventhub namespace.
*/
isAutoInflateEnabled?: pulumi.Input<boolean>;
/**
* Value that indicates whether Kafka is enabled for eventhub namespace.
*/
kafkaEnabled?: pulumi.Input<boolean>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)
*/
maximumThroughputUnits?: pulumi.Input<number>;
/**
* The minimum TLS version for the cluster to support, e.g. '1.2'
*/
minimumTlsVersion?: pulumi.Input<string | enums.eventhub.TlsVersion>;
/**
* The Namespace name
*/
namespaceName?: pulumi.Input<string>;
/**
* List of private endpoint connections.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
privateEndpointConnections?: pulumi.Input<pulumi.Input<inputs.eventhub.PrivateEndpointConnectionArgs>[]>;
/**
* This determines if traffic is allowed over public network. By default it is enabled.
*/
publicNetworkAccess?: pulumi.Input<string | enums.eventhub.PublicNetworkAccess>;
/**
* Name of the resource group within the azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Properties of sku resource
*/
sku?: pulumi.Input<inputs.eventhub.SkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.
*/
zoneRedundant?: pulumi.Input<boolean>;
}