@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
251 lines (250 loc) • 7.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for creating an Azure key vault in Harness.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@pulumi/harness";
*
* const example = new harness.platform.AzureKeyVaultConnector("example", {
* identifier: "identifier",
* name: "name",
* description: "example",
* tags: ["foo:bar"],
* clientId: "client_id",
* secretKey: "account.secret_key",
* tenantId: "tenant_id",
* vaultName: "vault_name",
* subscription: "subscription",
* isDefault: false,
* azureEnvironmentType: "AZURE",
* });
* ```
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import account level azure key vault connector
*
* ```sh
* $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <connector_id>
* ```
*
* Import org level azure key vault connector
*
* ```sh
* $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <ord_id>/<connector_id>
* ```
*
* Import project level azure key vault connector
*
* ```sh
* $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <org_id>/<project_id>/<connector_id>
* ```
*/
export declare class AzureKeyVaultConnector extends pulumi.CustomResource {
/**
* Get an existing AzureKeyVaultConnector 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<pulumi.ID>, state?: AzureKeyVaultConnectorState, opts?: pulumi.CustomResourceOptions): AzureKeyVaultConnector;
/**
* Returns true if the given object is an instance of AzureKeyVaultConnector. 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 AzureKeyVaultConnector;
/**
* Azure environment type. Possible values: AZURE or AZURE*US*GOVERNMENT. Default value: AZURE
*/
readonly azureEnvironmentType: pulumi.Output<string>;
/**
* Application ID of the Azure App.
*/
readonly clientId: pulumi.Output<string>;
/**
* Tags to filter delegates for connection.
*/
readonly delegateSelectors: pulumi.Output<string[] | undefined>;
/**
* Description of the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Unique identifier of the resource.
*/
readonly identifier: pulumi.Output<string>;
/**
* Specifies whether or not is the default value.
*/
readonly isDefault: pulumi.Output<boolean | undefined>;
/**
* Name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* Unique identifier of the organization.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Unique identifier of the project.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* The Harness text secret with the Azure authentication key as its value.
*/
readonly secretKey: pulumi.Output<string>;
/**
* Azure subscription ID.
*/
readonly subscription: pulumi.Output<string>;
/**
* Tags to associate with the resource.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The Azure Active Directory (Azure AD) directory ID where you created your application.
*/
readonly tenantId: pulumi.Output<string>;
/**
* Name of the vault.
*/
readonly vaultName: pulumi.Output<string>;
/**
* Create a AzureKeyVaultConnector 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: AzureKeyVaultConnectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AzureKeyVaultConnector resources.
*/
export interface AzureKeyVaultConnectorState {
/**
* Azure environment type. Possible values: AZURE or AZURE*US*GOVERNMENT. Default value: AZURE
*/
azureEnvironmentType?: pulumi.Input<string>;
/**
* Application ID of the Azure App.
*/
clientId?: pulumi.Input<string>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier?: pulumi.Input<string>;
/**
* Specifies whether or not is the default value.
*/
isDefault?: pulumi.Input<boolean>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The Harness text secret with the Azure authentication key as its value.
*/
secretKey?: pulumi.Input<string>;
/**
* Azure subscription ID.
*/
subscription?: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The Azure Active Directory (Azure AD) directory ID where you created your application.
*/
tenantId?: pulumi.Input<string>;
/**
* Name of the vault.
*/
vaultName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AzureKeyVaultConnector resource.
*/
export interface AzureKeyVaultConnectorArgs {
/**
* Azure environment type. Possible values: AZURE or AZURE*US*GOVERNMENT. Default value: AZURE
*/
azureEnvironmentType?: pulumi.Input<string>;
/**
* Application ID of the Azure App.
*/
clientId: pulumi.Input<string>;
/**
* Tags to filter delegates for connection.
*/
delegateSelectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the resource.
*/
description?: pulumi.Input<string>;
/**
* Unique identifier of the resource.
*/
identifier: pulumi.Input<string>;
/**
* Specifies whether or not is the default value.
*/
isDefault?: pulumi.Input<boolean>;
/**
* Name of the resource.
*/
name?: pulumi.Input<string>;
/**
* Unique identifier of the organization.
*/
orgId?: pulumi.Input<string>;
/**
* Unique identifier of the project.
*/
projectId?: pulumi.Input<string>;
/**
* The Harness text secret with the Azure authentication key as its value.
*/
secretKey: pulumi.Input<string>;
/**
* Azure subscription ID.
*/
subscription: pulumi.Input<string>;
/**
* Tags to associate with the resource.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The Azure Active Directory (Azure AD) directory ID where you created your application.
*/
tenantId: pulumi.Input<string>;
/**
* Name of the vault.
*/
vaultName: pulumi.Input<string>;
}