Key Args
data class KeyArgs(val isActiveCMK: Output<Boolean>? = null, val keyName: Output<String>? = null, val keyVaultUrl: Output<String>? = null, val resourceGroupName: Output<String>? = null, val workspaceName: Output<String>? = null) : ConvertibleToJava<KeyArgs>
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/#accessing-any-api-version-via-local-packages 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",
});
});
Content copied to clipboard
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
})
}
Content copied to clipboard
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());
}
}
Content copied to clipboard
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}
Content copied to clipboard
Constructors
Properties
Link copied to clipboard
Used to activate the workspace after a customer managed key is provided.
Link copied to clipboard
The Key Vault Url of the workspace key.
Link copied to clipboard
The name of the resource group. The name is case insensitive.
Link copied to clipboard
The name of the workspace.