Edit

Share via


Get-AzCognitiveServicesAccount

Gets an account.

Syntax

ResourceGroupParameterSet

Get-AzCognitiveServicesAccount
    [[-ResourceGroupName] <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

AccountNameParameterSet

Get-AzCognitiveServicesAccount
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetDeletedAccountParameterSet

Get-AzCognitiveServicesAccount
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Location] <String>
    [-InRemovedState]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ListDeletedAccountParameterSet

Get-AzCognitiveServicesAccount
    [-InRemovedState]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzCognitiveServicesAccount cmdlet gets the provisioned Cognitive Services accounts in the resource group specified by the ResourceGroupName parameter. If you do not specify the ResourceGroupName parameter, this cmdlet gets all Cognitive Services accounts for the current subscription.

Examples

Example 1

Get-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis
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
CustomSubDomainName           :
PublicNetworkAccess           : Enabled
Identity                      :
Encryption                    :
UserOwnedStorage              :
PrivateEndpointConnections    : {}
ApiProperties                 :
Properties                    : Microsoft.Azure.Management.CognitiveServices.Models.AccountProperties
RestrictOutboundNetworkAccess :
AllowedFqdnList               :
DisableLocalAuth              :
NetworkRuleSet                :
Capabilities                  : {DynamicThrottling, VirtualNetworks, Container}
Tags                          :

Parameters

-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

-InRemovedState

Specifies whether to only show the deleted accounts in the output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetDeletedAccountParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListDeletedAccountParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

Cognitive Services Account Location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetDeletedAccountParameterSet
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the Cognitive Services account to get.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CognitiveServicesAccountName, AccountName

Parameter sets

AccountNameParameterSet
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
GetDeletedAccountParameterSet
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceGroupParameterSet
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
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.

Inputs

String

Outputs

PSCognitiveServicesAccount