Azure Native v1.102.0, May 2 23

azure-native.sql.ServerKey

Explore with Pulumi AI

A server key. API Version: 2020-11-01-preview.

Example Usage

Creates or updates a server key

using System.Collections.Generic;
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 = "AzureKeyVault",
        ServerName = "sqlcrudtest-4645",
        Uri = "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
    });

});

package main

import (
	sql "github.com/pulumi/pulumi-azure-native/sdk/go/azure/sql"
	"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("AzureKeyVault"),
			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 pulumi
import pulumi_azure_native as azure_native

server_key = azure_native.sql.ServerKey("serverKey",
    key_name="someVault_someKey_01234567890123456789012345678901",
    resource_group_name="sqlcrudtest-7398",
    server_key_type="AzureKeyVault",
    server_name="sqlcrudtest-4645",
    uri="https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901")

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

const serverKey = new azure_native.sql.ServerKey("serverKey", {
    keyName: "someVault_someKey_01234567890123456789012345678901",
    resourceGroupName: "sqlcrudtest-7398",
    serverKeyType: "AzureKeyVault",
    serverName: "sqlcrudtest-4645",
    uri: "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
});

resources:
  serverKey:
    type: azure-native:sql:ServerKey
    properties:
      keyName: someVault_someKey_01234567890123456789012345678901
      resourceGroupName: sqlcrudtest-7398
      serverKeyType: AzureKeyVault
      serverName: sqlcrudtest-4645
      uri: https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901

Create ServerKey Resource

new ServerKey(name: string, args: ServerKeyArgs, opts?: CustomResourceOptions);

@overload
def ServerKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              key_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              server_key_type: Optional[Union[str, ServerKeyType]] = None,
              server_name: Optional[str] = None,
              uri: Optional[str] = None)
@overload
def ServerKey(resource_name: str,
              args: ServerKeyArgs,
              opts: Optional[ResourceOptions] = None)

func NewServerKey(ctx *Context, name string, args ServerKeyArgs, opts ...ResourceOption) (*ServerKey, error)

public ServerKey(string name, ServerKeyArgs args, CustomResourceOptions? opts = null)

public ServerKey(String name, ServerKeyArgs args)
public ServerKey(String name, ServerKeyArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args ServerKeyArgs: 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 ServerKeyArgs: 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 ServerKeyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServerKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServerKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ServerKey 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 ServerKey resource accepts the following input properties:

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerKeyType string | Pulumi.AzureNative.Sql.ServerKeyType: The server key type like 'ServiceManaged', 'AzureKeyVault'.
ServerName string: The name of the server.
KeyName string: 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
Uri string: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerKeyType string | ServerKeyType: The server key type like 'ServiceManaged', 'AzureKeyVault'.
ServerName string: The name of the server.
KeyName string: 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
Uri string: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverKeyType String | ServerKeyType: The server key type like 'ServiceManaged', 'AzureKeyVault'.
serverName String: The name of the server.
keyName String: 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
uri String: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

resourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverKeyType string | ServerKeyType: The server key type like 'ServiceManaged', 'AzureKeyVault'.
serverName string: The name of the server.
keyName string: 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
uri string: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

resource_group_name str: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_key_type str | ServerKeyType: The server key type like 'ServiceManaged', 'AzureKeyVault'.
server_name str: The name of the server.
key_name str: 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
uri str: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverKeyType String | "ServiceManaged" | "AzureKeyVault": The server key type like 'ServiceManaged', 'AzureKeyVault'.
serverName String: The name of the server.
keyName String: 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
uri String: The URI of the server key. If the ServerKeyType is AzureKeyVault, then the URI is required.

Outputs

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

AutoRotationEnabled bool: Key auto rotation opt-in flag. Either true or false.
CreationDate string: The server key creation date.
Id string: The provider-assigned unique ID for this managed resource.
Kind string: Kind of encryption protector. This is metadata used for the Azure portal experience.
Location string: Resource location.
Name string: Resource name.
Subregion string: Subregion of the server key.
Thumbprint string: Thumbprint of the server key.
Type string: Resource type.

AutoRotationEnabled bool: Key auto rotation opt-in flag. Either true or false.
CreationDate string: The server key creation date.
Id string: The provider-assigned unique ID for this managed resource.
Kind string: Kind of encryption protector. This is metadata used for the Azure portal experience.
Location string: Resource location.
Name string: Resource name.
Subregion string: Subregion of the server key.
Thumbprint string: Thumbprint of the server key.
Type string: Resource type.

autoRotationEnabled Boolean: Key auto rotation opt-in flag. Either true or false.
creationDate String: The server key creation date.
id String: The provider-assigned unique ID for this managed resource.
kind String: Kind of encryption protector. This is metadata used for the Azure portal experience.
location String: Resource location.
name String: Resource name.
subregion String: Subregion of the server key.
thumbprint String: Thumbprint of the server key.
type String: Resource type.

autoRotationEnabled boolean: Key auto rotation opt-in flag. Either true or false.
creationDate string: The server key creation date.
id string: The provider-assigned unique ID for this managed resource.
kind string: Kind of encryption protector. This is metadata used for the Azure portal experience.
location string: Resource location.
name string: Resource name.
subregion string: Subregion of the server key.
thumbprint string: Thumbprint of the server key.
type string: Resource type.

auto_rotation_enabled bool: Key auto rotation opt-in flag. Either true or false.
creation_date str: The server key creation date.
id str: The provider-assigned unique ID for this managed resource.
kind str: Kind of encryption protector. This is metadata used for the Azure portal experience.
location str: Resource location.
name str: Resource name.
subregion str: Subregion of the server key.
thumbprint str: Thumbprint of the server key.
type str: Resource type.

autoRotationEnabled Boolean: Key auto rotation opt-in flag. Either true or false.
creationDate String: The server key creation date.
id String: The provider-assigned unique ID for this managed resource.
kind String: Kind of encryption protector. This is metadata used for the Azure portal experience.
location String: Resource location.
name String: Resource name.
subregion String: Subregion of the server key.
thumbprint String: Thumbprint of the server key.
type String: Resource type.

Supporting Types

ServerKeyType

ServiceManaged: ServiceManaged
AzureKeyVault: AzureKeyVault

ServerKeyTypeServiceManaged: ServiceManaged
ServerKeyTypeAzureKeyVault: AzureKeyVault

ServiceManaged: ServiceManaged
AzureKeyVault: AzureKeyVault

ServiceManaged: ServiceManaged
AzureKeyVault: AzureKeyVault

SERVICE_MANAGED: ServiceManaged
AZURE_KEY_VAULT: AzureKeyVault

"ServiceManaged": ServiceManaged
"AzureKeyVault": AzureKeyVault

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/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0