Skip to content

Commit

Permalink
[CognitiveServices] Unify and Complete samples (#21487)
Browse files Browse the repository at this point in the history
* add some outputs for Get

* Update Get-AzCognitiveServicesAccountCommitmentPlan.md

* Update Get-AzCognitiveServicesAccountDeployment.md

* Update Get-AzCognitiveServicesAccountType.md

* Update Get-AzCognitiveServicesCommitmentPlan.md

* Update Get-AzCognitiveServicesCommitmentTier.md

---------

Co-authored-by: Yunchi Wang <[email protected]>
  • Loading branch information
tianxin-ms and wyunchi-ms authored Apr 13, 2023
1 parent 4c21e2c commit 13f1bb3
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,22 +45,35 @@ If you do not specify the *ResourceGroupName* parameter, this cmdlet gets all Co

### Example 1
```powershell
New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Location 'WestUS'
Get-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis
```

```output
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 :
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ Get CommitmentPlan of a Cognitive Services account
Get-AzCognitiveServicesAccountCommitmentPlan -ResourceGroupName cognitive-services-resource-group -AccountName resource-name
```

```output
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Kind :
Sku :
Tags :
Location :
Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name
Name : plan-name
Type : Microsoft.CognitiveServices/accounts/commitmentplans
```

Get CommitmentPlan of a Cognitive Services account

## PARAMETERS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ Get Deployment of a Cognitive Services account
Get-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name
```

```output
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Properties : Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName
Name : deploymentName
Type : Microsoft.CognitiveServices/accounts/deployments
```

Get Deployment of a Cognitive Services account

## PARAMETERS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,29 @@ The **Get-AzCognitiveServicesAccountType** cmdlet gets the available Cognitive S
Get-AzCognitiveServicesAccountType
```

```output
CognitiveServices
ComputerVision
Face
FormRecognizer
LUIS
```

Get the list of available Types.

### Example 2
```powershell
Get-AzCognitiveServicesAccountType -Location westus
```

```output
CognitiveServices
ComputerVision
Face
FormRecognizer
LUIS
```

Get the list of available Types in westus.

### Example 3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ Get Cognitive Services Commitment Plan
Get-AzCognitiveServicesCommitmentPlan -ResourceGroupName ResourceGroupName -Name CommitmentPlanName
```

```output
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Kind :
Sku :
Tags :
Location :
Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name
Name : plan-name
Type : Microsoft.CognitiveServices/accounts/commitmentplans
```

Get a Cognitive Services Commitment Plan

## PARAMETERS
Expand All @@ -54,7 +67,7 @@ Accept wildcard characters: False
```
### -Name
Cognitive Services Account Name.
Cognitive Services Commitment Plan Name.
```yaml
Type: System.String
Expand Down Expand Up @@ -118,4 +131,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md)
[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md)
[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md)
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ Get CommitmentTier of Cognitive Services
Get-AzCognitiveServicesCommitmentTier -Location 'WestUS'
```

```output
Kind : kind
SkuName : sku
HostingModel : hosting model
PlanType : plan type
Tier : tier
MaxCount :
Quota : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentQuota
Cost : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentCost
```

Get CommitmentTier of Cognitive Services

## PARAMETERS
Expand Down

0 comments on commit 13f1bb3

Please sign in to comment.