Skip to content

Commit 13f1bb3

Browse files
[CognitiveServices] Unify and Complete samples (#21487)
* 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]>
1 parent 4c21e2c commit 13f1bb3

6 files changed

+90
-15
lines changed

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccount.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,22 +45,35 @@ If you do not specify the *ResourceGroupName* parameter, this cmdlet gets all Co
4545

4646
### Example 1
4747
```powershell
48-
New-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Location 'WestUS'
48+
Get-AzCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis
4949
```
5050

5151
```output
52-
ResourceGroupName : cognitive-services-resource-group
53-
AccountName : myluis
54-
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
55-
nitiveServices/accounts/myluis
56-
Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0
57-
Location : WESTUS
58-
Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku
59-
AccountType : LUIS
60-
ResourceType : Microsoft.CognitiveServices/accounts
61-
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
62-
ProvisioningState : Succeeded
63-
Tags :
52+
ResourceGroupName : cognitive-services-resource-group
53+
AccountName : myluis
54+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
55+
nitiveServices/accounts/myluis
56+
Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0
57+
Location : WESTUS
58+
Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku
59+
AccountType : LUIS
60+
ResourceType : Microsoft.CognitiveServices/accounts
61+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
62+
ProvisioningState : Succeeded
63+
CustomSubDomainName :
64+
PublicNetworkAccess : Enabled
65+
Identity :
66+
Encryption :
67+
UserOwnedStorage :
68+
PrivateEndpointConnections : {}
69+
ApiProperties :
70+
Properties : Microsoft.Azure.Management.CognitiveServices.Models.AccountProperties
71+
RestrictOutboundNetworkAccess :
72+
AllowedFqdnList :
73+
DisableLocalAuth :
74+
NetworkRuleSet :
75+
Capabilities : {DynamicThrottling, VirtualNetworks, Container}
76+
Tags :
6477
```
6578

6679
## PARAMETERS

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountCommitmentPlan.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,19 @@ Get CommitmentPlan of a Cognitive Services account
3434
Get-AzCognitiveServicesAccountCommitmentPlan -ResourceGroupName cognitive-services-resource-group -AccountName resource-name
3535
```
3636

37+
```output
38+
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
39+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
40+
Kind :
41+
Sku :
42+
Tags :
43+
Location :
44+
Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties
45+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name
46+
Name : plan-name
47+
Type : Microsoft.CognitiveServices/accounts/commitmentplans
48+
```
49+
3750
Get CommitmentPlan of a Cognitive Services account
3851

3952
## PARAMETERS

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountDeployment.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ Get Deployment of a Cognitive Services account
3434
Get-AzCognitiveServicesAccountDeployment -ResourceGroupName cognitive-services-resource-group -AccountName resource-name
3535
```
3636

37+
```output
38+
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
39+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
40+
Properties : Microsoft.Azure.Management.CognitiveServices.Models.DeploymentProperties
41+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/deployments/deploymentName
42+
Name : deploymentName
43+
Type : Microsoft.CognitiveServices/accounts/deployments
44+
```
45+
3746
Get Deployment of a Cognitive Services account
3847

3948
## PARAMETERS

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountType.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,29 @@ The **Get-AzCognitiveServicesAccountType** cmdlet gets the available Cognitive S
3434
Get-AzCognitiveServicesAccountType
3535
```
3636

37+
```output
38+
CognitiveServices
39+
ComputerVision
40+
Face
41+
FormRecognizer
42+
LUIS
43+
```
44+
3745
Get the list of available Types.
3846

3947
### Example 2
4048
```powershell
4149
Get-AzCognitiveServicesAccountType -Location westus
4250
```
4351

52+
```output
53+
CognitiveServices
54+
ComputerVision
55+
Face
56+
FormRecognizer
57+
LUIS
58+
```
59+
4460
Get the list of available Types in westus.
4561

4662
### Example 3

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlan.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,19 @@ Get Cognitive Services Commitment Plan
3434
Get-AzCognitiveServicesCommitmentPlan -ResourceGroupName ResourceGroupName -Name CommitmentPlanName
3535
```
3636

37+
```output
38+
SystemData : Microsoft.Azure.Management.CognitiveServices.Models.SystemData
39+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
40+
Kind :
41+
Sku :
42+
Tags :
43+
Location :
44+
Properties : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentPlanProperties
45+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.CognitiveServices/accounts/resource-name/commitmentplans/plan-name
46+
Name : plan-name
47+
Type : Microsoft.CognitiveServices/accounts/commitmentplans
48+
```
49+
3750
Get a Cognitive Services Commitment Plan
3851

3952
## PARAMETERS
@@ -54,7 +67,7 @@ Accept wildcard characters: False
5467
```
5568
5669
### -Name
57-
Cognitive Services Account Name.
70+
Cognitive Services Commitment Plan Name.
5871
5972
```yaml
6073
Type: System.String
@@ -118,4 +131,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
118131
119132
[Remove-AzCognitiveServicesCommitmentPlan](./Remove-AzCognitiveServicesCommitmentPlan.md)
120133
121-
[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md)
134+
[Remove-AzCognitiveServicesCommitmentPlanAssociation](./Remove-AzCognitiveServicesCommitmentPlanAssociation.md)

src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentTier.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ Get CommitmentTier of Cognitive Services
2727
Get-AzCognitiveServicesCommitmentTier -Location 'WestUS'
2828
```
2929

30+
```output
31+
Kind : kind
32+
SkuName : sku
33+
HostingModel : hosting model
34+
PlanType : plan type
35+
Tier : tier
36+
MaxCount :
37+
Quota : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentQuota
38+
Cost : Microsoft.Azure.Management.CognitiveServices.Models.CommitmentCost
39+
```
40+
3041
Get CommitmentTier of Cognitive Services
3142

3243
## PARAMETERS

0 commit comments

Comments
 (0)