Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cognitive
  5. Account

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.cognitive.Account

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    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",
    })

    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
	})
}

    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 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

    Create Account Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
    @overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            kind: Optional[str] = None,
            sku_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            metrics_advisor_aad_client_id: Optional[str] = None,
            metrics_advisor_super_user_name: Optional[str] = None,
            fqdns: Optional[Sequence[str]] = None,
            identity: Optional[AccountIdentityArgs] = None,
            customer_managed_key: Optional[AccountCustomerManagedKeyArgs] = None,
            local_auth_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            custom_question_answering_search_service_id: Optional[str] = None,
            metrics_advisor_aad_tenant_id: Optional[str] = None,
            dynamic_throttling_enabled: Optional[bool] = None,
            metrics_advisor_website_name: Optional[str] = None,
            name: Optional[str] = None,
            network_acls: Optional[AccountNetworkAclsArgs] = None,
            outbound_network_access_restricted: Optional[bool] = None,
            public_network_access_enabled: Optional[bool] = None,
            qna_runtime_endpoint: Optional[str] = None,
            custom_subdomain_name: Optional[str] = None,
            custom_question_answering_search_service_key: Optional[str] = None,
            storages: Optional[Sequence[AccountStorageArgs]] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

    type: azure:cognitive:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleaccountResourceResourceFromCognitiveaccount = new Azure.Cognitive.Account("exampleaccountResourceResourceFromCognitiveaccount", new()
{
    Kind = "string",
    SkuName = "string",
    ResourceGroupName = "string",
    MetricsAdvisorAadClientId = "string",
    MetricsAdvisorSuperUserName = "string",
    Fqdns = new[]
    {
        "string",
    },
    Identity = new Azure.Cognitive.Inputs.AccountIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    CustomerManagedKey = new Azure.Cognitive.Inputs.AccountCustomerManagedKeyArgs
    {
        KeyVaultKeyId = "string",
        IdentityClientId = "string",
    },
    LocalAuthEnabled = false,
    Location = "string",
    CustomQuestionAnsweringSearchServiceId = "string",
    MetricsAdvisorAadTenantId = "string",
    DynamicThrottlingEnabled = false,
    MetricsAdvisorWebsiteName = "string",
    Name = "string",
    NetworkAcls = new Azure.Cognitive.Inputs.AccountNetworkAclsArgs
    {
        DefaultAction = "string",
        IpRules = new[]
        {
            "string",
        },
        VirtualNetworkRules = new[]
        {
            new Azure.Cognitive.Inputs.AccountNetworkAclsVirtualNetworkRuleArgs
            {
                SubnetId = "string",
                IgnoreMissingVnetServiceEndpoint = false,
            },
        },
    },
    OutboundNetworkAccessRestricted = false,
    PublicNetworkAccessEnabled = false,
    QnaRuntimeEndpoint = "string",
    CustomSubdomainName = "string",
    CustomQuestionAnsweringSearchServiceKey = "string",
    Storages = new[]
    {
        new Azure.Cognitive.Inputs.AccountStorageArgs
        {
            StorageAccountId = "string",
            IdentityClientId = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cognitive.NewAccount(ctx, "exampleaccountResourceResourceFromCognitiveaccount", &cognitive.AccountArgs{
	Kind:                        pulumi.String("string"),
	SkuName:                     pulumi.String("string"),
	ResourceGroupName:           pulumi.String("string"),
	MetricsAdvisorAadClientId:   pulumi.String("string"),
	MetricsAdvisorSuperUserName: pulumi.String("string"),
	Fqdns: pulumi.StringArray{
		pulumi.String("string"),
	},
	Identity: &cognitive.AccountIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	CustomerManagedKey: &cognitive.AccountCustomerManagedKeyTypeArgs{
		KeyVaultKeyId:    pulumi.String("string"),
		IdentityClientId: pulumi.String("string"),
	},
	LocalAuthEnabled:                       pulumi.Bool(false),
	Location:                               pulumi.String("string"),
	CustomQuestionAnsweringSearchServiceId: pulumi.String("string"),
	MetricsAdvisorAadTenantId:              pulumi.String("string"),
	DynamicThrottlingEnabled:               pulumi.Bool(false),
	MetricsAdvisorWebsiteName:              pulumi.String("string"),
	Name:                                   pulumi.String("string"),
	NetworkAcls: &cognitive.AccountNetworkAclsArgs{
		DefaultAction: pulumi.String("string"),
		IpRules: pulumi.StringArray{
			pulumi.String("string"),
		},
		VirtualNetworkRules: cognitive.AccountNetworkAclsVirtualNetworkRuleArray{
			&cognitive.AccountNetworkAclsVirtualNetworkRuleArgs{
				SubnetId:                         pulumi.String("string"),
				IgnoreMissingVnetServiceEndpoint: pulumi.Bool(false),
			},
		},
	},
	OutboundNetworkAccessRestricted:         pulumi.Bool(false),
	PublicNetworkAccessEnabled:              pulumi.Bool(false),
	QnaRuntimeEndpoint:                      pulumi.String("string"),
	CustomSubdomainName:                     pulumi.String("string"),
	CustomQuestionAnsweringSearchServiceKey: pulumi.String("string"),
	Storages: cognitive.AccountStorageArray{
		&cognitive.AccountStorageArgs{
			StorageAccountId: pulumi.String("string"),
			IdentityClientId: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleaccountResourceResourceFromCognitiveaccount = new Account("exampleaccountResourceResourceFromCognitiveaccount", AccountArgs.builder()
    .kind("string")
    .skuName("string")
    .resourceGroupName("string")
    .metricsAdvisorAadClientId("string")
    .metricsAdvisorSuperUserName("string")
    .fqdns("string")
    .identity(AccountIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .customerManagedKey(AccountCustomerManagedKeyArgs.builder()
        .keyVaultKeyId("string")
        .identityClientId("string")
        .build())
    .localAuthEnabled(false)
    .location("string")
    .customQuestionAnsweringSearchServiceId("string")
    .metricsAdvisorAadTenantId("string")
    .dynamicThrottlingEnabled(false)
    .metricsAdvisorWebsiteName("string")
    .name("string")
    .networkAcls(AccountNetworkAclsArgs.builder()
        .defaultAction("string")
        .ipRules("string")
        .virtualNetworkRules(AccountNetworkAclsVirtualNetworkRuleArgs.builder()
            .subnetId("string")
            .ignoreMissingVnetServiceEndpoint(false)
            .build())
        .build())
    .outboundNetworkAccessRestricted(false)
    .publicNetworkAccessEnabled(false)
    .qnaRuntimeEndpoint("string")
    .customSubdomainName("string")
    .customQuestionAnsweringSearchServiceKey("string")
    .storages(AccountStorageArgs.builder()
        .storageAccountId("string")
        .identityClientId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    exampleaccount_resource_resource_from_cognitiveaccount = azure.cognitive.Account("exampleaccountResourceResourceFromCognitiveaccount",
    kind="string",
    sku_name="string",
    resource_group_name="string",
    metrics_advisor_aad_client_id="string",
    metrics_advisor_super_user_name="string",
    fqdns=["string"],
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    customer_managed_key={
        "key_vault_key_id": "string",
        "identity_client_id": "string",
    },
    local_auth_enabled=False,
    location="string",
    custom_question_answering_search_service_id="string",
    metrics_advisor_aad_tenant_id="string",
    dynamic_throttling_enabled=False,
    metrics_advisor_website_name="string",
    name="string",
    network_acls={
        "default_action": "string",
        "ip_rules": ["string"],
        "virtual_network_rules": [{
            "subnet_id": "string",
            "ignore_missing_vnet_service_endpoint": False,
        }],
    },
    outbound_network_access_restricted=False,
    public_network_access_enabled=False,
    qna_runtime_endpoint="string",
    custom_subdomain_name="string",
    custom_question_answering_search_service_key="string",
    storages=[{
        "storage_account_id": "string",
        "identity_client_id": "string",
    }],
    tags={
        "string": "string",
    })

    const exampleaccountResourceResourceFromCognitiveaccount = new azure.cognitive.Account("exampleaccountResourceResourceFromCognitiveaccount", {
    kind: "string",
    skuName: "string",
    resourceGroupName: "string",
    metricsAdvisorAadClientId: "string",
    metricsAdvisorSuperUserName: "string",
    fqdns: ["string"],
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    customerManagedKey: {
        keyVaultKeyId: "string",
        identityClientId: "string",
    },
    localAuthEnabled: false,
    location: "string",
    customQuestionAnsweringSearchServiceId: "string",
    metricsAdvisorAadTenantId: "string",
    dynamicThrottlingEnabled: false,
    metricsAdvisorWebsiteName: "string",
    name: "string",
    networkAcls: {
        defaultAction: "string",
        ipRules: ["string"],
        virtualNetworkRules: [{
            subnetId: "string",
            ignoreMissingVnetServiceEndpoint: false,
        }],
    },
    outboundNetworkAccessRestricted: false,
    publicNetworkAccessEnabled: false,
    qnaRuntimeEndpoint: "string",
    customSubdomainName: "string",
    customQuestionAnsweringSearchServiceKey: "string",
    storages: [{
        storageAccountId: "string",
        identityClientId: "string",
    }],
    tags: {
        string: "string",
    },
});

    type: azure:cognitive:Account
properties:
    customQuestionAnsweringSearchServiceId: string
    customQuestionAnsweringSearchServiceKey: string
    customSubdomainName: string
    customerManagedKey:
        identityClientId: string
        keyVaultKeyId: string
    dynamicThrottlingEnabled: false
    fqdns:
        - string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    kind: string
    localAuthEnabled: false
    location: string
    metricsAdvisorAadClientId: string
    metricsAdvisorAadTenantId: string
    metricsAdvisorSuperUserName: string
    metricsAdvisorWebsiteName: string
    name: string
    networkAcls:
        defaultAction: string
        ipRules:
            - string
        virtualNetworkRules:
            - ignoreMissingVnetServiceEndpoint: false
              subnetId: string
    outboundNetworkAccessRestricted: false
    publicNetworkAccessEnabled: false
    qnaRuntimeEndpoint: string
    resourceGroupName: string
    skuName: string
    storages:
        - identityClientId: string
          storageAccountId: string
    tags:
        string: string

    Account Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Account resource accepts the following input properties:

    Kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    ResourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    SkuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    CustomSubdomainName string
    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.
    CustomerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    DynamicThrottlingEnabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    Fqdns List<string>
    List of FQDNs allowed for the Cognitive Account.
    Identity AccountIdentity
    An identity block as defined below.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MetricsAdvisorAadClientId string
    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.
    MetricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    Name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    NetworkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    OutboundNetworkAccessRestricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    QnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    Storages List<AccountStorage>
    A storage block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    ResourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    SkuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    CustomSubdomainName string
    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.
    CustomerManagedKey AccountCustomerManagedKeyTypeArgs
    A customer_managed_key block as documented below.
    DynamicThrottlingEnabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    Fqdns []string
    List of FQDNs allowed for the Cognitive Account.
    Identity AccountIdentityArgs
    An identity block as defined below.
    LocalAuthEnabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MetricsAdvisorAadClientId string
    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.
    MetricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    Name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    NetworkAcls AccountNetworkAclsArgs
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    OutboundNetworkAccessRestricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    QnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    Storages []AccountStorageArgs
    A storage block as defined below.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    resourceGroupName String
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName String
    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.
    customerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled Boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    fqdns List<String>
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentity
    An identity block as defined below.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId String
    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.
    metricsAdvisorAadTenantId String
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName String
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName String

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name String
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted Boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint String
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    storages List<AccountStorage>
    A storage block as defined below.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    resourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName string
    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.
    customerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    fqdns string[]
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentity
    An identity block as defined below.
    localAuthEnabled boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId string
    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.
    metricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    storages AccountStorage[]
    A storage block as defined below.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    kind str

    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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

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

    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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    custom_subdomain_name str
    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.
    customer_managed_key AccountCustomerManagedKeyArgs
    A customer_managed_key block as documented below.
    dynamic_throttling_enabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    fqdns Sequence[str]
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentityArgs
    An identity block as defined below.
    local_auth_enabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metrics_advisor_aad_client_id str
    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.
    metrics_advisor_aad_tenant_id str
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metrics_advisor_super_user_name str
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metrics_advisor_website_name str

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name str
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    network_acls AccountNetworkAclsArgs
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outbound_network_access_restricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    public_network_access_enabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qna_runtime_endpoint str
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    storages Sequence[AccountStorageArgs]
    A storage block as defined below.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    resourceGroupName String
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

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

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName String
    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.
    customerManagedKey Property Map
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled Boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    fqdns List<String>
    List of FQDNs allowed for the Cognitive Account.
    identity Property Map
    An identity block as defined below.
    localAuthEnabled Boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId String
    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.
    metricsAdvisorAadTenantId String
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName String
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName String

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name String
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls Property Map
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted Boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint String
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    storages List<Property Map>
    A storage block as defined below.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

    Endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    SecondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    Endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    SecondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    endpoint String
    The endpoint used to connect to the Cognitive Service Account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    A primary access key which can be used to connect to the Cognitive Service Account.
    secondaryAccessKey String
    The secondary access key which can be used to connect to the Cognitive Service Account.
    endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    secondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    endpoint str
    The endpoint used to connect to the Cognitive Service Account.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_access_key str
    A primary access key which can be used to connect to the Cognitive Service Account.
    secondary_access_key str
    The secondary access key which can be used to connect to the Cognitive Service Account.
    endpoint String
    The endpoint used to connect to the Cognitive Service Account.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    A primary access key which can be used to connect to the Cognitive Service Account.
    secondaryAccessKey String
    The secondary access key which can be used to connect to the Cognitive Service Account.

    Look up Existing Account Resource

    Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_question_answering_search_service_id: Optional[str] = None,
        custom_question_answering_search_service_key: Optional[str] = None,
        custom_subdomain_name: Optional[str] = None,
        customer_managed_key: Optional[AccountCustomerManagedKeyArgs] = None,
        dynamic_throttling_enabled: Optional[bool] = None,
        endpoint: Optional[str] = None,
        fqdns: Optional[Sequence[str]] = None,
        identity: Optional[AccountIdentityArgs] = None,
        kind: Optional[str] = None,
        local_auth_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        metrics_advisor_aad_client_id: Optional[str] = None,
        metrics_advisor_aad_tenant_id: Optional[str] = None,
        metrics_advisor_super_user_name: Optional[str] = None,
        metrics_advisor_website_name: Optional[str] = None,
        name: Optional[str] = None,
        network_acls: Optional[AccountNetworkAclsArgs] = None,
        outbound_network_access_restricted: Optional[bool] = None,
        primary_access_key: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        qna_runtime_endpoint: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        sku_name: Optional[str] = None,
        storages: Optional[Sequence[AccountStorageArgs]] = None,
        tags: Optional[Mapping[str, str]] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CustomQuestionAnsweringSearchServiceId string
    If kind is TextAnalytics this specifies the ID of the Search service.
    CustomQuestionAnsweringSearchServiceKey string

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    CustomSubdomainName string
    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.
    CustomerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    DynamicThrottlingEnabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    Endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    Fqdns List<string>
    List of FQDNs allowed for the Cognitive Account.
    Identity AccountIdentity
    An identity block as defined below.
    Kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    LocalAuthEnabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MetricsAdvisorAadClientId string
    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.
    MetricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    Name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    NetworkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    OutboundNetworkAccessRestricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    PrimaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    QnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    ResourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    SkuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    Storages List<AccountStorage>
    A storage block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    CustomQuestionAnsweringSearchServiceId string
    If kind is TextAnalytics this specifies the ID of the Search service.
    CustomQuestionAnsweringSearchServiceKey string

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    CustomSubdomainName string
    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.
    CustomerManagedKey AccountCustomerManagedKeyTypeArgs
    A customer_managed_key block as documented below.
    DynamicThrottlingEnabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    Endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    Fqdns []string
    List of FQDNs allowed for the Cognitive Account.
    Identity AccountIdentityArgs
    An identity block as defined below.
    Kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    LocalAuthEnabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    MetricsAdvisorAadClientId string
    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.
    MetricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    MetricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    Name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    NetworkAcls AccountNetworkAclsArgs
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    OutboundNetworkAccessRestricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    PrimaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    PublicNetworkAccessEnabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    QnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    ResourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    SkuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    Storages []AccountStorageArgs
    A storage block as defined below.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    customQuestionAnsweringSearchServiceId String
    If kind is TextAnalytics this specifies the ID of the Search service.
    customQuestionAnsweringSearchServiceKey String

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName String
    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.
    customerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled Boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    endpoint String
    The endpoint used to connect to the Cognitive Service Account.
    fqdns List<String>
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentity
    An identity block as defined below.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    localAuthEnabled Boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId String
    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.
    metricsAdvisorAadTenantId String
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName String
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName String

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name String
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted Boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    primaryAccessKey String
    A primary access key which can be used to connect to the Cognitive Service Account.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint String
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    resourceGroupName String
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key which can be used to connect to the Cognitive Service Account.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    storages List<AccountStorage>
    A storage block as defined below.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    customQuestionAnsweringSearchServiceId string
    If kind is TextAnalytics this specifies the ID of the Search service.
    customQuestionAnsweringSearchServiceKey string

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName string
    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.
    customerManagedKey AccountCustomerManagedKey
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    endpoint string
    The endpoint used to connect to the Cognitive Service Account.
    fqdns string[]
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentity
    An identity block as defined below.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    localAuthEnabled boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId string
    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.
    metricsAdvisorAadTenantId string
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName string
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName string

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name string
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls AccountNetworkAcls
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    primaryAccessKey string
    A primary access key which can be used to connect to the Cognitive Service Account.
    publicNetworkAccessEnabled boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint string
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    resourceGroupName string
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    secondaryAccessKey string
    The secondary access key which can be used to connect to the Cognitive Service Account.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    storages AccountStorage[]
    A storage block as defined below.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    custom_question_answering_search_service_id str
    If kind is TextAnalytics this specifies the ID of the Search service.
    custom_question_answering_search_service_key str

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    custom_subdomain_name str
    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.
    customer_managed_key AccountCustomerManagedKeyArgs
    A customer_managed_key block as documented below.
    dynamic_throttling_enabled bool
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    endpoint str
    The endpoint used to connect to the Cognitive Service Account.
    fqdns Sequence[str]
    List of FQDNs allowed for the Cognitive Account.
    identity AccountIdentityArgs
    An identity block as defined below.
    kind str

    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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    local_auth_enabled bool
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metrics_advisor_aad_client_id str
    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.
    metrics_advisor_aad_tenant_id str
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metrics_advisor_super_user_name str
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metrics_advisor_website_name str

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name str
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    network_acls AccountNetworkAclsArgs
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outbound_network_access_restricted bool
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    primary_access_key str
    A primary access key which can be used to connect to the Cognitive Service Account.
    public_network_access_enabled bool
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qna_runtime_endpoint str
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    resource_group_name str
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    secondary_access_key str
    The secondary access key which can be used to connect to the Cognitive Service Account.
    sku_name str

    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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    storages Sequence[AccountStorageArgs]
    A storage block as defined below.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    customQuestionAnsweringSearchServiceId String
    If kind is TextAnalytics this specifies the ID of the Search service.
    customQuestionAnsweringSearchServiceKey String

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

    NOTE: custom_question_answering_search_service_id and custom_question_answering_search_service_key are used for Custom Question Answering, the renamed version of QnA Maker, while qna_runtime_endpoint is used for the old version of QnA Maker

    customSubdomainName String
    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.
    customerManagedKey Property Map
    A customer_managed_key block as documented below.
    dynamicThrottlingEnabled Boolean
    Whether to enable the dynamic throttling for this Cognitive Service Account.
    endpoint String
    The endpoint used to connect to the Cognitive Service Account.
    fqdns List<String>
    List of FQDNs allowed for the Cognitive Account.
    identity Property Map
    An identity block as defined below.
    kind 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.

    NOTE: New Bing Search resources cannot be created as their APIs are moving from Cognitive Services Platform to new surface area under Microsoft.com. Starting from October 30, 2020, existing instances of Bing Search APIs provisioned via Cognitive Services will be continuously supported for next 3 years or till the end of respective Enterprise Agreement, whichever happens first.

    NOTE: You must create your first Face, Text Analytics, or Computer Vision resources from the Azure portal to review and acknowledge the terms and conditions. In Azure Portal, the checkbox to accept terms and conditions is only displayed when a US region is selected. More information on Prerequisites.

    localAuthEnabled Boolean
    Whether local authentication methods is enabled for the Cognitive Account. Defaults to true.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
    metricsAdvisorAadClientId String
    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.
    metricsAdvisorAadTenantId String
    The Azure AD Tenant ID. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorSuperUserName String
    The super user of Metrics Advisor. This attribute is only set when kind is MetricsAdvisor. Changing this forces a new resource to be created.
    metricsAdvisorWebsiteName String

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

    NOTE: This URL is mandatory if the kind is set to QnAMaker.

    name String
    Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
    networkAcls Property Map
    A network_acls block as defined below. When this property is specified, custom_subdomain_name is also required to be set.
    outboundNetworkAccessRestricted Boolean
    Whether outbound network access is restricted for the Cognitive Account. Defaults to false.
    primaryAccessKey String
    A primary access key which can be used to connect to the Cognitive Service Account.
    publicNetworkAccessEnabled Boolean
    Whether public network access is allowed for the Cognitive Account. Defaults to true.
    qnaRuntimeEndpoint String
    A URL to link a QnAMaker cognitive account to a QnA runtime.
    resourceGroupName String
    The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key which can be used to connect to the Cognitive Service Account.
    skuName 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.

    NOTE: SKU DC0 is the commitment tier for Cognitive Services containers running in disconnected environments. You must obtain approval from Microsoft by submitting the request form first, before you can use this SKU. More information on Purchase a commitment plan to use containers in disconnected environments.

    storages List<Property Map>
    A storage block as defined below.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Supporting Types

    AccountCustomerManagedKey, AccountCustomerManagedKeyArgs

    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    IdentityClientId string
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.
    KeyVaultKeyId string
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    IdentityClientId string
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    identityClientId String
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.
    keyVaultKeyId string
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    identityClientId string
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.
    key_vault_key_id str
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    identity_client_id str
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.
    keyVaultKeyId String
    The ID of the Key Vault Key which should be used to Encrypt the data in this Cognitive Account.
    identityClientId String
    The Client ID of the User Assigned Identity that has access to the key. This property only needs to be specified when there're multiple identities attached to the Cognitive Account.

    AccountIdentity, AccountIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Cognitive Account. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Cognitive Account.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    AccountNetworkAcls, AccountNetworkAclsArgs

    DefaultAction string
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    IpRules List<string>
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    VirtualNetworkRules List<AccountNetworkAclsVirtualNetworkRule>
    A virtual_network_rules block as defined below.
    DefaultAction string
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    IpRules []string
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    VirtualNetworkRules []AccountNetworkAclsVirtualNetworkRule
    A virtual_network_rules block as defined below.
    defaultAction String
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    ipRules List<String>
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    virtualNetworkRules List<AccountNetworkAclsVirtualNetworkRule>
    A virtual_network_rules block as defined below.
    defaultAction string
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    ipRules string[]
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    virtualNetworkRules AccountNetworkAclsVirtualNetworkRule[]
    A virtual_network_rules block as defined below.
    default_action str
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    ip_rules Sequence[str]
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    virtual_network_rules Sequence[AccountNetworkAclsVirtualNetworkRule]
    A virtual_network_rules block as defined below.
    defaultAction String
    The Default Action to use when no rules match from ip_rules / virtual_network_rules. Possible values are Allow and Deny.
    ipRules List<String>
    One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.
    virtualNetworkRules List<Property Map>
    A virtual_network_rules block as defined below.

    AccountNetworkAclsVirtualNetworkRule, AccountNetworkAclsVirtualNetworkRuleArgs

    SubnetId string
    The ID of the subnet which should be able to access this Cognitive Account.
    IgnoreMissingVnetServiceEndpoint bool
    Whether ignore missing vnet service endpoint or not. Default to false.
    SubnetId string
    The ID of the subnet which should be able to access this Cognitive Account.
    IgnoreMissingVnetServiceEndpoint bool
    Whether ignore missing vnet service endpoint or not. Default to false.
    subnetId String
    The ID of the subnet which should be able to access this Cognitive Account.
    ignoreMissingVnetServiceEndpoint Boolean
    Whether ignore missing vnet service endpoint or not. Default to false.
    subnetId string
    The ID of the subnet which should be able to access this Cognitive Account.
    ignoreMissingVnetServiceEndpoint boolean
    Whether ignore missing vnet service endpoint or not. Default to false.
    subnet_id str
    The ID of the subnet which should be able to access this Cognitive Account.
    ignore_missing_vnet_service_endpoint bool
    Whether ignore missing vnet service endpoint or not. Default to false.
    subnetId String
    The ID of the subnet which should be able to access this Cognitive Account.
    ignoreMissingVnetServiceEndpoint Boolean
    Whether ignore missing vnet service endpoint or not. Default to false.

    AccountStorage, AccountStorageArgs

    StorageAccountId string
    Full resource id of a Microsoft.Storage resource.
    IdentityClientId string

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    StorageAccountId string
    Full resource id of a Microsoft.Storage resource.
    IdentityClientId string

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    storageAccountId String
    Full resource id of a Microsoft.Storage resource.
    identityClientId String

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    storageAccountId string
    Full resource id of a Microsoft.Storage resource.
    identityClientId string

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    storage_account_id str
    Full resource id of a Microsoft.Storage resource.
    identity_client_id str

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    storageAccountId String
    Full resource id of a Microsoft.Storage resource.
    identityClientId String

    The client ID of the managed identity associated with the storage resource.

    NOTE: Not all kind support a storage block. For example the kind OpenAI does not support it.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

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

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure