Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - NetworkCloud")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.2.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("1.2.0")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("2.0.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("2.0.0")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]
6 changes: 3 additions & 3 deletions src/NetworkCloud/NetworkCloud.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ For information on how to develop for `Az.NetworkCloud`, see [how-to.md](how-to.

```yaml
# pin the swagger version by using the commit id instead of branch name : https://github.com/Azure/azure-rest-api-specs/
# the 2025-02-01 stable in a commit: 08973141b0d31a7e75d4dc43a5224a1814a0994f
commit: 08973141b0d31a7e75d4dc43a5224a1814a0994f
# the 2025-09-01 stable in a commit: ccd751d5bf9d1457426de7fe6d857a4cfe890cd5
commit: ccd751d5bf9d1457426de7fe6d857a4cfe890cd5
require:
# readme.azure.noprofile.md is the common configuration file
- $(this-folder)/../../readme.azure.noprofile.md
- $(repo)/specification/networkcloud/resource-manager/readme.md
input-file:
# You need to specify your swagger files here.
- $(repo)/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-02-01/networkcloud.json
- $(repo)/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2025-09-01/networkcloud.json

# For new RP, the version is 0.1.0
module-version: 0.1.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "bareMetalMachines",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "cloudServicesNetworks",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "clusterManagers",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "clusters/bareMetalMachineKeySets",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "clusters/bmcKeySets",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "clusters/metricsConfigurations",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "clusters",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "kubernetesClusters/agentPools",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "kubernetesClusters/features",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "kubernetesClusters",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "l2Networks",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "l3Networks",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "rackSkus",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "racks",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageAppliances",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "trunkedNetworks",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "virtualMachines/consoles",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "virtualMachines",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "volumes",
"apiVersion": "2025-02-01",
"apiVersion": "2025-09-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.networkcloud"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# region Generated
# Load the private module dll
$null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.NetworkCloud.private.dll')
$null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '../bin/Az.NetworkCloud.private.dll')

# Load the internal module
$internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.NetworkCloud.internal.psm1'
$internalModulePath = Join-Path $PSScriptRoot '../internal/Az.NetworkCloud.internal.psm1'
if(Test-Path $internalModulePath) {
$null = Import-Module -Name $internalModulePath
}
Expand Down
8 changes: 4 additions & 4 deletions src/NetworkCloud/NetworkCloud.Autorest/custom/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Custom
This directory contains custom implementation for non-generated cmdlets for the `Az.NetworkCloud` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.NetworkCloud.custom.psm1`. This file should not be modified.
This directory contains custom implementation for non-generated cmdlets for the `Az.NetworkCloud` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.NetworkCloud.custom.psm1`. This file should not be modified.

## Info
- Modifiable: yes
Expand All @@ -15,10 +15,10 @@ For C# cmdlets, they are compiled with the rest of the generated low-level cmdle
For script cmdlets, these are loaded via the `Az.NetworkCloud.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.

## Purpose
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder.

## Usage
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
- Break
- DefaultProfile
- HttpPipelineAppend
Expand All @@ -36,6 +36,6 @@ For processing the cmdlets, we've created some additional attributes:
- `Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.DoNotExportAttribute`
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.NetworkCloud`.
- `Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.InternalExportAttribute`
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.NetworkCloud`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.NetworkCloud`. For more information, see [README.md](../internal/README.md) in the `../internal` folder.
- `Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.ProfileAttribute`
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ function New-AzNetworkCloudBareMetalMachineConfigurationDataObject {
[Parameter(HelpMessage="The free-form additional information about the machine, e.g. an asset tag.")]
[string]
$MachineDetail,
[Parameter(HelpMessage="The user-provided name for the bare metal machine created from this specification.
If not provided, the machine name will be generated programmatically.")]
[Parameter(HelpMessage="The user-provided name for the bare metal machine created from this specification. If not provided, the machine name will be generated programmatically.")]
[string]
$MachineName,
[Parameter(Mandatory, HelpMessage="The slot the physical machine is in the rack based on the BOM configuration.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,45 +31,24 @@ function New-AzNetworkCloudNetworkAttachmentObject {
[CmdletBinding(PositionalBinding=$false)]
Param(

[Parameter(Mandatory, HelpMessage="The resource ID of the associated network attached to the virtual machine.
It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.")]
[Parameter(Mandatory, HelpMessage="The resource ID of the associated network attached to the virtual machine. It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.")]
[string]
$AttachedNetworkId,
[Parameter(HelpMessage="The indicator of whether this is the default gateway.
Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.")]
[Parameter(HelpMessage="The indicator of whether this is the default gateway. Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True.")]
[Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.PSArgumentCompleterAttribute("True", "False")]
[string]
$DefaultGateway,
[Parameter(Mandatory, HelpMessage="The IP allocation mechanism for the virtual machine.
Dynamic and Static are only valid for l3Network which may also specify Disabled.
Otherwise, Disabled is the only permitted value.")]
[Parameter(Mandatory, HelpMessage="The IP allocation mechanism for the virtual machine. Dynamic and Static are only valid for l3Network which may also specify Disabled. Otherwise, Disabled is the only permitted value.")]
[Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.PSArgumentCompleterAttribute("Dynamic", "Static", "Disabled")]
[string]
$IPAllocationMethod,
[Parameter(HelpMessage="The IPv4 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV4 or DualStack.

If IPAllocationMethod is:
Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network.
Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network.
Disabled - this field will be empty.")]
[Parameter(HelpMessage="The IPv4 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. If IPAllocationMethod is: Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. Disabled - this field will be empty.")]
[string]
$Ipv4Address,
[Parameter(HelpMessage="The IPv6 address of the virtual machine.

This field is used only if the attached network has IPAllocationType of IPV6 or DualStack.

If IPAllocationMethod is:
Static - this field must contain an IPv6 address range from within the range specified in the attached network.
Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network.
Disabled - this field will be empty.")]
[Parameter(HelpMessage="The IPv6 address of the virtual machine. This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. If IPAllocationMethod is: Static - this field must contain an IPv6 address range from within the range specified in the attached network. Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. Disabled - this field will be empty.")]
[string]
$Ipv6Address,
[Parameter(HelpMessage="The associated network's interface name.
If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine.
If the user doesn’t specify this value, the default interface name of the network resource will be used.
For a CloudServicesNetwork resource, this name will be ignored.")]
[Parameter(HelpMessage="The associated network's interface name. If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. If the user doesn’t specify this value, the default interface name of the network resource will be used. For a CloudServicesNetwork resource, this name will be ignored.")]
[string]
$Name
)
Expand Down
12 changes: 9 additions & 3 deletions src/NetworkCloud/NetworkCloud.Autorest/docs/Az.NetworkCloud.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
Module Name: Az.NetworkCloud
Module Guid: eb2cc21e-b11c-4bd1-93b0-ddc86e985310
Module Guid: 8e193e71-a894-4938-9445-8cbd6d525411
Download Help Link: https://learn.microsoft.com/powershell/module/az.networkcloud
Help Version: 1.0.0.0
Locale: en-US
Expand Down Expand Up @@ -84,6 +84,10 @@ Cordon the provided bare metal machine's Kubernetes node.
Run one or more data extractions on the provided bare metal machine.
The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.

### [Invoke-AzNetworkCloudBareMetalMachineDataExtractRestricted](Invoke-AzNetworkCloudBareMetalMachineDataExtractRestricted.md)
Run one or more restricted data extractions on the provided bare metal machine.
The URL to storage account with the command execution results and the command exit code can be retrieved from the operation status API once available.

### [Invoke-AzNetworkCloudBareMetalMachineReimage](Invoke-AzNetworkCloudBareMetalMachineReimage.md)
Reimage the provided bare metal machine.

Expand Down Expand Up @@ -260,6 +264,9 @@ Restart the provided virtual machine.
### [Start-AzNetworkCloudBareMetalMachine](Start-AzNetworkCloudBareMetalMachine.md)
Start the provided bare metal machine.

### [Start-AzNetworkCloudStorageApplianceReadCommand](Start-AzNetworkCloudStorageApplianceReadCommand.md)
Run one or more read-only commands on the provided storage appliance.

### [Start-AzNetworkCloudVirtualMachine](Start-AzNetworkCloudVirtualMachine.md)
Start the provided virtual machine.

Expand Down Expand Up @@ -327,8 +334,7 @@ Update properties of the provided storage appliance, or update tags associated w
Update tags associated with the provided trunked network.

### [Update-AzNetworkCloudVirtualMachine](Update-AzNetworkCloudVirtualMachine.md)
Patch the properties of the provided virtual machine, or update the tags associated with the virtual machine.
Properties and tag update can be done independently.
Update a new virtual machine or update the properties of the existing virtual machine.

### [Update-AzNetworkCloudVolume](Update-AzNetworkCloudVolume.md)
Update tags associated with the provided volume.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Get properties of the provided Kubernetes cluster agent pool.
### List (Default)
```
Get-AzNetworkCloudAgentPool -KubernetesClusterName <String> -ResourceGroupName <String>
[-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
[-SubscriptionId <String[]>] [-SkipToken <String>] [-Top <Int32>] [-DefaultProfile <PSObject>]
[<CommonParameters>]
```

### Get
Expand Down Expand Up @@ -162,6 +163,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -SkipToken
The opaque token that the server returns to indicate where to continue listing resources from.
This is used for paging through large result sets.

```yaml
Type: System.String
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Expand All @@ -178,6 +195,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -Top
The maximum number of resources to return from the operation.
Example: '$top=10'.

```yaml
Type: System.Int32
Parameter Sets: List
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

Expand Down
Loading