Skip to content

[Az.ScVmm] Minor Doc/Description Update for Az.ScVmm Cmdlets #27637

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
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
2 changes: 1 addition & 1 deletion src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMDisk.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Get-AzScVmmVMDisk -vmName "test-vm" -ResourceGroupName "test-rg-01" -DiskName "d
.Outputs
Microsoft.Azure.PowerShell.Cmdlets.ScVmm.Models.VirtualDisk
.Link
https://learn.microsoft.com/powershell/module/az.scvmm/update-azscvmmvmdisk
https://learn.microsoft.com/powershell/module/az.scvmm/get-azscvmmvmdisk
#>

function Get-AzScVmmVMDisk {
Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMGuestAgent.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

<#
.Synopsis
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.
.Description
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.
.Example
Get-AzScVmmVMGuestAgent -Name "test-vm" -ResourceGroupName "test-rg-01"

Expand Down
2 changes: 1 addition & 1 deletion src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMNic.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Get-AzScVmmVMNic -vmName "test-vm" -ResourceGroupName "test-rg-01" -NicName "nic
.Outputs
Microsoft.Azure.PowerShell.Cmdlets.ScVmm.Models.INetworkInterface
.Link
https://learn.microsoft.com/powershell/module/az.scvmm/update-azscvmmvmnic
https://learn.microsoft.com/powershell/module/az.scvmm/get-azscvmmvmnic
#>

function Get-AzScVmmVMNic {
Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/custom/New-AzScVmmVMExtension.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

<#
.Synopsis
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.
.Description
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.
.Example
New-AzScVmmVMExtension -vmName 'test-vm' -ResourceGroupName 'test-rg-01' -Location 'eastus' -ExtensionName 'RunCommand' -Type 'CustomScriptExtension' -Publisher 'Microsoft.Compute' -Setting @{"commandToExecute"= "whoami"}

Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/custom/New-AzScVmmVMGuestAgent.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@

<#
.Synopsis
Enables Guest Management on the Virtual Machine.
Installs Azure Arc agent on the Virtual Machine.
.Description
Enables Guest Management on the Virtual Machine by installing GuestAgent.
Installs Azure Arc agent on the Virtual Machine
.Example
$securePassword = ConvertTo-SecureString "*****" -AsPlainText -Force
New-AzScVmmVMGuestAgent -Name "test-vm" -ResourceGroupName "test-rg-01" -CredentialsPassword $securePassword -CredentialsUsername 'testUser'
Expand Down
6 changes: 3 additions & 3 deletions src/ScVmm/ScVmm.Autorest/docs/Az.ScVmm.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The operation to Get a virtual machine virtual disk.
The operation to get the extension on a virtual machine.

### [Get-AzScVmmVMGuestAgent](Get-AzScVmmVMGuestAgent.md)
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

### [Get-AzScVmmVMNic](Get-AzScVmmVMNic.md)
The operation to Get a virtual machine network interface.
Expand Down Expand Up @@ -82,10 +82,10 @@ Please note some properties can be set only during virtual machine creation.
create a checkpoint in virtual machine.

### [New-AzScVmmVMExtension](New-AzScVmmVMExtension.md)
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

### [New-AzScVmmVMGuestAgent](New-AzScVmmVMGuestAgent.md)
Enables Guest Management on the Virtual Machine.
Installs Azure Arc agent on the Virtual Machine.

### [New-AzScVmmVMTemplate](New-AzScVmmVMTemplate.md)
Onboards the ScVmm VM Template as an Azure VM Template resource.
Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/docs/Get-AzScVmmVMGuestAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzScVmmVMGuestAgent

## SYNOPSIS
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Get-AzScVmmVMGuestAgent -Name <String> -ResourceGroupName <String> [-Subscriptio
```

## DESCRIPTION
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/docs/New-AzScVmmVMExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzScVmmVMExtension

## SYNOPSIS
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

## SYNTAX

Expand Down Expand Up @@ -36,7 +36,7 @@ New-AzScVmmVMExtension -ExtensionName <String> -ResourceGroupName <String> -vmNa
```

## DESCRIPTION
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm.Autorest/docs/New-AzScVmmVMGuestAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzScVmmVMGuestAgent

## SYNOPSIS
Enables Guest Management on the Virtual Machine.
Installs Azure Arc agent on the Virtual Machine.

## SYNTAX

Expand All @@ -34,7 +34,7 @@ New-AzScVmmVMGuestAgent -Name <String> -ResourceGroupName <String> -JsonString <
```

## DESCRIPTION
Enables Guest Management on the Virtual Machine by installing GuestAgent.
Installs Azure Arc agent on the Virtual Machine

## EXAMPLES

Expand Down
2 changes: 1 addition & 1 deletion src/ScVmm/ScVmm.Autorest/generate-info.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"generate_Id": "d334a7e3-c35d-4235-98a5-7215ccd4fce7"
"generate_Id": "f835e478-7ed8-4b94-bbd5-7b5fd03d5a06"
}
10 changes: 5 additions & 5 deletions src/ScVmm/ScVmm.sln
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accoun
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScVmm", "ScVmm\ScVmm.csproj", "{8F1EBE02-A595-4A87-9672-C332B3DBB508}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ScVmm", "ScVmm.Autorest\Az.ScVmm.csproj", "{BA4A1061-2B77-44D9-967F-DAAE93F8A850}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ScVmm", "ScVmm.Autorest\Az.ScVmm.csproj", "{9EC5E798-3ABE-4DD1-B4AC-EAC5F6415788}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down Expand Up @@ -58,10 +58,10 @@ Global
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Release|Any CPU.Build.0 = Release|Any CPU
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Debug|Any CPU.Build.0 = Debug|Any CPU
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Release|Any CPU.ActiveCfg = Release|Any CPU
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Release|Any CPU.Build.0 = Release|Any CPU
{9EC5E798-3ABE-4DD1-B4AC-EAC5F6415788}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{9EC5E798-3ABE-4DD1-B4AC-EAC5F6415788}.Debug|Any CPU.Build.0 = Debug|Any CPU
{9EC5E798-3ABE-4DD1-B4AC-EAC5F6415788}.Release|Any CPU.ActiveCfg = Release|Any CPU
{9EC5E798-3ABE-4DD1-B4AC-EAC5F6415788}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{D6AED500-9C33-4433-B3CA-7ED0378E2D5F} = {BA575CE4-A31F-490C-894B-58430EA1CF10}
Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm/Az.ScVmm.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Microsoft Corporation
#
# Generated on: 3/21/2025
# Generated on: 4/24/2025
#

@{
Expand Down Expand Up @@ -51,7 +51,7 @@ DotNetFrameworkVersion = '4.7.2'
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.0.2'; })
RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '4.1.0'; })

# Assemblies that must be loaded prior to importing this module
RequiredAssemblies = 'ScVmm.Autorest/bin/Az.ScVmm.private.dll'
Expand Down
14 changes: 7 additions & 7 deletions src/ScVmm/ScVmm/help/Az.ScVmm.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
Module Name: Az.ScVmm
Module Guid: {{ Update Module Guid }}
Download Help Link: {{ Update Download Link }}
Help Version: {{ Update Help Version }}
Locale: {{ Update Locale }}
Module Guid: accceef6-8113-453a-a31c-4f2ce57893d6
Download Help Link: https://learn.microsoft.com/powershell/module/az.scvmm
Help Version: 1.0.0.0
Locale: en-US
---

# Az.ScVmm Module
Expand Down Expand Up @@ -42,7 +42,7 @@ The operation to Get a virtual machine virtual disk.
The operation to get the extension on a virtual machine.

### [Get-AzScVmmVMGuestAgent](Get-AzScVmmVMGuestAgent.md)
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

### [Get-AzScVmmVMNic](Get-AzScVmmVMNic.md)
The operation to Get a virtual machine network interface.
Expand Down Expand Up @@ -82,10 +82,10 @@ Please note some properties can be set only during virtual machine creation.
create a checkpoint in virtual machine.

### [New-AzScVmmVMExtension](New-AzScVmmVMExtension.md)
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

### [New-AzScVmmVMGuestAgent](New-AzScVmmVMGuestAgent.md)
Enables Guest Management on the Virtual Machine.
Installs Azure Arc agent on the Virtual Machine.

### [New-AzScVmmVMTemplate](New-AzScVmmVMTemplate.md)
Onboards the ScVmm VM Template as an Azure VM Template resource.
Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm/help/Get-AzScVmmVMGuestAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-AzScVmmVMGuestAgent

## SYNOPSIS
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

## SYNTAX

Expand All @@ -18,7 +18,7 @@ Get-AzScVmmVMGuestAgent -Name <String> -ResourceGroupName <String> [-Subscriptio
```

## DESCRIPTION
Implements GuestAgent GET method.
Implements Azure Arc agent GET method.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm/help/New-AzScVmmVMExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzScVmmVMExtension

## SYNOPSIS
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

## SYNTAX

Expand Down Expand Up @@ -36,7 +36,7 @@ New-AzScVmmVMExtension -ExtensionName <String> -vmName <String> -ResourceGroupNa
```

## DESCRIPTION
The operation to create the extension on a virtual machine where Guest Management is enabled.
The operation to create the extension on a virtual machine where Azure Arc agent is installed.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions src/ScVmm/ScVmm/help/New-AzScVmmVMGuestAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzScVmmVMGuestAgent

## SYNOPSIS
Enables Guest Management on the Virtual Machine.
Installs Azure Arc agent on the Virtual Machine.

## SYNTAX

Expand All @@ -33,7 +33,7 @@ New-AzScVmmVMGuestAgent -Name <String> -ResourceGroupName <String> [-Subscriptio
```

## DESCRIPTION
Enables Guest Management on the Virtual Machine by installing GuestAgent.
Installs Azure Arc agent on the Virtual Machine

## EXAMPLES

Expand Down