Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CognitiveServices] Unify and Complete samples #21487

Merged
merged 6 commits into from
Apr 13, 2023
Merged

[CognitiveServices] Unify and Complete samples #21487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d47076e
add some outputs for Get
tianxin-ms Apr 4, 2023
33c7262
Update Get-AzCognitiveServicesAccountCommitmentPlan.md
wyunchi-ms Apr 13, 2023
4776a76
Update Get-AzCognitiveServicesAccountDeployment.md
wyunchi-ms Apr 13, 2023
bd7af6f
Update Get-AzCognitiveServicesAccountType.md
wyunchi-ms Apr 13, 2023
7a00197
Update Get-AzCognitiveServicesCommitmentPlan.md
wyunchi-ms Apr 13, 2023
b9cfe6f
Update Get-AzCognitiveServicesCommitmentTier.md
wyunchi-ms Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccount.md
View file
Open in desktop
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
13 changes: 13 additions & 0 deletions ...Services/CognitiveServices/help/Get-AzCognitiveServicesAccountCommitmentPlan.md
View file
Open in desktop
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
9 changes: 9 additions & 0 deletions ...tiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountDeployment.md
View file
Open in desktop
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
16 changes: 16 additions & 0 deletions src/CognitiveServices/CognitiveServices/help/Get-AzCognitiveServicesAccountType.md
View file
Open in desktop
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
17 changes: 15 additions & 2 deletions ...gnitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentPlan.md
View file
Open in desktop
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)
11 changes: 11 additions & 0 deletions ...gnitiveServices/CognitiveServices/help/Get-AzCognitiveServicesCommitmentTier.md
View file
Open in desktop
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