Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. Key
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.Key

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

A workspace key

Uses Azure REST API version 2021-06-01. In version 2.x of the Azure Native provider, it used API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Example Usage

Create or update a workspace key

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var key = new AzureNative.Synapse.Key("key", new()
    {
        IsActiveCMK = true,
        KeyName = "somekey",
        KeyVaultUrl = "https://vault.azure.net/keys/somesecret",
        ResourceGroupName = "ExampleResourceGroup",
        WorkspaceName = "ExampleWorkspace",
    });

});
Copy
package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v3"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.Key;
import com.pulumi.azurenative.synapse.KeyArgs;
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 key = new Key("key", KeyArgs.builder()
            .isActiveCMK(true)
            .keyName("somekey")
            .keyVaultUrl("https://vault.azure.net/keys/somesecret")
            .resourceGroupName("ExampleResourceGroup")
            .workspaceName("ExampleWorkspace")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const key = new azure_native.synapse.Key("key", {
    isActiveCMK: true,
    keyName: "somekey",
    keyVaultUrl: "https://vault.azure.net/keys/somesecret",
    resourceGroupName: "ExampleResourceGroup",
    workspaceName: "ExampleWorkspace",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

key = azure_native.synapse.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")
Copy
resources:
  key:
    type: azure-native:synapse:Key
    properties:
      isActiveCMK: true
      keyName: somekey
      keyVaultUrl: https://vault.azure.net/keys/somesecret
      resourceGroupName: ExampleResourceGroup
      workspaceName: ExampleWorkspace
Copy

Create Key Resource

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

Constructor syntax

new Key(name: string, args: KeyArgs, opts?: CustomResourceOptions);
@overload
def Key(resource_name: str,
        args: KeyArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def Key(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        resource_group_name: Optional[str] = None,
        workspace_name: Optional[str] = None,
        is_active_cmk: Optional[bool] = None,
        key_name: Optional[str] = None,
        key_vault_url: Optional[str] = None)
func NewKey(ctx *Context, name string, args KeyArgs, opts ...ResourceOption) (*Key, error)
public Key(string name, KeyArgs args, CustomResourceOptions? opts = null)
public Key(String name, KeyArgs args)
public Key(String name, KeyArgs args, CustomResourceOptions options)

type: azure-native:synapse:Key
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KeyArgs
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 azure_nativeKeyResource = new AzureNative.Synapse.Key("azure-nativeKeyResource", new()
{
    ResourceGroupName = "string",
    WorkspaceName = "string",
    IsActiveCMK = false,
    KeyName = "string",
    KeyVaultUrl = "string",
});
Copy
example, err := synapse.NewKey(ctx, "azure-nativeKeyResource", &synapse.KeyArgs{
	ResourceGroupName: pulumi.String("string"),
	WorkspaceName:     pulumi.String("string"),
	IsActiveCMK:       pulumi.Bool(false),
	KeyName:           pulumi.String("string"),
	KeyVaultUrl:       pulumi.String("string"),
})
Copy
var azure_nativeKeyResource = new Key("azure-nativeKeyResource", KeyArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .isActiveCMK(false)
    .keyName("string")
    .keyVaultUrl("string")
    .build());
Copy
azure_native_key_resource = azure_native.synapse.Key("azure-nativeKeyResource",
    resource_group_name="string",
    workspace_name="string",
    is_active_cmk=False,
    key_name="string",
    key_vault_url="string")
Copy
const azure_nativeKeyResource = new azure_native.synapse.Key("azure-nativeKeyResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    isActiveCMK: false,
    keyName: "string",
    keyVaultUrl: "string",
});
Copy
type: azure-native:synapse:Key
properties:
    isActiveCMK: false
    keyName: string
    keyVaultUrl: string
    resourceGroupName: string
    workspaceName: string
Copy

Key Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Key resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyName Changes to this property will trigger replacement. string
The name of the workspace key
KeyVaultUrl Changes to this property will trigger replacement. string
The Key Vault Url of the workspace key.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
IsActiveCMK bool
Used to activate the workspace after a customer managed key is provided.
KeyName Changes to this property will trigger replacement. string
The name of the workspace key
KeyVaultUrl Changes to this property will trigger replacement. string
The Key Vault Url of the workspace key.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
isActiveCMK Boolean
Used to activate the workspace after a customer managed key is provided.
keyName Changes to this property will trigger replacement. String
The name of the workspace key
keyVaultUrl Changes to this property will trigger replacement. String
The Key Vault Url of the workspace key.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
isActiveCMK boolean
Used to activate the workspace after a customer managed key is provided.
keyName Changes to this property will trigger replacement. string
The name of the workspace key
keyVaultUrl Changes to this property will trigger replacement. string
The Key Vault Url of the workspace key.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
is_active_cmk bool
Used to activate the workspace after a customer managed key is provided.
key_name Changes to this property will trigger replacement. str
The name of the workspace key
key_vault_url Changes to this property will trigger replacement. str
The Key Vault Url of the workspace key.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
isActiveCMK Boolean
Used to activate the workspace after a customer managed key is provided.
keyName Changes to this property will trigger replacement. String
The name of the workspace key
keyVaultUrl Changes to this property will trigger replacement. String
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:

AzureApiVersion string
The Azure API version of the resource.
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"
AzureApiVersion string
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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"
azureApiVersion string
The Azure API version of the resource.
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"
azure_api_version str
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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"

Import

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

$ pulumi import azure-native:synapse:Key somekey /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native