New-AzCognitiveServicesAccount
Creates a Cognitive Services account.
Syntax
CognitiveServicesEncryption
New-AzCognitiveServicesAccount
[-ResourceGroupName] <String>
[-Name] <String>
[-Type] <String>
[-SkuName] <String>
[-Location] <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
New-AzCognitiveServicesAccount
[-ResourceGroupName] <String>
[-Name] <String>
[-Type] <String>
[-SkuName] <String>
[-Location] <String>
-KeyName <String>
-KeyVersion <String>
-KeyVaultUri <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 New-AzCognitiveServicesAccount cmdlet creates a Cognitive Services account with the
specified type and SKU.
Examples
Example 1:
New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Location 'WestUS'
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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ApiProperty
The ApiProperties of Cognitive Services Account. Required by specific account types.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
CognitiveServicesEncryption
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CustomSubdomainName
Cognitive Services Account Subdomain Name.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisableLocalAuth
True if disable Local authentication methods.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IdentityType
Set the new Cognitive Services Account Identity type, the identity is for use with key management services like Azure KeyVault.
Parameter properties
Type: Nullable<T> [ IdentityType ]
Default value: None Accepted values: None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyName
Cognitive Services Account encryption keySource KeyVault KeyName
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
KeyVaultEncryption
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
KeyVaultEncryption
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
KeyVaultEncryption
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultUri
Cognitive Services Account encryption keySource KeyVault KeyVaultUri
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
KeyVaultEncryption
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVersion
Cognitive Services Account encryption keySource KeyVault KeyVersion
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
KeyVaultEncryption
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
Specifies the location in which to create the account.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 4 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-MultiRegionSetting
Multi-region settings for multi-region account.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Specifies the name for the account.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: CognitiveServicesAccountName, AccountName
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: 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
Parameter properties
Type: PSNetworkRuleSet
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
Specifies the name of the resource group to which to assign the account.
The resource group must already exist.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RestrictOutboundNetworkAccess
True if restrict outbound network access.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuName
Specifies the SKU for the account.
The acceptable values for this parameter are:
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-StorageAccountId
List of User Owned Storage Accounts.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Specifies a tag as a name/value pair.
Parameter properties
Type: Hashtable [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: Tags
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Type
Specifies the type of account to create. Use Get-AzCognitiveServicesAccountType cmdlet to get current acceptable values.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: CognitiveServicesAccountType, AccountType, Kind
Parameter sets
(All)
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: 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.
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
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 .
Outputs
