Set-AzNetworkManager

  • Reference
Module:
Az.Network

Updates a network manager..

Syntax

Set-AzNetworkManager
   -InputObject <PSNetworkManager>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzNetworkManager cmdlet updates a network manager.

Examples

Example 1

$networkManager = Get-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager"
$networkManager.Description = "updated description"
Set-AzNetworkManager -InputObject $networkManager

Location                        : westus
Tag                             : {}
NetworkManagerScopes            : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes
NetworkManagerScopeAccesses     : {Connectivity, SecurityAdmin}
NetworkManagerScopeAccessesText : [
                                    "Connectivity",
                                    "SecurityAdmin"
                                  ]
NetworkManagerScopesText        : {
                                    "ManagementGroups": [
                                      "/providers/Microsoft.Management/managementGroups/PowerShellTest"
                                    ],
                                    "Subscriptions": [
                                      "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884"
                                    ]
                                  }
TagsTable                       :
DisplayName                     :
Description                     : updated description
Type                            : Microsoft.Network/networkManagers
ProvisioningState               : Succeeded
SystemData                      : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData
SystemDataText                  : {
                                    "CreatedBy": "jaredgorthy@microsoft.com",
                                    "CreatedByType": "User",
                                    "CreatedAt": "2022-08-07T04:12:51.7463424Z",
                                    "LastModifiedBy": "jaredgorthy@microsoft.com",
                                    "LastModifiedByType": "User",
                                    "LastModifiedAt": "2022-08-08T00:50:28.6707606Z"
                                  }
Name                            : psNetworkManager
Etag                            :
Id                              : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager

Example to update the description of a network manager.

Example 2

$networkManager = Get-AzNetworkManager -ResourceGroupName "psResourceGroup" -Name "psNetworkManager"
$access  = @("Connectivity", "SecurityAdmin")
$networkManager.NetworkManagerScopeAccesses = $access
Set-AzNetworkManager -InputObject $networkManager

Location                        : westus
Tag                             : {}
NetworkManagerScopes            : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSNetworkManagerScopes
NetworkManagerScopeAccesses     : {Connectivity, SecurityAdmin}
NetworkManagerScopeAccessesText : [
                                    "Connectivity",
                                    "SecurityAdmin"
                                  ]
NetworkManagerScopesText        : {
                                    "ManagementGroups": [
                                      "/providers/Microsoft.Management/managementGroups/PowerShellTest"
                                    ],
                                    "Subscriptions": [
                                      "/subscriptions/0fd190fa-dd1c-4724-b7f6-c5cc3ba5c884"
                                    ]
                                  }
TagsTable                       :
DisplayName                     :
Description                     : updated description
Type                            : Microsoft.Network/networkManagers
ProvisioningState               : Succeeded
SystemData                      : Microsoft.Azure.Commands.Network.Models.NetworkManager.PSSystemData
SystemDataText                  : {
                                    "CreatedBy": "jaredgorthy@microsoft.com",
                                    "CreatedByType": "User",
                                    "CreatedAt": "2022-08-07T04:12:51.7463424Z",
                                    "LastModifiedBy": "jaredgorthy@microsoft.com",
                                    "LastModifiedByType": "User",
                                    "LastModifiedAt": "2022-08-08T00:52:45.0100913Z"
                                  }
Name                            : psNetworkManager
Etag                            :
Id                              : /subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b/resourceGroups/psResourceGroup/providers/Microsoft.Network/networkManagers/psNetworkManager

Updates a network manager scope access.

Parameters

-AsJob

Run cmdlet in the background

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The Network Manager

Type:PSNetworkManager
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

PSNetworkManager

Outputs

PSNetworkManager