Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. Key
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.Key

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    A workspace key Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2021-06-01-preview.

    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",
    });

});

    package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"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
	})
}

    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());

    }
}

    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")

    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",
});

    resources:
  key:
    type: azure-native:synapse:Key
    properties:
      isActiveCMK: true
      keyName: somekey
      keyVaultUrl: https://vault.azure.net/keys/somesecret
      resourceGroupName: ExampleResourceGroup
      workspaceName: ExampleWorkspace

    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 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.
    args 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 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.
    name String
    The unique name of the resource.
    args 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",
});

    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"),
})

    var azure_nativeKeyResource = new Key("azure-nativeKeyResource", KeyArgs.builder()
    .resourceGroupName("string")
    .workspaceName("string")
    .isActiveCMK(false)
    .keyName("string")
    .keyVaultUrl("string")
    .build());

    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")

    const azure_nativeKeyResource = new azure_native.synapse.Key("azure-nativeKeyResource", {
    resourceGroupName: "string",
    workspaceName: "string",
    isActiveCMK: false,
    keyName: "string",
    keyVaultUrl: "string",
});

    type: azure-native:synapse:Key
properties:
    isActiveCMK: false
    keyName: string
    keyVaultUrl: string
    resourceGroupName: string
    workspaceName: string

    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

    The Key resource accepts the following input properties:

    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.
    KeyName string
    The name of the workspace key
    KeyVaultUrl string
    The Key Vault Url 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.
    KeyName string
    The name of the workspace key
    KeyVaultUrl string
    The Key Vault Url 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.
    keyName String
    The name of the workspace key
    keyVaultUrl String
    The Key Vault Url 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.
    keyName string
    The name of the workspace key
    keyVaultUrl string
    The Key Vault Url 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_name str
    The name of the workspace key
    key_vault_url str
    The Key Vault Url 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.
    keyName String
    The name of the workspace key
    keyVaultUrl 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:

    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 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"
    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}

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native