We recommend using Azure Native.
Azure Classic v6.8.0 published on Monday, Nov 4, 2024 by Pulumi
azure.cognitive.getAccount
Explore with Pulumi AI
Use this data source to access information about an existing Cognitive Services Account.
Example Usage
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);
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)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/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
})
}
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 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()));
}
}
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.
- Resource
Group stringName - Specifies the name of the resource group where the Cognitive Services Account resides.
- Dictionary<string, string>
- A mapping of tags to assigned to the resource.
- Name string
- Specifies the name of the Cognitive Services Account.
- Resource
Group stringName - Specifies the name of the resource group where the Cognitive Services Account resides.
- map[string]string
- A mapping of tags to assigned to the resource.
- name String
- Specifies the name of the Cognitive Services Account.
- resource
Group StringName - Specifies the name of the resource group where the Cognitive Services Account resides.
- Map<String,String>
- A mapping of tags to assigned to the resource.
- name string
- Specifies the name of the Cognitive Services Account.
- resource
Group stringName - Specifies the name of the resource group where the Cognitive Services Account resides.
- {[key: string]: string}
- A mapping of tags to assigned to the resource.
- name str
- Specifies the name of the Cognitive Services Account.
- resource_
group_ strname - Specifies the name of the resource group where the Cognitive Services Account resides.
- Mapping[str, str]
- A mapping of tags to assigned to the resource.
- name String
- Specifies the name of the Cognitive Services Account.
- resource
Group StringName - Specifies the name of the resource group where the Cognitive Services Account resides.
- 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.
- Identities
List<Get
Account Identity> - A
identity
block as defined below. - Kind string
- The kind of the Cognitive Services Account
- Location string
- The Azure location where the Cognitive Services Account exists
- Name string
- Primary
Access stringKey - The primary access key of the Cognitive Services Account
- Qna
Runtime stringEndpoint - If
kind
isQnAMaker
the link to the QNA runtime. - Resource
Group stringName - Secondary
Access stringKey - The secondary access key of the Cognitive Services Account
- Sku
Name string - The SKU name of the Cognitive Services Account
- 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.
- Identities
[]Get
Account Identity - A
identity
block as defined below. - Kind string
- The kind of the Cognitive Services Account
- Location string
- The Azure location where the Cognitive Services Account exists
- Name string
- Primary
Access stringKey - The primary access key of the Cognitive Services Account
- Qna
Runtime stringEndpoint - If
kind
isQnAMaker
the link to the QNA runtime. - Resource
Group stringName - Secondary
Access stringKey - The secondary access key of the Cognitive Services Account
- Sku
Name string - The SKU name of the Cognitive Services Account
- 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.
- identities
List<Get
Account Identity> - A
identity
block as defined below. - kind String
- The kind of the Cognitive Services Account
- location String
- The Azure location where the Cognitive Services Account exists
- name String
- primary
Access StringKey - The primary access key of the Cognitive Services Account
- qna
Runtime StringEndpoint - If
kind
isQnAMaker
the link to the QNA runtime. - resource
Group StringName - secondary
Access StringKey - The secondary access key of the Cognitive Services Account
- sku
Name String - The SKU name of the Cognitive Services Account
- 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.
- identities
Get
Account Identity[] - A
identity
block as defined below. - kind string
- The kind of the Cognitive Services Account
- location string
- The Azure location where the Cognitive Services Account exists
- name string
- primary
Access stringKey - The primary access key of the Cognitive Services Account
- qna
Runtime stringEndpoint - If
kind
isQnAMaker
the link to the QNA runtime. - resource
Group stringName - secondary
Access stringKey - The secondary access key of the Cognitive Services Account
- sku
Name string - The SKU name of the Cognitive Services Account
- {[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.
- identities
Sequence[Get
Account Identity] - A
identity
block as defined below. - kind str
- The kind of the Cognitive Services Account
- location str
- The Azure location where the Cognitive Services Account exists
- name str
- primary_
access_ strkey - The primary access key of the Cognitive Services Account
- qna_
runtime_ strendpoint - If
kind
isQnAMaker
the link to the QNA runtime. - resource_
group_ strname - secondary_
access_ strkey - The secondary access key of the Cognitive Services Account
- sku_
name str - The SKU name of the Cognitive Services Account
- 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.
- identities List<Property Map>
- A
identity
block as defined below. - kind String
- The kind of the Cognitive Services Account
- location String
- The Azure location where the Cognitive Services Account exists
- name String
- primary
Access StringKey - The primary access key of the Cognitive Services Account
- qna
Runtime StringEndpoint - If
kind
isQnAMaker
the link to the QNA runtime. - resource
Group StringName - secondary
Access StringKey - The secondary access key of the Cognitive Services Account
- sku
Name String - The SKU name of the Cognitive Services Account
- Map<String>
- A mapping of tags to assigned to the resource.
Supporting Types
GetAccountIdentity
- Identity
Ids List<string> - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- Tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- Type string
- The type of Managed Service Identity that is configured on this Cognitive Account.
- Identity
Ids []string - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- Principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- Tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- Type string
- The type of Managed Service Identity that is configured on this Cognitive Account.
- identity
Ids List<String> - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- tenant
Id String - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- type String
- The type of Managed Service Identity that is configured on this Cognitive Account.
- identity
Ids string[] - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- principal
Id string - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- tenant
Id string - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- type string
- The type of Managed Service Identity that is configured on this Cognitive Account.
- identity_
ids Sequence[str] - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- principal_
id str - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- tenant_
id str - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- type str
- The type of Managed Service Identity that is configured on this Cognitive Account.
- identity
Ids List<String> - The list of User Assigned Managed Identity IDs assigned to this Cognitive Account.
- principal
Id String - The Principal ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- tenant
Id String - The Tenant ID of the System Assigned Managed Service Identity that is configured on this Cognitive Account.
- type String
- The type of Managed Service Identity that is configured on this Cognitive Account.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.