ServerKeyArgs

data class ServerKeyArgs(val keyName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serverKeyType: Output<Either<String, ServerKeyType>>? = null, val serverName: Output<String>? = null, val uri: Output<String>? = null) : ConvertibleToJava<ServerKeyArgs>

A server key. Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2021-11-01. Other available API versions: 2015-05-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Creates or updates a server key

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var serverKey = new AzureNative.Sql.ServerKey("serverKey", new()
{
KeyName = "someVault_someKey_01234567890123456789012345678901",
ResourceGroupName = "sqlcrudtest-7398",
ServerKeyType = AzureNative.Sql.ServerKeyType.AzureKeyVault,
ServerName = "sqlcrudtest-4645",
Uri = "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
});
});
package main
import (
sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sql.NewServerKey(ctx, "serverKey", &sql.ServerKeyArgs{
KeyName: pulumi.String("someVault_someKey_01234567890123456789012345678901"),
ResourceGroupName: pulumi.String("sqlcrudtest-7398"),
ServerKeyType: pulumi.String(sql.ServerKeyTypeAzureKeyVault),
ServerName: pulumi.String("sqlcrudtest-4645"),
Uri: pulumi.String("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
})
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.sql.ServerKey;
import com.pulumi.azurenative.sql.ServerKeyArgs;
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 serverKey = new ServerKey("serverKey", ServerKeyArgs.builder()
.keyName("someVault_someKey_01234567890123456789012345678901")
.resourceGroupName("sqlcrudtest-7398")
.serverKeyType("AzureKeyVault")
.serverName("sqlcrudtest-4645")
.uri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901")
.build());
}
}

Import

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

$ pulumi import azure-native:sql:ServerKey sqlcrudtest-4645 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}

Constructors

Link copied to clipboard
constructor(keyName: Output<String>? = null, resourceGroupName: Output<String>? = null, serverKeyType: Output<Either<String, ServerKeyType>>? = null, serverName: Output<String>? = null, uri: Output<String>? = null)

Properties

Link copied to clipboard
val keyName: Output<String>? = null

The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Link copied to clipboard
val serverKeyType: Output<Either<String, ServerKeyType>>? = null

The server key type like 'ServiceManaged', 'AzureKeyVault'.

Link copied to clipboard
val serverName: Output<String>? = null

The name of the server.

Link copied to clipboard
val uri: Output<String>? = null

The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required. The AKV URI is required to be in this format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Functions

Link copied to clipboard
open override fun toJava(): ServerKeyArgs