Module cognitive
This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.
Resources
Others
Resources
Resource Account
class Account extends CustomResourceManages a Cognitive Services Account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.cognitive.Account("exampleAccount", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
kind: "Face",
skuName: "S0",
tags: {
Acceptance: "Test",
},
});constructor
new Account(name: string, args: AccountArgs, opts?: pulumi.CustomResourceOptions)Create a Account resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountState, opts?: pulumi.CustomResourceOptions): AccountGet an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is AccountReturns true if the given object is an instance of Account. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property endpoint
public endpoint: pulumi.Output<string>;The endpoint used to connect to the Cognitive Service Account.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property kind
public kind: pulumi.Output<string>;Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, 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, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.
property location
public location: pulumi.Output<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
public name: pulumi.Output<string>;Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
property primaryAccessKey
public primaryAccessKey: pulumi.Output<string>;A primary access key which can be used to connect to the Cognitive Service Account.
property qnaRuntimeEndpoint
public qnaRuntimeEndpoint: pulumi.Output<string | undefined>;A URL to link a QnAMaker cognitive account to a QnA runtime.
property resourceGroupName
public resourceGroupName: pulumi.Output<string>;The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
property secondaryAccessKey
public secondaryAccessKey: pulumi.Output<string>;The secondary access key which can be used to connect to the Cognitive Service Account.
property skuName
public skuName: pulumi.Output<string>;Specifies the SKU Name for this Cognitive Service Account. Possible values are F0, F1, S0, S1, S2, S3, S4, S5, S6, P0, P1, and P2.
property tags
public tags: pulumi.Output<{[key: string]: string} | undefined>;A mapping of tags to assign to the resource.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Others
interface AccountArgs
interface AccountArgsThe set of arguments for constructing a Account resource.
property kind
kind: pulumi.Input<string>;Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, 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, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
property qnaRuntimeEndpoint
qnaRuntimeEndpoint?: pulumi.Input<string>;A URL to link a QnAMaker cognitive account to a QnA runtime.
property resourceGroupName
resourceGroupName: pulumi.Input<string>;The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
property skuName
skuName: pulumi.Input<string>;Specifies the SKU Name for this Cognitive Service Account. Possible values are F0, F1, S0, S1, S2, S3, S4, S5, S6, P0, P1, and P2.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.
interface AccountState
interface AccountStateInput properties used for looking up and filtering Account resources.
property endpoint
endpoint?: pulumi.Input<string>;The endpoint used to connect to the Cognitive Service Account.
property kind
kind?: pulumi.Input<string>;Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, 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, QnAMaker, Recommendations, SpeakerRecognition, Speech, SpeechServices, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.
property location
location?: pulumi.Input<string>;Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
property name
name?: pulumi.Input<string>;Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.
property primaryAccessKey
primaryAccessKey?: pulumi.Input<string>;A primary access key which can be used to connect to the Cognitive Service Account.
property qnaRuntimeEndpoint
qnaRuntimeEndpoint?: pulumi.Input<string>;A URL to link a QnAMaker cognitive account to a QnA runtime.
property resourceGroupName
resourceGroupName?: pulumi.Input<string>;The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.
property secondaryAccessKey
secondaryAccessKey?: pulumi.Input<string>;The secondary access key which can be used to connect to the Cognitive Service Account.
property skuName
skuName?: pulumi.Input<string>;Specifies the SKU Name for this Cognitive Service Account. Possible values are F0, F1, S0, S1, S2, S3, S4, S5, S6, P0, P1, and P2.
property tags
tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;A mapping of tags to assign to the resource.