1. Packages
  2. OVH
  3. API Docs
  4. Okms
  5. getOkmsServiceKey
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.Okms.getOkmsServiceKey

ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Use this data source to retrieve information about a KMS service key.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const keyInfo = ovh.Okms.getOkmsServiceKey({
    okmsId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
});

    import pulumi
import pulumi_ovh as ovh

key_info = ovh.Okms.get_okms_service_key(okms_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/okms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okms.GetOkmsServiceKey(ctx, &okms.GetOkmsServiceKeyArgs{
			OkmsId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			Id:     "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var keyInfo = Ovh.Okms.GetOkmsServiceKey.Invoke(new()
    {
        OkmsId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        Id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.Okms.OkmsFunctions;
import com.pulumi.ovh.Okms.inputs.GetOkmsServiceKeyArgs;
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) {
        final var keyInfo = OkmsFunctions.getOkmsServiceKey(GetOkmsServiceKeyArgs.builder()
            .okmsId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
            .id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
            .build());

    }
}

    variables:
  keyInfo:
    fn::invoke:
      function: ovh:Okms:getOkmsServiceKey
      arguments:
        okmsId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    Using getOkmsServiceKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOkmsServiceKey(args: GetOkmsServiceKeyArgs, opts?: InvokeOptions): Promise<GetOkmsServiceKeyResult>
function getOkmsServiceKeyOutput(args: GetOkmsServiceKeyOutputArgs, opts?: InvokeOptions): Output<GetOkmsServiceKeyResult>
    def get_okms_service_key(id: Optional[str] = None,
                         okms_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetOkmsServiceKeyResult
def get_okms_service_key_output(id: Optional[pulumi.Input[str]] = None,
                         okms_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetOkmsServiceKeyResult]
    func GetOkmsServiceKey(ctx *Context, args *GetOkmsServiceKeyArgs, opts ...InvokeOption) (*GetOkmsServiceKeyResult, error)
func GetOkmsServiceKeyOutput(ctx *Context, args *GetOkmsServiceKeyOutputArgs, opts ...InvokeOption) GetOkmsServiceKeyResultOutput

    > Note: This function is named GetOkmsServiceKey in the Go SDK.

    public static class GetOkmsServiceKey 
{
    public static Task<GetOkmsServiceKeyResult> InvokeAsync(GetOkmsServiceKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetOkmsServiceKeyResult> Invoke(GetOkmsServiceKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOkmsServiceKeyResult> getOkmsServiceKey(GetOkmsServiceKeyArgs args, InvokeOptions options)
public static Output<GetOkmsServiceKeyResult> getOkmsServiceKey(GetOkmsServiceKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:Okms/getOkmsServiceKey:getOkmsServiceKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the service key
    OkmsId string
    ID of the KMS
    Id string
    ID of the service key
    OkmsId string
    ID of the KMS
    id String
    ID of the service key
    okmsId String
    ID of the KMS
    id string
    ID of the service key
    okmsId string
    ID of the KMS
    id str
    ID of the service key
    okms_id str
    ID of the KMS
    id String
    ID of the service key
    okmsId String
    ID of the KMS

    getOkmsServiceKey Result

    The following output properties are available:

    CreatedAt string
    Curve string
    Iam GetOkmsServiceKeyIam
    Id string
    Name string
    OkmsId string
    Operations List<string>
    Size double
    State string
    Type string
    CreatedAt string
    Curve string
    Iam GetOkmsServiceKeyIam
    Id string
    Name string
    OkmsId string
    Operations []string
    Size float64
    State string
    Type string
    createdAt String
    curve String
    iam GetServiceKeyIam
    id String
    name String
    okmsId String
    operations List<String>
    size Double
    state String
    type String
    createdAt string
    curve string
    iam GetOkmsServiceKeyIam
    id string
    name string
    okmsId string
    operations string[]
    size number
    state string
    type string
    createdAt String
    curve String
    iam Property Map
    id String
    name String
    okmsId String
    operations List<String>
    size Number
    state String
    type String

    Supporting Types

    GetOkmsServiceKeyIam

    DisplayName string
    Resource display name
    Id string
    ID of the service key
    Tags Dictionary<string, string>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    DisplayName string
    Resource display name
    Id string
    ID of the service key
    Tags map[string]string
    Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    ID of the service key
    tags Map<String,String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies
    displayName string
    Resource display name
    id string
    ID of the service key
    tags {[key: string]: string}
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn string
    Unique resource name used in policies
    display_name str
    Resource display name
    id str
    ID of the service key
    tags Mapping[str, str]
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn str
    Unique resource name used in policies
    displayName String
    Resource display name
    id String
    ID of the service key
    tags Map<String>
    Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    Unique resource name used in policies

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh
      Try Pulumi Cloud free. Your team will thank you.