oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.Dns.getTsigKey

This data source provides details about a specific Tsig Key resource in Oracle Cloud Infrastructure DNS service.

Gets information about the specified TSIG key.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTsigKey = Oci.Dns.GetTsigKey.Invoke(new()
    {
        TsigKeyId = oci_dns_tsig_key.Test_tsig_key.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Dns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Dns.GetTsigKey(ctx, &dns.GetTsigKeyArgs{
			TsigKeyId: oci_dns_tsig_key.Test_tsig_key.Id,
		}, nil)
		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.oci.Dns.DnsFunctions;
import com.pulumi.oci.Dns.inputs.GetTsigKeyArgs;
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 testTsigKey = DnsFunctions.getTsigKey(GetTsigKeyArgs.builder()
            .tsigKeyId(oci_dns_tsig_key.test_tsig_key().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_tsig_key = oci.Dns.get_tsig_key(tsig_key_id=oci_dns_tsig_key["test_tsig_key"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testTsigKey = oci.Dns.getTsigKey({
    tsigKeyId: oci_dns_tsig_key.test_tsig_key.id,
});
variables:
  testTsigKey:
    fn::invoke:
      Function: oci:Dns:getTsigKey
      Arguments:
        tsigKeyId: ${oci_dns_tsig_key.test_tsig_key.id}

Using getTsigKey

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 getTsigKey(args: GetTsigKeyArgs, opts?: InvokeOptions): Promise<GetTsigKeyResult>
function getTsigKeyOutput(args: GetTsigKeyOutputArgs, opts?: InvokeOptions): Output<GetTsigKeyResult>
def get_tsig_key(tsig_key_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTsigKeyResult
def get_tsig_key_output(tsig_key_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTsigKeyResult]
func GetTsigKey(ctx *Context, args *GetTsigKeyArgs, opts ...InvokeOption) (*GetTsigKeyResult, error)
func GetTsigKeyOutput(ctx *Context, args *GetTsigKeyOutputArgs, opts ...InvokeOption) GetTsigKeyResultOutput

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

public static class GetTsigKey 
{
    public static Task<GetTsigKeyResult> InvokeAsync(GetTsigKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetTsigKeyResult> Invoke(GetTsigKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTsigKeyResult> getTsigKey(GetTsigKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Dns/getTsigKey:getTsigKey
  arguments:
    # arguments dictionary

The following arguments are supported:

TsigKeyId string

The OCID of the target TSIG key.

TsigKeyId string

The OCID of the target TSIG key.

tsigKeyId String

The OCID of the target TSIG key.

tsigKeyId string

The OCID of the target TSIG key.

tsig_key_id str

The OCID of the target TSIG key.

tsigKeyId String

The OCID of the target TSIG key.

getTsigKey Result

The following output properties are available:

Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

The OCID of the compartment containing the TSIG key.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Id string

The OCID of the resource.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

Secret string

A base64 string encoding the binary shared secret.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

TsigKeyId string
Algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

CompartmentId string

The OCID of the compartment containing the TSIG key.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Id string

The OCID of the resource.

Name string

A globally unique domain name identifying the key for a given pair of hosts.

Secret string

A base64 string encoding the binary shared secret.

Self string

The canonical absolute URL of the resource.

State string

The current state of the resource.

TimeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

TimeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

TsigKeyId string
algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

The OCID of the compartment containing the TSIG key.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

id String

The OCID of the resource.

name String

A globally unique domain name identifying the key for a given pair of hosts.

secret String

A base64 string encoding the binary shared secret.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

tsigKeyId String
algorithm string

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId string

The OCID of the compartment containing the TSIG key.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

id string

The OCID of the resource.

name string

A globally unique domain name identifying the key for a given pair of hosts.

secret string

A base64 string encoding the binary shared secret.

self string

The canonical absolute URL of the resource.

state string

The current state of the resource.

timeCreated string

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated string

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

tsigKeyId string
algorithm str

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartment_id str

The OCID of the compartment containing the TSIG key.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

id str

The OCID of the resource.

name str

A globally unique domain name identifying the key for a given pair of hosts.

secret str

A base64 string encoding the binary shared secret.

self str

The canonical absolute URL of the resource.

state str

The current state of the resource.

time_created str

The date and time the resource was created, expressed in RFC 3339 timestamp format.

time_updated str

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

tsig_key_id str
algorithm String

TSIG key algorithms are encoded as domain names, but most consist of only one non-empty label, which is not required to be explicitly absolute. Applicable algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these algorithms, see RFC 4635.

compartmentId String

The OCID of the compartment containing the TSIG key.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

id String

The OCID of the resource.

name String

A globally unique domain name identifying the key for a given pair of hosts.

secret String

A base64 string encoding the binary shared secret.

self String

The canonical absolute URL of the resource.

state String

The current state of the resource.

timeCreated String

The date and time the resource was created, expressed in RFC 3339 timestamp format.

timeUpdated String

The date and time the resource was last updated, expressed in RFC 3339 timestamp format.

tsigKeyId String

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.