Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzCognitiveServicesAccount
- Module:
- Az.CognitiveServices Module
Modifies an account.
Syntax
CognitiveServicesEncryption (Default)
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[]>]
[-MultiRegionSetting <MultiRegionSettings>]
[-ApiProperty <CognitiveServicesAccountApiProperties>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
KeyVaultEncryption
Set-AzCognitiveServicesAccount
[-ResourceGroupName] <String>
[-Name] <String>
-KeyName <String>
-KeyVersion <String>
-KeyVaultUri <String>
[-SkuName <String>]
[-Tag <Hashtable[]>]
[-CustomSubdomainName <String>]
[-AssignIdentity]
[-UserAssignedIdentityId <String[]>]
[-IdentityType <IdentityType>]
[-StorageAccountId <String[]>]
[-KeyVaultEncryption]
[-KeyVaultIdentityClientId <String>]
[-NetworkRuleSet <PSNetworkRuleSet>]
[-PublicNetworkAccess <String>]
[-DisableLocalAuth <Boolean>]
[-RestrictOutboundNetworkAccess <Boolean>]
[-AllowedFqdnList <String[]>]
[-MultiRegionSetting <MultiRegionSettings>]
[-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
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApiProperty
The ApiProperties of Cognitive Services Account. Required by specific account types.
Parameter properties
| Type: | CognitiveServicesAccountApiProperties |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AssignIdentity
Generate and assign a new Cognitive Services Account Identity for this storage account for use with key management services like Azure KeyVault.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CognitiveServicesEncryption
Whether to set Cognitive Services Account Encryption KeySource to Microsoft.CognitiveServices or not.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-CustomSubdomainName
Cognitive Services Account Subdomain Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-DisableLocalAuth
True if disable Local authentication methods.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IdentityType
Type of managed service identity.
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyName
Cognitive Services Account encryption keySource KeyVault KeyName
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVaultIdentityClientId
Set IdentityClientId to access Azure KeyVault of Cognitive Services Account Encryption.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVaultUri
Cognitive Services Account encryption keySource KeyVault KeyVaultUri
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KeyVersion
Cognitive Services Account encryption keySource KeyVault KeyVersion
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-MultiRegionSetting
Multi-region settings for multi-region account.
Parameter properties
| Type: | MultiRegionSettings |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Specifies the name of the account to modify.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CognitiveServicesAccountName, AccountName |
Parameter sets
-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
Parameter properties
| Type: | PSNetworkRuleSet |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicNetworkAccess
The network access type for Cognitive Services Account.
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | Enabled, Disabled |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Specifies the name of the resource group the account is assigned to.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RestrictOutboundNetworkAccess
True if restrict outbound network access.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuName
Specifies the SKU for the account. The acceptable values for this parameter are:
- F0 (free tier)
- S0
- S1
- S2
- S3
- S4
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageAccountId
List of User Owned Storage Accounts.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Specifies a tag as a name/value pair.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Tags |
Parameter sets
-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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Hashtable
Outputs
PSCognitiveServicesAccount
Related Links
Azure PowerShell
Feedback
Was this page helpful?