1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. AzureKeyVaultConnector
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

harness.platform.AzureKeyVaultConnector

Explore with Pulumi AI

harness logo
Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs

    Resource for creating an Azure key vault in Harness.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Lbrlabs.PulumiPackage.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.AzureKeyVaultConnector("example", new()
        {
            AzureEnvironmentType = "AZURE",
            ClientId = "client_id",
            Description = "example",
            Identifier = "identifier",
            IsDefault = false,
            SecretKey = "account.secret_key",
            Subscription = "subscription",
            Tags = new[]
            {
                "foo:bar",
            },
            TenantId = "tenant_id",
            VaultName = "vault_name",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewAzureKeyVaultConnector(ctx, "example", &platform.AzureKeyVaultConnectorArgs{
    			AzureEnvironmentType: pulumi.String("AZURE"),
    			ClientId:             pulumi.String("client_id"),
    			Description:          pulumi.String("example"),
    			Identifier:           pulumi.String("identifier"),
    			IsDefault:            pulumi.Bool(false),
    			SecretKey:            pulumi.String("account.secret_key"),
    			Subscription:         pulumi.String("subscription"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    			TenantId:  pulumi.String("tenant_id"),
    			VaultName: pulumi.String("vault_name"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.AzureKeyVaultConnector;
    import com.pulumi.harness.platform.AzureKeyVaultConnectorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new AzureKeyVaultConnector("example", AzureKeyVaultConnectorArgs.builder()        
                .azureEnvironmentType("AZURE")
                .clientId("client_id")
                .description("example")
                .identifier("identifier")
                .isDefault(false)
                .secretKey("account.secret_key")
                .subscription("subscription")
                .tags("foo:bar")
                .tenantId("tenant_id")
                .vaultName("vault_name")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_harness as harness
    
    example = harness.platform.AzureKeyVaultConnector("example",
        azure_environment_type="AZURE",
        client_id="client_id",
        description="example",
        identifier="identifier",
        is_default=False,
        secret_key="account.secret_key",
        subscription="subscription",
        tags=["foo:bar"],
        tenant_id="tenant_id",
        vault_name="vault_name")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@lbrlabs/pulumi-harness";
    
    const example = new harness.platform.AzureKeyVaultConnector("example", {
        azureEnvironmentType: "AZURE",
        clientId: "client_id",
        description: "example",
        identifier: "identifier",
        isDefault: false,
        secretKey: "account.secret_key",
        subscription: "subscription",
        tags: ["foo:bar"],
        tenantId: "tenant_id",
        vaultName: "vault_name",
    });
    
    resources:
      example:
        type: harness:platform:AzureKeyVaultConnector
        properties:
          azureEnvironmentType: AZURE
          clientId: client_id
          description: example
          identifier: identifier
          isDefault: false
          secretKey: account.secret_key
          subscription: subscription
          tags:
            - foo:bar
          tenantId: tenant_id
          vaultName: vault_name
    

    Create AzureKeyVaultConnector Resource

    new AzureKeyVaultConnector(name: string, args: AzureKeyVaultConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def AzureKeyVaultConnector(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               azure_environment_type: Optional[str] = None,
                               client_id: Optional[str] = None,
                               delegate_selectors: Optional[Sequence[str]] = None,
                               description: Optional[str] = None,
                               identifier: Optional[str] = None,
                               is_default: Optional[bool] = None,
                               name: Optional[str] = None,
                               org_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               secret_key: Optional[str] = None,
                               subscription: Optional[str] = None,
                               tags: Optional[Sequence[str]] = None,
                               tenant_id: Optional[str] = None,
                               vault_name: Optional[str] = None)
    @overload
    def AzureKeyVaultConnector(resource_name: str,
                               args: AzureKeyVaultConnectorArgs,
                               opts: Optional[ResourceOptions] = None)
    func NewAzureKeyVaultConnector(ctx *Context, name string, args AzureKeyVaultConnectorArgs, opts ...ResourceOption) (*AzureKeyVaultConnector, error)
    public AzureKeyVaultConnector(string name, AzureKeyVaultConnectorArgs args, CustomResourceOptions? opts = null)
    public AzureKeyVaultConnector(String name, AzureKeyVaultConnectorArgs args)
    public AzureKeyVaultConnector(String name, AzureKeyVaultConnectorArgs args, CustomResourceOptions options)
    
    type: harness:platform:AzureKeyVaultConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AzureKeyVaultConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AzureKeyVaultConnectorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AzureKeyVaultConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureKeyVaultConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureKeyVaultConnectorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AzureKeyVaultConnector Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AzureKeyVaultConnector resource accepts the following input properties:

    ClientId string

    Application ID of the Azure App.

    Identifier string

    Unique identifier of the resource.

    SecretKey string

    The Harness text secret with the Azure authentication key as its value.

    Subscription string

    Azure subscription ID.

    TenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    VaultName string

    Name of the vault.

    AzureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    DelegateSelectors List<string>

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    IsDefault bool

    Specifies whether or not is the default value.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags List<string>

    Tags to associate with the resource.

    ClientId string

    Application ID of the Azure App.

    Identifier string

    Unique identifier of the resource.

    SecretKey string

    The Harness text secret with the Azure authentication key as its value.

    Subscription string

    Azure subscription ID.

    TenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    VaultName string

    Name of the vault.

    AzureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    DelegateSelectors []string

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    IsDefault bool

    Specifies whether or not is the default value.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    Tags []string

    Tags to associate with the resource.

    clientId String

    Application ID of the Azure App.

    identifier String

    Unique identifier of the resource.

    secretKey String

    The Harness text secret with the Azure authentication key as its value.

    subscription String

    Azure subscription ID.

    tenantId String

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName String

    Name of the vault.

    azureEnvironmentType String

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    isDefault Boolean

    Specifies whether or not is the default value.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    clientId string

    Application ID of the Azure App.

    identifier string

    Unique identifier of the resource.

    secretKey string

    The Harness text secret with the Azure authentication key as its value.

    subscription string

    Azure subscription ID.

    tenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName string

    Name of the vault.

    azureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    delegateSelectors string[]

    Tags to filter delegates for connection.

    description string

    Description of the resource.

    isDefault boolean

    Specifies whether or not is the default value.

    name string

    Name of the resource.

    orgId string

    Unique identifier of the organization.

    projectId string

    Unique identifier of the project.

    tags string[]

    Tags to associate with the resource.

    client_id str

    Application ID of the Azure App.

    identifier str

    Unique identifier of the resource.

    secret_key str

    The Harness text secret with the Azure authentication key as its value.

    subscription str

    Azure subscription ID.

    tenant_id str

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vault_name str

    Name of the vault.

    azure_environment_type str

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    delegate_selectors Sequence[str]

    Tags to filter delegates for connection.

    description str

    Description of the resource.

    is_default bool

    Specifies whether or not is the default value.

    name str

    Name of the resource.

    org_id str

    Unique identifier of the organization.

    project_id str

    Unique identifier of the project.

    tags Sequence[str]

    Tags to associate with the resource.

    clientId String

    Application ID of the Azure App.

    identifier String

    Unique identifier of the resource.

    secretKey String

    The Harness text secret with the Azure authentication key as its value.

    subscription String

    Azure subscription ID.

    tenantId String

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName String

    Name of the vault.

    azureEnvironmentType String

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    isDefault Boolean

    Specifies whether or not is the default value.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    tags List<String>

    Tags to associate with the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AzureKeyVaultConnector resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing AzureKeyVaultConnector Resource

    Get an existing AzureKeyVaultConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AzureKeyVaultConnectorState, opts?: CustomResourceOptions): AzureKeyVaultConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            azure_environment_type: Optional[str] = None,
            client_id: Optional[str] = None,
            delegate_selectors: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            identifier: Optional[str] = None,
            is_default: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            secret_key: Optional[str] = None,
            subscription: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            tenant_id: Optional[str] = None,
            vault_name: Optional[str] = None) -> AzureKeyVaultConnector
    func GetAzureKeyVaultConnector(ctx *Context, name string, id IDInput, state *AzureKeyVaultConnectorState, opts ...ResourceOption) (*AzureKeyVaultConnector, error)
    public static AzureKeyVaultConnector Get(string name, Input<string> id, AzureKeyVaultConnectorState? state, CustomResourceOptions? opts = null)
    public static AzureKeyVaultConnector get(String name, Output<String> id, AzureKeyVaultConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AzureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    ClientId string

    Application ID of the Azure App.

    DelegateSelectors List<string>

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Identifier string

    Unique identifier of the resource.

    IsDefault bool

    Specifies whether or not is the default value.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    SecretKey string

    The Harness text secret with the Azure authentication key as its value.

    Subscription string

    Azure subscription ID.

    Tags List<string>

    Tags to associate with the resource.

    TenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    VaultName string

    Name of the vault.

    AzureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    ClientId string

    Application ID of the Azure App.

    DelegateSelectors []string

    Tags to filter delegates for connection.

    Description string

    Description of the resource.

    Identifier string

    Unique identifier of the resource.

    IsDefault bool

    Specifies whether or not is the default value.

    Name string

    Name of the resource.

    OrgId string

    Unique identifier of the organization.

    ProjectId string

    Unique identifier of the project.

    SecretKey string

    The Harness text secret with the Azure authentication key as its value.

    Subscription string

    Azure subscription ID.

    Tags []string

    Tags to associate with the resource.

    TenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    VaultName string

    Name of the vault.

    azureEnvironmentType String

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    clientId String

    Application ID of the Azure App.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    identifier String

    Unique identifier of the resource.

    isDefault Boolean

    Specifies whether or not is the default value.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    secretKey String

    The Harness text secret with the Azure authentication key as its value.

    subscription String

    Azure subscription ID.

    tags List<String>

    Tags to associate with the resource.

    tenantId String

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName String

    Name of the vault.

    azureEnvironmentType string

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    clientId string

    Application ID of the Azure App.

    delegateSelectors string[]

    Tags to filter delegates for connection.

    description string

    Description of the resource.

    identifier string

    Unique identifier of the resource.

    isDefault boolean

    Specifies whether or not is the default value.

    name string

    Name of the resource.

    orgId string

    Unique identifier of the organization.

    projectId string

    Unique identifier of the project.

    secretKey string

    The Harness text secret with the Azure authentication key as its value.

    subscription string

    Azure subscription ID.

    tags string[]

    Tags to associate with the resource.

    tenantId string

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName string

    Name of the vault.

    azure_environment_type str

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    client_id str

    Application ID of the Azure App.

    delegate_selectors Sequence[str]

    Tags to filter delegates for connection.

    description str

    Description of the resource.

    identifier str

    Unique identifier of the resource.

    is_default bool

    Specifies whether or not is the default value.

    name str

    Name of the resource.

    org_id str

    Unique identifier of the organization.

    project_id str

    Unique identifier of the project.

    secret_key str

    The Harness text secret with the Azure authentication key as its value.

    subscription str

    Azure subscription ID.

    tags Sequence[str]

    Tags to associate with the resource.

    tenant_id str

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vault_name str

    Name of the vault.

    azureEnvironmentType String

    Azure environment type. Possible values: AZURE or AZUREUSGOVERNMENT. Default value: AZURE

    clientId String

    Application ID of the Azure App.

    delegateSelectors List<String>

    Tags to filter delegates for connection.

    description String

    Description of the resource.

    identifier String

    Unique identifier of the resource.

    isDefault Boolean

    Specifies whether or not is the default value.

    name String

    Name of the resource.

    orgId String

    Unique identifier of the organization.

    projectId String

    Unique identifier of the project.

    secretKey String

    The Harness text secret with the Azure authentication key as its value.

    subscription String

    Azure subscription ID.

    tags List<String>

    Tags to associate with the resource.

    tenantId String

    The Azure Active Directory (Azure AD) directory ID where you created your application.

    vaultName String

    Name of the vault.

    Import

    Import account level azure key vault connector

     $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <connector_id>
    

    Import org level azure key vault connector

     $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <ord_id>/<connector_id>
    

    Import project level azure key vault connector

     $ pulumi import harness:platform/azureKeyVaultConnector:AzureKeyVaultConnector example <org_id>/<project_id>/<connector_id>
    

    Package Details

    Repository
    harness lbrlabs/pulumi-harness
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the harness Terraform Provider.

    harness logo
    Harness v0.0.6 published on Saturday, Jul 1, 2023 by lbrlabs