Skip to content

Commit 4197b3a

Browse files
author
Maddie Clayton
authored
Merge pull request #6458 from v-geberr/0613-cognitiveservices-examples
documentation examples for using cognitive services powershell cmdlets
2 parents 68f8320 + 444aa65 commit 4197b3a

8 files changed

+93
-1
lines changed

src/ResourceManager/CognitiveServices/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Current Release
21+
* Update examples for CognitiveServices cmdlets
2122

2223
## Version 0.9.5
2324
* Set minimum dependency of module to PowerShell 5.0

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccount.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,25 @@ If you do not specify the *ResoureGroupName* parameter, this cmdlet gets all Cog
3232

3333
## EXAMPLES
3434

35+
### Example 1
36+
```powershell
37+
PS C:\> New-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Locati
38+
on 'WestUS'
39+
40+
ResourceGroupName : cognitive-services-resource-group
41+
AccountName : myluis
42+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
43+
nitiveServices/accounts/myluis
44+
Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0
45+
Location : WESTUS
46+
Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku
47+
AccountType : LUIS
48+
ResourceType : Microsoft.CognitiveServices/accounts
49+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
50+
ProvisioningState : Succeeded
51+
Tags :
52+
```
53+
3554
## PARAMETERS
3655

3756
### -DefaultProfile

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountKey.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ Use New-AzureRmCognitiveServicesAccountKey to regenerate a key.
2828

2929
## EXAMPLES
3030

31+
### Example 1
32+
```powershell
33+
PS C:\> Get-AzureRmCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis
34+
35+
Key1 Key2
36+
---- ----
37+
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
38+
```
39+
3140
## PARAMETERS
3241

3342
### -DefaultProfile

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Get-AzureRmCognitiveServicesAccountSkus.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ Paid tiers include S0, S1, S2, and so on.
2828

2929
## EXAMPLES
3030

31+
### Example 1
32+
```powershell
33+
PS C:\> (Get-AzureRmCognitiveServicesAccountSkus -ResourceGroupName cognitive-services-resource-group -Name myluis).Value | Select-Object -E
34+
xpandProperty Sku;
35+
36+
Name Tier
37+
---- ----
38+
F0 Free
39+
S0 Standard
40+
```
41+
3142
## PARAMETERS
3243

3344
### -DefaultProfile

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccount.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,23 @@ specified type and SKU.
2727

2828
### 1:
2929
```
30-
New-AzureRmCognitiveServicesAccount -ResourceGroupName 'resourcegroup1' -name 'MyAccountName' -Type TextTranslation -SkuName F0 -Location 'usgovvirginia'
30+
PS C:\> New-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -Type LUIS -SkuName S0 -Locatio
31+
n 'WestUS'
32+
33+
34+
ResourceGroupName : cognitive-services-resource-group
35+
AccountName : myluis
36+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
37+
nitiveServices/accounts/myluis
38+
Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0
39+
Location : WestUS
40+
Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku
41+
AccountType : LUIS
42+
ResourceType : Microsoft.CognitiveServices/accounts
43+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
44+
ProvisioningState : Succeeded
45+
Tags :
46+
3147
```
3248

3349
## PARAMETERS

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/New-AzureRmCognitiveServicesAccountKey.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ The **New-AzureRmCognitiveServicesAccountKey** cmdlet regenerates an API key for
2323

2424
## EXAMPLES
2525

26+
### Example 1
27+
```powershell
28+
PS C:\> New-AzureRmCognitiveServicesAccountKey -ResourceGroupName cognitive-services-resource-group -name myluis -keyname Key1
29+
30+
Key1 Key2
31+
---- ----
32+
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
33+
```
34+
2635
## PARAMETERS
2736

2837
### -DefaultProfile

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Remove-AzureRmCognitiveServicesAccount.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ The **Remove-AzureRmCognitiveServicesAccount** cmdlet deletes the specified Cogn
2323

2424
## EXAMPLES
2525

26+
### Example 1
27+
This command doesn't return anything.
28+
29+
```powershell
30+
PS C:\> Remove-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis
31+
PS C:\>
32+
```
33+
2634
## PARAMETERS
2735

2836
### -DefaultProfile

src/ResourceManager/CognitiveServices/Commands.Management.CognitiveServices/help/Set-AzureRmCognitiveServicesAccount.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ The **Set-AzureRmCognitiveServicesAccount** cmdlet modifies the SKU or tags of t
2424

2525
## EXAMPLES
2626

27+
### Example 1
28+
```powershell
29+
PS C:\> Set-AzureRmCognitiveServicesAccount -ResourceGroupName cognitive-services-resource-group -name myluis -SkuName S0
30+
31+
32+
ResourceGroupName : cognitive-services-resource-group
33+
AccountName : myluis
34+
Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/cognitive-services-resource-group/providers/Microsoft.Cog
35+
nitiveServices/accounts/myluis
36+
Endpoint : https://westus.api.cognitive.microsoft.com/luis/v2.0
37+
Location : WESTUS
38+
Sku : Microsoft.Azure.Management.CognitiveServices.Models.Sku
39+
AccountType : LUIS
40+
ResourceType : Microsoft.CognitiveServices/accounts
41+
Etag : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
42+
ProvisioningState : Succeeded
43+
Tags :
44+
```
45+
2746
## PARAMETERS
2847

2948
### -DefaultProfile

0 commit comments

Comments
 (0)