1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. AzureKeyVaultConnector
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

harness.platform.AzureKeyVaultConnector

Explore with Pulumi AI

harness logo
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

    Example Usage

    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 pulumi
    import pulumi_harness as harness
    
    example = harness.platform.AzureKeyVaultConnector("example",
        identifier="identifier",
        name="name",
        description="example",
        tags=["foo:bar"],
        client_id="client_id",
        secret_key="account.secret_key",
        tenant_id="tenant_id",
        vault_name="vault_name",
        subscription="subscription",
        is_default=False,
        azure_environment_type="AZURE")
    
    package main
    
    import (
    	"github.com/pulumi/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{
    			Identifier:  pulumi.String("identifier"),
    			Name:        pulumi.String("name"),
    			Description: pulumi.String("example"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    			},
    			ClientId:             pulumi.String("client_id"),
    			SecretKey:            pulumi.String("account.secret_key"),
    			TenantId:             pulumi.String("tenant_id"),
    			VaultName:            pulumi.String("vault_name"),
    			Subscription:         pulumi.String("subscription"),
    			IsDefault:            pulumi.Bool(false),
    			AzureEnvironmentType: pulumi.String("AZURE"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Harness.Platform.AzureKeyVaultConnector("example", new()
        {
            Identifier = "identifier",
            Name = "name",
            Description = "example",
            Tags = new[]
            {
                "foo:bar",
            },
            ClientId = "client_id",
            SecretKey = "account.secret_key",
            TenantId = "tenant_id",
            VaultName = "vault_name",
            Subscription = "subscription",
            IsDefault = false,
            AzureEnvironmentType = "AZURE",
        });
    
    });
    
    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()
                .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")
                .build());
    
        }
    }
    
    resources:
      example:
        type: harness:platform:AzureKeyVaultConnector
        properties:
          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
    

    Create AzureKeyVaultConnector Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AzureKeyVaultConnector(name: string, args: AzureKeyVaultConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def AzureKeyVaultConnector(resource_name: str,
                               args: AzureKeyVaultConnectorArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def AzureKeyVaultConnector(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               secret_key: Optional[str] = None,
                               client_id: Optional[str] = None,
                               vault_name: Optional[str] = None,
                               tenant_id: Optional[str] = None,
                               identifier: Optional[str] = None,
                               subscription: Optional[str] = None,
                               description: Optional[str] = None,
                               org_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               name: Optional[str] = None,
                               is_default: Optional[bool] = None,
                               tags: Optional[Sequence[str]] = None,
                               azure_environment_type: Optional[str] = None,
                               delegate_selectors: Optional[Sequence[str]] = 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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureKeyVaultConnectorResource = new Harness.Platform.AzureKeyVaultConnector("azureKeyVaultConnectorResource", new()
    {
        SecretKey = "string",
        ClientId = "string",
        VaultName = "string",
        TenantId = "string",
        Identifier = "string",
        Subscription = "string",
        Description = "string",
        OrgId = "string",
        ProjectId = "string",
        Name = "string",
        IsDefault = false,
        Tags = new[]
        {
            "string",
        },
        AzureEnvironmentType = "string",
        DelegateSelectors = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewAzureKeyVaultConnector(ctx, "azureKeyVaultConnectorResource", &platform.AzureKeyVaultConnectorArgs{
    	SecretKey:    pulumi.String("string"),
    	ClientId:     pulumi.String("string"),
    	VaultName:    pulumi.String("string"),
    	TenantId:     pulumi.String("string"),
    	Identifier:   pulumi.String("string"),
    	Subscription: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	OrgId:        pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	IsDefault:    pulumi.Bool(false),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AzureEnvironmentType: pulumi.String("string"),
    	DelegateSelectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var azureKeyVaultConnectorResource = new AzureKeyVaultConnector("azureKeyVaultConnectorResource", AzureKeyVaultConnectorArgs.builder()
        .secretKey("string")
        .clientId("string")
        .vaultName("string")
        .tenantId("string")
        .identifier("string")
        .subscription("string")
        .description("string")
        .orgId("string")
        .projectId("string")
        .name("string")
        .isDefault(false)
        .tags("string")
        .azureEnvironmentType("string")
        .delegateSelectors("string")
        .build());
    
    azure_key_vault_connector_resource = harness.platform.AzureKeyVaultConnector("azureKeyVaultConnectorResource",
        secret_key="string",
        client_id="string",
        vault_name="string",
        tenant_id="string",
        identifier="string",
        subscription="string",
        description="string",
        org_id="string",
        project_id="string",
        name="string",
        is_default=False,
        tags=["string"],
        azure_environment_type="string",
        delegate_selectors=["string"])
    
    const azureKeyVaultConnectorResource = new harness.platform.AzureKeyVaultConnector("azureKeyVaultConnectorResource", {
        secretKey: "string",
        clientId: "string",
        vaultName: "string",
        tenantId: "string",
        identifier: "string",
        subscription: "string",
        description: "string",
        orgId: "string",
        projectId: "string",
        name: "string",
        isDefault: false,
        tags: ["string"],
        azureEnvironmentType: "string",
        delegateSelectors: ["string"],
    });
    
    type: harness:platform:AzureKeyVaultConnector
    properties:
        azureEnvironmentType: string
        clientId: string
        delegateSelectors:
            - string
        description: string
        identifier: string
        isDefault: false
        name: string
        orgId: string
        projectId: string
        secretKey: string
        subscription: string
        tags:
            - string
        tenantId: string
        vaultName: string
    

    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>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi