Set-AzCognitiveServicesAccount

Reference

Module:: Az.CognitiveServices

Modifies an account.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Set-AzCognitiveServicesAccount
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-SkuName <String>]
   [-Tag <Hashtable[]>]
   [-CustomSubdomainName <String>]
   [-AssignIdentity]
   [-UserAssignedIdentityId <String[]>]
   [-IdentityType <IdentityType>]
   [-StorageAccountId <String[]>]
   [-CognitiveServicesEncryption]
   [-NetworkRuleSet <PSNetworkRuleSet>]
   [-PublicNetworkAccess <String>]
   [-DisableLocalAuth <Boolean>]
   [-RestrictOutboundNetworkAccess <Boolean>]
   [-AllowedFqdnList <String[]>]
   [-ApiProperty <CognitiveServicesAccountApiProperties>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzCognitiveServicesAccount
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-SkuName <String>]
   [-Tag <Hashtable[]>]
   [-CustomSubdomainName <String>]
   [-AssignIdentity]
   [-UserAssignedIdentityId <String[]>]
   [-IdentityType <IdentityType>]
   [-StorageAccountId <String[]>]
   [-KeyVaultEncryption]
   -KeyName <String>
   -KeyVersion <String>
   -KeyVaultUri <String>
   [-KeyVaultIdentityClientId <String>]
   [-NetworkRuleSet <PSNetworkRuleSet>]
   [-PublicNetworkAccess <String>]
   [-DisableLocalAuth <Boolean>]
   [-RestrictOutboundNetworkAccess <Boolean>]
   [-AllowedFqdnList <String[]>]
   [-ApiProperty <CognitiveServicesAccountApiProperties>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzCognitiveServicesAccount cmdlet modifies the SKU or tags of the specified Cognitive Services account.

Examples

Example 1

PS C:\> Set-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -SkuName S0


ResourceGroupName : cognitive-services-resource-group
AccountName       : myluis
Id                : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
                    nitiveServices/accounts/myluis
Endpoint          : https://westus.api.cognitive.microsoft.com/luis/v2.0
Location          : WESTUS
Sku               : Microsoft.Azure.Management.CognitiveServices.Models.Sku
AccountType       : LUIS
ResourceType      : Microsoft.CognitiveServices/accounts
Etag              : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
ProvisioningState : Succeeded
Tags              :

Parameters

-AllowedFqdnList

List of Allowed FQDN.

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ApiProperty

The ApiProperties of Cognitive Services Account. Required by specific account types.

Type:	CognitiveServicesAccountApiProperties
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AssignIdentity

Generate and assign a new Cognitive Services Account Identity for this storage account for use with key management services like Azure KeyVault.

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

-CognitiveServicesEncryption

Whether to set Cognitive Services Account Encryption KeySource to Microsoft.CognitiveServices or not.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-CustomSubdomainName

Cognitive Services Account Subdomain Name.

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableLocalAuth

True if disable Local authentication methods.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Forces the command to run without asking for user confirmation.

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

-IdentityType

Type of managed service identity.

Type:	Nullable<T>[IdentityType]
Accepted values:	None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyName

Cognitive Services Account encryption keySource KeyVault KeyName

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultEncryption

Whether to set Cognitive Services Account encryption keySource to Microsoft.KeyVault or not. If you specify KeyName, KeyVersion and KeyVaultUri, Cognitive Services Account Encryption KeySource will also be set to Microsoft.KeyVault weather this parameter is set or not.

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

-KeyVaultIdentityClientId

Set IdentityClientId to access Azure KeyVault of Cognitive Services Account Encryption.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVaultUri

Cognitive Services Account encryption keySource KeyVault KeyVaultUri

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-KeyVersion

Cognitive Services Account encryption keySource KeyVault KeyVersion

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies the name of the account to modify.

Type:	String
Aliases:	CognitiveServicesAccountName, AccountName
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-NetworkRuleSet

NetworkRuleSet is used to define a set of configuration rules for firewalls and virtual networks, as well as to set values for network properties such as how to handle requests that don't match any of the defined rules

Type:	PSNetworkRuleSet
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

The network access type for Cognitive Services Account.

Type:	String
Accepted values:	Enabled, Disabled
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of the resource group the account is assigned to.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-RestrictOutboundNetworkAccess

True if restrict outbound network access.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuName

Specifies the SKU for the account. The acceptable values for this parameter are:

F0 (free tier)
S0
S1
S2
S3
S4

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-StorageAccountId

List of User Owned Storage Accounts.

Type:	String[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Specifies a tag as a name/value pair.

Type:	Hashtable[]
Aliases:	Tags
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-UserAssignedIdentityId

Set resource ids for the the new Cognitive Services Account user assigned Identity, the identity will be used with key management services like Azure KeyVault.