Skip to content

Commit 6ee7e14

Browse files
authored
[Az.ScVmm] Minor Doc/Description Update for Az.ScVmm Cmdlets (Azure#27637)
1 parent 9d36a08 commit 6ee7e14

16 files changed

+36
-36
lines changed

src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMDisk.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Get-AzScVmmVMDisk -vmName "test-vm" -ResourceGroupName "test-rg-01" -DiskName "d
2727
.Outputs
2828
Microsoft.Azure.PowerShell.Cmdlets.ScVmm.Models.VirtualDisk
2929
.Link
30-
https://learn.microsoft.com/powershell/module/az.scvmm/update-azscvmmvmdisk
30+
https://learn.microsoft.com/powershell/module/az.scvmm/get-azscvmmvmdisk
3131
#>
3232

3333
function Get-AzScVmmVMDisk {

src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMGuestAgent.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
<#
1818
.Synopsis
19-
Implements GuestAgent GET method.
19+
Implements Azure Arc agent GET method.
2020
.Description
21-
Implements GuestAgent GET method.
21+
Implements Azure Arc agent GET method.
2222
.Example
2323
Get-AzScVmmVMGuestAgent -Name "test-vm" -ResourceGroupName "test-rg-01"
2424

src/ScVmm/ScVmm.Autorest/custom/Get-AzScVmmVMNic.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Get-AzScVmmVMNic -vmName "test-vm" -ResourceGroupName "test-rg-01" -NicName "nic
2727
.Outputs
2828
Microsoft.Azure.PowerShell.Cmdlets.ScVmm.Models.INetworkInterface
2929
.Link
30-
https://learn.microsoft.com/powershell/module/az.scvmm/update-azscvmmvmnic
30+
https://learn.microsoft.com/powershell/module/az.scvmm/get-azscvmmvmnic
3131
#>
3232

3333
function Get-AzScVmmVMNic {

src/ScVmm/ScVmm.Autorest/custom/New-AzScVmmVMExtension.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

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

src/ScVmm/ScVmm.Autorest/custom/New-AzScVmmVMGuestAgent.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
<#
1818
.Synopsis
19-
Enables Guest Management on the Virtual Machine.
19+
Installs Azure Arc agent on the Virtual Machine.
2020
.Description
21-
Enables Guest Management on the Virtual Machine by installing GuestAgent.
21+
Installs Azure Arc agent on the Virtual Machine
2222
.Example
2323
$securePassword = ConvertTo-SecureString "*****" -AsPlainText -Force
2424
New-AzScVmmVMGuestAgent -Name "test-vm" -ResourceGroupName "test-rg-01" -CredentialsPassword $securePassword -CredentialsUsername 'testUser'

src/ScVmm/ScVmm.Autorest/docs/Az.ScVmm.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The operation to Get a virtual machine virtual disk.
4242
The operation to get the extension on a virtual machine.
4343

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

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

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

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

9090
### [New-AzScVmmVMTemplate](New-AzScVmmVMTemplate.md)
9191
Onboards the ScVmm VM Template as an Azure VM Template resource.

src/ScVmm/ScVmm.Autorest/docs/Get-AzScVmmVMGuestAgent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzScVmmVMGuestAgent
99

1010
## SYNOPSIS
11-
Implements GuestAgent GET method.
11+
Implements Azure Arc agent GET method.
1212

1313
## SYNTAX
1414

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

2020
## DESCRIPTION
21-
Implements GuestAgent GET method.
21+
Implements Azure Arc agent GET method.
2222

2323
## EXAMPLES
2424

src/ScVmm/ScVmm.Autorest/docs/New-AzScVmmVMExtension.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzScVmmVMExtension
99

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

1313
## SYNTAX
1414

@@ -36,7 +36,7 @@ New-AzScVmmVMExtension -ExtensionName <String> -ResourceGroupName <String> -vmNa
3636
```
3737

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

4141
## EXAMPLES
4242

src/ScVmm/ScVmm.Autorest/docs/New-AzScVmmVMGuestAgent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzScVmmVMGuestAgent
99

1010
## SYNOPSIS
11-
Enables Guest Management on the Virtual Machine.
11+
Installs Azure Arc agent on the Virtual Machine.
1212

1313
## SYNTAX
1414

@@ -34,7 +34,7 @@ New-AzScVmmVMGuestAgent -Name <String> -ResourceGroupName <String> -JsonString <
3434
```
3535

3636
## DESCRIPTION
37-
Enables Guest Management on the Virtual Machine by installing GuestAgent.
37+
Installs Azure Arc agent on the Virtual Machine
3838

3939
## EXAMPLES
4040

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"generate_Id": "d334a7e3-c35d-4235-98a5-7215ccd4fce7"
2+
"generate_Id": "2e00b7d3-20cc-4d79-9637-d046d7720a57"
33
}

src/ScVmm/ScVmm.sln

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accoun
1919
EndProject
2020
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScVmm", "ScVmm\ScVmm.csproj", "{8F1EBE02-A595-4A87-9672-C332B3DBB508}"
2121
EndProject
22-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ScVmm", "ScVmm.Autorest\Az.ScVmm.csproj", "{BA4A1061-2B77-44D9-967F-DAAE93F8A850}"
22+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.ScVmm", "ScVmm.Autorest\Az.ScVmm.csproj", "{52825CC6-7E06-4022-9011-0F62EB9660F3}"
2323
EndProject
2424
Global
2525
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -58,10 +58,10 @@ Global
5858
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Debug|Any CPU.Build.0 = Debug|Any CPU
5959
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Release|Any CPU.ActiveCfg = Release|Any CPU
6060
{8F1EBE02-A595-4A87-9672-C332B3DBB508}.Release|Any CPU.Build.0 = Release|Any CPU
61-
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
62-
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Debug|Any CPU.Build.0 = Debug|Any CPU
63-
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Release|Any CPU.ActiveCfg = Release|Any CPU
64-
{BA4A1061-2B77-44D9-967F-DAAE93F8A850}.Release|Any CPU.Build.0 = Release|Any CPU
61+
{52825CC6-7E06-4022-9011-0F62EB9660F3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
62+
{52825CC6-7E06-4022-9011-0F62EB9660F3}.Debug|Any CPU.Build.0 = Debug|Any CPU
63+
{52825CC6-7E06-4022-9011-0F62EB9660F3}.Release|Any CPU.ActiveCfg = Release|Any CPU
64+
{52825CC6-7E06-4022-9011-0F62EB9660F3}.Release|Any CPU.Build.0 = Release|Any CPU
6565
EndGlobalSection
6666
GlobalSection(NestedProjects) = preSolution
6767
{D6AED500-9C33-4433-B3CA-7ED0378E2D5F} = {BA575CE4-A31F-490C-894B-58430EA1CF10}

src/ScVmm/ScVmm/Az.ScVmm.psd1

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Microsoft Corporation
55
#
6-
# Generated on: 3/21/2025
6+
# Generated on: 5/7/2025
77
#
88

99
@{
@@ -30,7 +30,7 @@ CompanyName = 'Microsoft Corporation'
3030
Copyright = 'Microsoft Corporation. All rights reserved.'
3131

3232
# Description of the functionality provided by this module
33-
Description = 'Microsoft Azure PowerShell: ScVmm cmdlets'
33+
Description = 'Azure PowerShell cmdlets for managing Arc for SCVMM resources'
3434

3535
# Minimum version of the PowerShell engine required by this module
3636
PowerShellVersion = '5.1'
@@ -51,7 +51,7 @@ DotNetFrameworkVersion = '4.7.2'
5151
# ProcessorArchitecture = ''
5252

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

5656
# Assemblies that must be loaded prior to importing this module
5757
RequiredAssemblies = 'ScVmm.Autorest/bin/Az.ScVmm.private.dll'

src/ScVmm/ScVmm/help/Az.ScVmm.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Locale: en-US
88

99
# Az.ScVmm Module
1010
## Description
11-
Microsoft Azure PowerShell: ScVmm cmdlets
11+
Azure PowerShell cmdlets for managing Arc for SCVMM resources
1212

1313
## Az.ScVmm Cmdlets
1414
### [Add-AzScVmmVMDisk](Add-AzScVmmVMDisk.md)
@@ -42,7 +42,7 @@ The operation to Get a virtual machine virtual disk.
4242
The operation to get the extension on a virtual machine.
4343

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

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

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

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

9090
### [New-AzScVmmVMTemplate](New-AzScVmmVMTemplate.md)
9191
Onboards the ScVmm VM Template as an Azure VM Template resource.

src/ScVmm/ScVmm/help/Get-AzScVmmVMGuestAgent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Get-AzScVmmVMGuestAgent
99

1010
## SYNOPSIS
11-
Implements GuestAgent GET method.
11+
Implements Azure Arc agent GET method.
1212

1313
## SYNTAX
1414

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

2020
## DESCRIPTION
21-
Implements GuestAgent GET method.
21+
Implements Azure Arc agent GET method.
2222

2323
## EXAMPLES
2424

src/ScVmm/ScVmm/help/New-AzScVmmVMExtension.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzScVmmVMExtension
99

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

1313
## SYNTAX
1414

@@ -36,7 +36,7 @@ New-AzScVmmVMExtension -ExtensionName <String> -vmName <String> -ResourceGroupNa
3636
```
3737

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

4141
## EXAMPLES
4242

src/ScVmm/ScVmm/help/New-AzScVmmVMGuestAgent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# New-AzScVmmVMGuestAgent
99

1010
## SYNOPSIS
11-
Enables Guest Management on the Virtual Machine.
11+
Installs Azure Arc agent on the Virtual Machine.
1212

1313
## SYNTAX
1414

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

3535
## DESCRIPTION
36-
Enables Guest Management on the Virtual Machine by installing GuestAgent.
36+
Installs Azure Arc agent on the Virtual Machine
3737

3838
## EXAMPLES
3939

0 commit comments

Comments
 (0)