pulumi-azure-kotlin/com.pulumi.azure.cognitive.kotlin/AccountArgs

AccountArgs

data class AccountArgs(val customQuestionAnsweringSearchServiceId: Output<String>? = null, val customQuestionAnsweringSearchServiceKey: Output<String>? = null, val customSubdomainName: Output<String>? = null, val customerManagedKey: Output<AccountCustomerManagedKeyArgs>? = null, val dynamicThrottlingEnabled: Output<Boolean>? = null, val fqdns: Output<List<String>>? = null, val identity: Output<AccountIdentityArgs>? = null, val kind: Output<String>? = null, val localAuthEnabled: Output<Boolean>? = null, val location: Output<String>? = null, val metricsAdvisorAadClientId: Output<String>? = null, val metricsAdvisorAadTenantId: Output<String>? = null, val metricsAdvisorSuperUserName: Output<String>? = null, val metricsAdvisorWebsiteName: Output<String>? = null, val name: Output<String>? = null, val networkAcls: Output<AccountNetworkAclsArgs>? = null, val outboundNetworkAccessRestricted: Output<Boolean>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val qnaRuntimeEndpoint: Output<String>? = null, val resourceGroupName: Output<String>? = null, val skuName: Output<String>? = null, val storages: Output<List<AccountStorageArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<AccountArgs>

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

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .kind("Face")
            .skuName("S0")
            .tags(Map.of("Acceptance", "Test"))
            .build());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun AccountArgs(customQuestionAnsweringSearchServiceId: Output<String>? = null, customQuestionAnsweringSearchServiceKey: Output<String>? = null, customSubdomainName: Output<String>? = null, customerManagedKey: Output<AccountCustomerManagedKeyArgs>? = null, dynamicThrottlingEnabled: Output<Boolean>? = null, fqdns: Output<List<String>>? = null, identity: Output<AccountIdentityArgs>? = null, kind: Output<String>? = null, localAuthEnabled: Output<Boolean>? = null, location: Output<String>? = null, metricsAdvisorAadClientId: Output<String>? = null, metricsAdvisorAadTenantId: Output<String>? = null, metricsAdvisorSuperUserName: Output<String>? = null, metricsAdvisorWebsiteName: Output<String>? = null, name: Output<String>? = null, networkAcls: Output<AccountNetworkAclsArgs>? = null, outboundNetworkAccessRestricted: Output<Boolean>? = null, publicNetworkAccessEnabled: Output<Boolean>? = null, qnaRuntimeEndpoint: Output<String>? = null, resourceGroupName: Output<String>? = null, skuName: Output<String>? = null, storages: Output<List<AccountStorageArgs>>? = null, tags: Output<Map<String, String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AccountArgs

Properties

Link copied to clipboard
val customerManagedKey: Output<AccountCustomerManagedKeyArgs>? = null

A customer_managed_key block as documented below.

Link copied to clipboard
val customQuestionAnsweringSearchServiceId: Output<String>? = null

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

Link copied to clipboard
val customQuestionAnsweringSearchServiceKey: Output<String>? = null

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

Link copied to clipboard
val customSubdomainName: Output<String>? = null

The subdomain name used for token-based authentication. Changing this forces a new resource to be created.

Link copied to clipboard
val dynamicThrottlingEnabled: Output<Boolean>? = null

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

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

List of FQDNs allowed for the Cognitive Account.

Link copied to clipboard
val identity: Output<AccountIdentityArgs>? = null

An identity block as defined below.

Link copied to clipboard
val kind: Output<String>? = null

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, CustomSpeech, CustomVision.Prediction, CustomVision.Training, Emotion, Face, FormRecognizer, ImmersiveReader, LUIS, LUIS.Authoring, MetricsAdvisor, OpenAI, Personalizer, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.

Link copied to clipboard
val localAuthEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val location: Output<String>? = null

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

Link copied to clipboard
val metricsAdvisorAadClientId: Output<String>? = null

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

Link copied to clipboard
val metricsAdvisorAadTenantId: Output<String>? = null

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

Link copied to clipboard
val metricsAdvisorSuperUserName: Output<String>? = null

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

Link copied to clipboard
val metricsAdvisorWebsiteName: Output<String>? = null

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

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val networkAcls: Output<AccountNetworkAclsArgs>? = null

A network_acls block as defined below.

Link copied to clipboard
val outboundNetworkAccessRestricted: Output<Boolean>? = null

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

Link copied to clipboard
val publicNetworkAccessEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val qnaRuntimeEndpoint: Output<String>? = null

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

Link copied to clipboard
val resourceGroupName: Output<String>? = null

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

Link copied to clipboard
val skuName: Output<String>? = null

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

Link copied to clipboard
val storages: Output<List<AccountStorageArgs>>? = null

A storage block as defined below.

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

A mapping of tags to assign to the resource.