Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Key

A workspace key Latest API Version: 2020-12-01.

Example Usage

Create or update a workspace key

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var key = new AzureNextGen.Synapse.Latest.Key("key", new AzureNextGen.Synapse.Latest.KeyArgs
        {
            IsActiveCMK = true,
            KeyName = "somekey",
            KeyVaultUrl = "https://vault.azure.net/keys/somesecret",
            ResourceGroupName = "ExampleResourceGroup",
            WorkspaceName = "ExampleWorkspace",
        });
    }

}
package main

import (
    synapse "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/synapse/latest"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := synapse.NewKey(ctx, "key", &synapse.KeyArgs{
            IsActiveCMK:       pulumi.Bool(true),
            KeyName:           pulumi.String("somekey"),
            KeyVaultUrl:       pulumi.String("https://vault.azure.net/keys/somesecret"),
            ResourceGroupName: pulumi.String("ExampleResourceGroup"),
            WorkspaceName:     pulumi.String("ExampleWorkspace"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

key = azure_nextgen.synapse.latest.Key("key",
    is_active_cmk=True,
    key_name="somekey",
    key_vault_url="https://vault.azure.net/keys/somesecret",
    resource_group_name="ExampleResourceGroup",
    workspace_name="ExampleWorkspace")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const key = new azure_nextgen.synapse.latest.Key("key", {
    isActiveCMK: true,
    keyName: "somekey",
    keyVaultUrl: "https://vault.azure.net/keys/somesecret",
    resourceGroupName: "ExampleResourceGroup",
    workspaceName: "ExampleWorkspace",
});

Create a Key Resource

new Key(name: string, args: KeyArgs, opts?: CustomResourceOptions);
def Key(resource_name: str, opts: Optional[ResourceOptions] = None, is_active_cmk: Optional[bool] = None, key_name: Optional[str] = None, key_vault_url: Optional[str] = None, resource_group_name: Optional[str] = None, workspace_name: Optional[str] = None)
func NewKey(ctx *Context, name string, args KeyArgs, opts ...ResourceOption) (*Key, error)
public Key(string name, KeyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args KeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Key Resource Properties

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

Inputs

The Key resource accepts the following input properties:

KeyName string
The name of the workspace key
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyVaultUrl string
The Key Vault Url of the workspace key.
KeyName string
The name of the workspace key
ResourceGroupName string
The name of the resource group. The name is case insensitive.
WorkspaceName string
The name of the workspace
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyVaultUrl string
The Key Vault Url of the workspace key.
keyName string
The name of the workspace key
resourceGroupName string
The name of the resource group. The name is case insensitive.
workspaceName string
The name of the workspace
isActiveCMK boolean
Used to activate the workspace after a customer managed key is provided.
keyVaultUrl string
The Key Vault Url of the workspace key.
key_name str
The name of the workspace key
resource_group_name str
The name of the resource group. The name is case insensitive.
workspace_name str
The name of the workspace
is_active_cmk bool
Used to activate the workspace after a customer managed key is provided.
key_vault_url str
The Key Vault Url of the workspace key.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-nextgen:synapse/latest:Key somekey /subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0