@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Description of hybrid connection resource.
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01.
*
* Other available API versions: 2021-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native relay [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class HybridConnection extends pulumi.CustomResource {
/**
* Get an existing HybridConnection 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): HybridConnection;
/**
* Returns true if the given object is an instance of HybridConnection. 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 HybridConnection;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The time the hybrid connection was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
*/
readonly listenerCount: pulumi.Output<number>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Returns true if client authorization is needed for this hybrid connection; otherwise, false.
*/
readonly requiresClientAuthorization: pulumi.Output<boolean | undefined>;
/**
* The system meta data relating to this resource.
*/
readonly systemData: pulumi.Output<outputs.relay.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
*/
readonly type: pulumi.Output<string>;
/**
* The time the namespace was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
*/
readonly userMetadata: pulumi.Output<string | undefined>;
/**
* Create a HybridConnection 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: HybridConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a HybridConnection resource.
*/
export interface HybridConnectionArgs {
/**
* The hybrid connection name.
*/
hybridConnectionName?: pulumi.Input<string>;
/**
* The namespace name
*/
namespaceName: pulumi.Input<string>;
/**
* Returns true if client authorization is needed for this hybrid connection; otherwise, false.
*/
requiresClientAuthorization?: pulumi.Input<boolean>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The usermetadata is a placeholder to store user-defined string data for the hybrid connection endpoint. For example, it can be used to store descriptive data, such as a list of teams and their contact information. Also, user-defined configuration settings can be stored.
*/
userMetadata?: pulumi.Input<string>;
}