import * as pulumi from "@pulumi/pulumi"; /** * Manages an API Connection. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const exampleResourceGroup = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const example = azure.connections.getManagedApiOutput({ * name: "servicebus", * location: exampleResourceGroup.location, * }); * const exampleNamespace = new azure.servicebus.Namespace("example", { * name: "example-namespace", * location: exampleResourceGroup.location, * resourceGroupName: exampleResourceGroup.name, * sku: "Basic", * }); * const exampleApiConnection = new azure.connections.ApiConnection("example", { * name: "example-connection", * resourceGroupName: exampleResourceGroup.name, * managedApiId: example.apply(example => example.id), * displayName: "Example 1", * parameterValues: { * connectionString: exampleNamespace.defaultPrimaryConnectionString, * }, * tags: { * Hello: "World", * }, * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Web` - 2016-06-01 * * ## Import * * API Connections can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:connections/apiConnection:ApiConnection example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example/providers/Microsoft.Web/connections/example-connection * ``` */ export declare class ApiConnection extends pulumi.CustomResource { /** * Get an existing ApiConnection 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ApiConnectionState, opts?: pulumi.CustomResourceOptions): ApiConnection; /** * Returns true if the given object is an instance of ApiConnection. 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 ApiConnection; /** * A display name for this API Connection. */ readonly displayName: pulumi.Output; /** * The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. */ readonly managedApiId: pulumi.Output; /** * The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. */ readonly name: pulumi.Output; /** * A map of parameter values associated with this API Connection. * * > **Note:** The Azure API doesn't return sensitive parameters in the API response which can lead to a diff, as such you may need to use Terraform's `ignoreChanges` functionality on this field as shown in the Example Usage above. */ readonly parameterValues: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. */ readonly resourceGroupName: pulumi.Output; /** * A mapping of tags which should be assigned to the API Connection. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Create a ApiConnection 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: ApiConnectionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ApiConnection resources. */ export interface ApiConnectionState { /** * A display name for this API Connection. */ displayName?: pulumi.Input; /** * The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. */ managedApiId?: pulumi.Input; /** * The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. */ name?: pulumi.Input; /** * A map of parameter values associated with this API Connection. * * > **Note:** The Azure API doesn't return sensitive parameters in the API response which can lead to a diff, as such you may need to use Terraform's `ignoreChanges` functionality on this field as shown in the Example Usage above. */ parameterValues?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. */ resourceGroupName?: pulumi.Input; /** * A mapping of tags which should be assigned to the API Connection. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; } /** * The set of arguments for constructing a ApiConnection resource. */ export interface ApiConnectionArgs { /** * A display name for this API Connection. */ displayName?: pulumi.Input; /** * The ID of the Managed API which this API Connection is linked to. Changing this forces a new API Connection to be created. */ managedApiId: pulumi.Input; /** * The Name which should be used for this API Connection. Changing this forces a new API Connection to be created. */ name?: pulumi.Input; /** * A map of parameter values associated with this API Connection. * * > **Note:** The Azure API doesn't return sensitive parameters in the API response which can lead to a diff, as such you may need to use Terraform's `ignoreChanges` functionality on this field as shown in the Example Usage above. */ parameterValues?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The name of the Resource Group where this API Connection should exist. Changing this forces a new API Connection to be created. */ resourceGroupName: pulumi.Input; /** * A mapping of tags which should be assigned to the API Connection. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; }