Edit

Share via

New-AzCognitiveServicesAccountApiProperty

  • Reference
Module:
Az.CognitiveServices

Generate a new instance of Cognitive Services Account ApiProperties

Syntax

New-AzCognitiveServicesAccountApiProperty
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Generate a new instance of Cognitive Services Account ApiProperties. ApiProperties can be used when creating a new account or updating an existing account. ApiProperties is required by certain account types.

Examples

Example 1

$apiProperties = New-AzCognitiveServicesAccountApiProperty
$apiProperties.QnaRuntimeEndpoint = "https://qnamaker.azurewebsites.net"
New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name qnamaker -Type QnAMaker -SkuName S0 -Location WestUS -ApiProperty $apiProperties

Above example will create an QnAMaker account, with API property "QnaRuntimeEndpoint".

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

CognitiveServicesAccountApiProperties