Azure Classic v5.43.0, May 6 23

azure.cognitive.getAccount

Explore with Pulumi AI

Use this data source to access information about an existing Cognitive Services Account.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var test = Azure.Cognitive.GetAccount.Invoke(new()
    {
        Name = "example-account",
        ResourceGroupName = "cognitive_account_rg",
    });

    return new Dictionary<string, object?>
    {
        ["primaryAccessKey"] = test.Apply(getAccountResult => getAccountResult.PrimaryAccessKey),
    };
});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cognitive"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := cognitive.LookupAccount(ctx, &cognitive.LookupAccountArgs{
			Name:              "example-account",
			ResourceGroupName: "cognitive_account_rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("primaryAccessKey", test.PrimaryAccessKey)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.cognitive.CognitiveFunctions;
import com.pulumi.azure.cognitive.inputs.GetAccountArgs;
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 test = CognitiveFunctions.getAccount(GetAccountArgs.builder()
            .name("example-account")
            .resourceGroupName("cognitive_account_rg")
            .build());

        ctx.export("primaryAccessKey", test.applyValue(getAccountResult -> getAccountResult.primaryAccessKey()));
    }
}

import pulumi
import pulumi_azure as azure

test = azure.cognitive.get_account(name="example-account",
    resource_group_name="cognitive_account_rg")
pulumi.export("primaryAccessKey", test.primary_access_key)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = azure.cognitive.getAccount({
    name: "example-account",
    resourceGroupName: "cognitive_account_rg",
});
export const primaryAccessKey = test.then(test => test.primaryAccessKey);

variables:
  test:
    fn::invoke:
      Function: azure:cognitive:getAccount
      Arguments:
        name: example-account
        resourceGroupName: cognitive_account_rg
outputs:
  primaryAccessKey: ${test.primaryAccessKey}

Using getAccount

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 getAccount(args: GetAccountArgs, opts?: InvokeOptions): Promise<GetAccountResult>
function getAccountOutput(args: GetAccountOutputArgs, opts?: InvokeOptions): Output<GetAccountResult>

def get_account(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetAccountResult
def get_account_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]

func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput

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

public static class GetAccount 
{
    public static Task<GetAccountResult> InvokeAsync(GetAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetAccountResult> Invoke(GetAccountInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:cognitive/getAccount:getAccount
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Specifies the name of the Cognitive Services Account.
ResourceGroupName string: Specifies the name of the resource group where the Cognitive Services Account resides.
Tags Dictionary<string, string>: A mapping of tags to assigned to the resource.

Name string: Specifies the name of the Cognitive Services Account.
ResourceGroupName string: Specifies the name of the resource group where the Cognitive Services Account resides.
Tags map[string]string: A mapping of tags to assigned to the resource.

name String: Specifies the name of the Cognitive Services Account.
resourceGroupName String: Specifies the name of the resource group where the Cognitive Services Account resides.
tags Map<String,String>: A mapping of tags to assigned to the resource.

name string: Specifies the name of the Cognitive Services Account.
resourceGroupName string: Specifies the name of the resource group where the Cognitive Services Account resides.
tags {[key: string]: string}: A mapping of tags to assigned to the resource.

name str: Specifies the name of the Cognitive Services Account.
resource_group_name str: Specifies the name of the resource group where the Cognitive Services Account resides.
tags Mapping[str, str]: A mapping of tags to assigned to the resource.

name String: Specifies the name of the Cognitive Services Account.
resourceGroupName String: Specifies the name of the resource group where the Cognitive Services Account resides.
tags Map<String>: A mapping of tags to assigned to the resource.

getAccount Result

The following output properties are available:

Endpoint string: The endpoint of the Cognitive Services Account
Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of the Cognitive Services Account
Location string: The Azure location where the Cognitive Services Account exists
Name string
PrimaryAccessKey string: The primary access key of the Cognitive Services Account
QnaRuntimeEndpoint string: If kind is QnAMaker the link to the QNA runtime.
ResourceGroupName string
SecondaryAccessKey string: The secondary access key of the Cognitive Services Account
SkuName string: The SKU name of the Cognitive Services Account
Tags Dictionary<string, string>: A mapping of tags to assigned to the resource.

Endpoint string: The endpoint of the Cognitive Services Account
Id string: The provider-assigned unique ID for this managed resource.
Kind string: The kind of the Cognitive Services Account
Location string: The Azure location where the Cognitive Services Account exists
Name string
PrimaryAccessKey string: The primary access key of the Cognitive Services Account
QnaRuntimeEndpoint string: If kind is QnAMaker the link to the QNA runtime.
ResourceGroupName string
SecondaryAccessKey string: The secondary access key of the Cognitive Services Account
SkuName string: The SKU name of the Cognitive Services Account
Tags map[string]string: A mapping of tags to assigned to the resource.

endpoint String: The endpoint of the Cognitive Services Account
id String: The provider-assigned unique ID for this managed resource.
kind String: The kind of the Cognitive Services Account
location String: The Azure location where the Cognitive Services Account exists
name String
primaryAccessKey String: The primary access key of the Cognitive Services Account
qnaRuntimeEndpoint String: If kind is QnAMaker the link to the QNA runtime.
resourceGroupName String
secondaryAccessKey String: The secondary access key of the Cognitive Services Account
skuName String: The SKU name of the Cognitive Services Account
tags Map<String,String>: A mapping of tags to assigned to the resource.

endpoint string: The endpoint of the Cognitive Services Account
id string: The provider-assigned unique ID for this managed resource.
kind string: The kind of the Cognitive Services Account
location string: The Azure location where the Cognitive Services Account exists
name string
primaryAccessKey string: The primary access key of the Cognitive Services Account
qnaRuntimeEndpoint string: If kind is QnAMaker the link to the QNA runtime.
resourceGroupName string
secondaryAccessKey string: The secondary access key of the Cognitive Services Account
skuName string: The SKU name of the Cognitive Services Account
tags {[key: string]: string}: A mapping of tags to assigned to the resource.

endpoint str: The endpoint of the Cognitive Services Account
id str: The provider-assigned unique ID for this managed resource.
kind str: The kind of the Cognitive Services Account
location str: The Azure location where the Cognitive Services Account exists
name str
primary_access_key str: The primary access key of the Cognitive Services Account
qna_runtime_endpoint str: If kind is QnAMaker the link to the QNA runtime.
resource_group_name str
secondary_access_key str: The secondary access key of the Cognitive Services Account
sku_name str: The SKU name of the Cognitive Services Account
tags Mapping[str, str]: A mapping of tags to assigned to the resource.

endpoint String: The endpoint of the Cognitive Services Account
id String: The provider-assigned unique ID for this managed resource.
kind String: The kind of the Cognitive Services Account
location String: The Azure location where the Cognitive Services Account exists
name String
primaryAccessKey String: The primary access key of the Cognitive Services Account
qnaRuntimeEndpoint String: If kind is QnAMaker the link to the QNA runtime.
resourceGroupName String
secondaryAccessKey String: The secondary access key of the Cognitive Services Account
skuName String: The SKU name of the Cognitive Services Account
tags Map<String>: A mapping of tags to assigned to the resource.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.