getApiKey

Use this data source to access information about an existing NGINX Dataplane API Key.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.nginx.getApiKey({
name: "existing",
nginxDeploymentId: exampleAzurermNginxDeployment.id,
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.nginx.get_api_key(name="existing",
nginx_deployment_id=example_azurerm_nginx_deployment["id"])
pulumi.export("id", example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Nginx.GetApiKey.Invoke(new()
{
Name = "existing",
NginxDeploymentId = exampleAzurermNginxDeployment.Id,
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getApiKeyResult => getApiKeyResult.Id),
};
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/nginx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := nginx.LookupApiKey(ctx, &nginx.LookupApiKeyArgs{
Name: "existing",
NginxDeploymentId: exampleAzurermNginxDeployment.Id,
}, nil)
if err != nil {
return err
}
ctx.Export("id", example.Id)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.nginx.NginxFunctions;
import com.pulumi.azure.nginx.inputs.GetApiKeyArgs;
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 example = NginxFunctions.getApiKey(GetApiKeyArgs.builder()
.name("existing")
.nginxDeploymentId(exampleAzurermNginxDeployment.id())
.build());
ctx.export("id", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:nginx:getApiKey
arguments:
name: existing
nginxDeploymentId: ${exampleAzurermNginxDeployment.id}
outputs:
id: ${example.id}

API Providers

This data source uses the following Azure API Providers:

  • Nginx.NginxPlus: 2024-11-01-preview

Return

A collection of values returned by getApiKey.

Parameters

argument

A collection of arguments for invoking getApiKey.


suspend fun getApiKey(name: String, nginxDeploymentId: String): GetApiKeyResult

Return

A collection of values returned by getApiKey.

Parameters

name

The name of the NGINX Dataplane API Key.

nginxDeploymentId

The ID of the NGINX Deployment that the API key is associated with.

See also


suspend fun getApiKey(argument: suspend GetApiKeyPlainArgsBuilder.() -> Unit): GetApiKeyResult

Return

A collection of values returned by getApiKey.

Parameters

argument

Builder for com.pulumi.azure.nginx.kotlin.inputs.GetApiKeyPlainArgs.

See also