Account

class Account : KotlinCustomResource

Manages a Cognitive Services Account.

Note: Version v2.65.0 of the Azure Provider and later will attempt to Purge the Cognitive Account during deletion. This feature can be disabled using the features block within the provider block, see the provider documentation on the features block for more information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleAccount = new azure.cognitive.Account("example", {
name: "example-account",
location: example.location,
resourceGroupName: example.name,
kind: "Face",
skuName: "S0",
tags: {
Acceptance: "Test",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_account = azure.cognitive.Account("example",
name="example-account",
location=example.location,
resource_group_name=example.name,
kind="Face",
sku_name="S0",
tags={
"Acceptance": "Test",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleAccount = new Azure.Cognitive.Account("example", new()
{
Name = "example-account",
Location = example.Location,
ResourceGroupName = example.Name,
Kind = "Face",
SkuName = "S0",
Tags =
{
{ "Acceptance", "Test" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cognitive"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = cognitive.NewAccount(ctx, "example", &cognitive.AccountArgs{
Name: pulumi.String("example-account"),
Location: example.Location,
ResourceGroupName: example.Name,
Kind: pulumi.String("Face"),
SkuName: pulumi.String("S0"),
Tags: pulumi.StringMap{
"Acceptance": pulumi.String("Test"),
},
})
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.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.cognitive.Account;
import com.pulumi.azure.cognitive.AccountArgs;
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) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("example-account")
.location(example.location())
.resourceGroupName(example.name())
.kind("Face")
.skuName("S0")
.tags(Map.of("Acceptance", "Test"))
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleAccount:
type: azure:cognitive:Account
name: example
properties:
name: example-account
location: ${example.location}
resourceGroupName: ${example.name}
kind: Face
skuName: S0
tags:
Acceptance: Test

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.CognitiveServices: 2024-10-01

Import

Cognitive Service Accounts can be imported using the resource id, e.g.

$ pulumi import azure:cognitive/account:Account account1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.CognitiveServices/accounts/account1

Properties

Link copied to clipboard

A customer_managed_key block as documented below.

Link copied to clipboard

If kind is TextAnalytics this specifies the ID of the Search service.

Link copied to clipboard

If kind is TextAnalytics this specifies the key of the Search service.

Link copied to clipboard

The subdomain name used for token-based authentication. This property is required when network_acls is specified. This property is also required when using the OpenAI service with libraries which assume the Azure OpenAI endpoint is a subdomain on https://openai.azure.com/, eg. https://<custom_subdomain_name>.openai.azure.com/. Changing this forces a new resource to be created.

Link copied to clipboard

Whether to enable the dynamic throttling for this Cognitive Service Account.

Link copied to clipboard
val endpoint: Output<String>

The endpoint used to connect to the Cognitive Service Account.

Link copied to clipboard
val fqdns: Output<List<String>>?

List of FQDNs allowed for the Cognitive Account.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An identity block as defined below.

Link copied to clipboard
val kind: Output<String>

Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, AnomalyDetector, Bing.Autosuggest, Bing.Autosuggest.v7, Bing.CustomSearch, Bing.Search, Bing.Search.v7, Bing.Speech, Bing.SpellCheck, Bing.SpellCheck.v7, CognitiveServices, ComputerVision, ContentModerator, ContentSafety, CustomSpeech, CustomVision.Prediction, CustomVision.Training, Emotion, Face, FormRecognizer, ImmersiveReader, LUIS, LUIS.Authoring, MetricsAdvisor, OpenAI, Personalizer, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.

Link copied to clipboard

Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.

Link copied to clipboard
val location: Output<String>

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Link copied to clipboard

The Azure AD Client ID (Application ID). This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.

Link copied to clipboard

The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.

Link copied to clipboard

The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.

Link copied to clipboard

The website name of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.

Link copied to clipboard
val name: Output<String>

Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.

Link copied to clipboard

A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.

Link copied to clipboard

Whether outbound network access is restricted for the Cognitive Account. Defaults to false.

Link copied to clipboard

A primary access key which can be used to connect to the Cognitive Service Account.

Link copied to clipboard

Whether public network access is allowed for the Cognitive Account. Defaults to true.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A URL to link a QnAMaker cognitive account to a QnA runtime.

Link copied to clipboard

The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.

Link copied to clipboard

The secondary access key which can be used to connect to the Cognitive Service Account.

Link copied to clipboard
val skuName: Output<String>

Specifies the SKU Name for this Cognitive Service Account. Possible values are F0, F1, S0, S, S1, S2, S3, S4, S5, S6, P0, P1, P2, E0 and DC0.

Link copied to clipboard

A storage block as defined below.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

Link copied to clipboard
val urn: Output<String>