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.

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

format the help markdown files of Az.LabServices #18614

Merged
merged 2 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions src/LabServices/help/Add-AzLabServicesUserQuota.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ API to add additional user quota.

### Example 1: Increase student usage quota.
```powershell
Add-AzLabUserQuota -ResourceGroupName "group name" -LabName "lab name" -Email 'student@contoso.com' -UsageQuotaToAddToExisting $(New-Timespan -Hours 4)
Add-AzLabServicesUserQuota -ResourceGroupName "group name" -LabName "lab name" -Email 'student@contoso.com' -UsageQuotaToAddToExisting $(New-Timespan -Hours 4)
```

```output
Expand All @@ -45,8 +45,8 @@ This command increase the students quota by 4 hours.

### Example 2: Increase student usage quota with User object.
```powershell
$user = Get-AzLabUser -ResourceGroupName "group name" -LabName "lab name" -UserName 'ContosoUser12345'
$user | Add-AzLabUserQuota -UsageQuotaToAddToExisting $(New-Timespan -Hours 5)
$user = Get-AzLabServicesUser -ResourceGroupName "group name" -LabName "lab name" -UserName 'ContosoUser12345'
$user | Add-AzLabServicesUserQuota -UsageQuotaToAddToExisting $(New-Timespan -Hours 5)
```

```output
Expand Down
10 changes: 5 additions & 5 deletions src/LabServices/help/Get-AzLabServicesLab.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ API to get labs.

### Example 1: Get all labs
```powershell
Get-AzLab
Get-AzLabServicesLab
```

```output
Expand All @@ -64,7 +64,7 @@ Returns all labs for the current subscription.

### Example 2: Get a specific lab
```powershell
Get-AzLab -ResourceGroupName 'yourgroupname' -Name 'yourlabname'
Get-AzLabServicesLab -ResourceGroupName 'yourgroupname' -Name 'yourlabname'
```

```output
Expand All @@ -77,8 +77,8 @@ Get a specific lab using the resource group name and the lab name.

### Example 3: Get all labs created with a lab plan
```powershell
$plan = Get-AzLabPlan -LabPlanName 'lab plan name'
$plan | Get-AzLab -Name 'lab name'
$plan = Get-AzLabServicesLabPlan -LabPlanName 'lab plan name'
$plan | Get-AzLabServicesLab -Name 'lab name'
```

```output
Expand All @@ -91,7 +91,7 @@ Get the specific lab in a lab plan using the lab plan object and the lab name.

### Example 4: Get labs using wildcards in the lab name.
```powershell
Get-AzLab -ResourceGroupName 'group name' -Name '*lab name'
Get-AzLabServicesLab -ResourceGroupName 'group name' -Name '*lab name'
```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/LabServices/help/Get-AzLabServicesSchedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Returns the properties of a lab Schedule.

### Example 1: Get all schedules for a lab.
```powershell
Get-AzLabSchedule -ResourceGroupName "group name" -LabName "lab name"
Get-AzLabServicesSchedule -ResourceGroupName "group name" -LabName "lab name"
```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/LabServices/help/Get-AzLabServicesTemplateVM.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ API to get the template vm for the lab.

### Example 1: Get the template for the lab.
```powershell
Get-AzLabTemplateVM -ResourceGroupName "group name" -LabName "lab name"
Get-AzLabServicesTemplateVM -ResourceGroupName "group name" -LabName "lab name"
```

```output
Expand Down
2 changes: 1 addition & 1 deletion src/LabServices/help/Save-AzLabServicesLabPlanImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Saves an image from a lab VM to the attached shared image gallery.

### Example 1: Saves an image of the VM to the Shared Image Gallery.
```powershell
Save-AzLabServicesLabPlanImage -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "New Image Name" -LabVirtualMachineId "/subscriptions/<subscription Id>/resourceGroups/<group name>/providers/Microsoft.LabServices/labs/labName/virtualMachines/<vm name>"
Save-AzLabServicesLabPlanImage -ResourceGroupName "Group Name" -LabPlanName "Lab Plan Name" -Name "New Image Name" -LabVirtualMachineId "/subscriptions/<subscription Id>/resourceGroups/<group name>/providers/Microsoft.LabServices/labs/labName/virtualMachines/<vm name>"
```

This creates a new image in the Shared Image Gallery.
Expand Down
2 changes: 1 addition & 1 deletion src/LabServices/help/Send-AzLabServicesUserInvite.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Operation to invite a user to a lab.

### Example 1: Send lab invite to the user.
```powershell
Send-AzLabServicesUserInvite -ResourceGroupName "Group Name" -LabName "Lab Name" -Name "User Name" -Text "Welcome to the lab."
Send-AzLabServicesUserInvite -ResourceGroupName "Group Name" -LabName "Lab Name" -UserName "User Name" -Text "Welcome to the lab."
```

This sends an email invitation to the user with the custom text "Welcome to the lab" in the body of the email.
Expand Down