|
| 1 | +--- |
| 2 | +external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml |
| 3 | +Module Name: Az.Network |
| 4 | +online version: https://docs.microsoft.com/en-us/powershell/module/az.network/new-azexpressrouteportloa |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# New-AzExpressRoutePortLOA |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Download letter of authorization document for an express route port. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### ResourceNameParameterSet (Default) |
| 16 | +``` |
| 17 | +New-AzExpressRoutePortLOA -PortName <String> -ResourceGroupName <String> -CustomerName <String> |
| 18 | + [-Destination <String>] [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +### ResourceObjectParameterSet |
| 22 | +``` |
| 23 | +New-AzExpressRoutePortLOA -ExpressRoutePort <PSExpressRoutePort> -CustomerName <String> [-Destination <String>] |
| 24 | + [-PassThru] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] |
| 25 | +``` |
| 26 | + |
| 27 | +### ResourceIdParameterSet |
| 28 | +``` |
| 29 | +New-AzExpressRoutePortLOA -Id <String> -CustomerName <String> [-Destination <String>] [-PassThru] [-AsJob] |
| 30 | + [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>] |
| 31 | +``` |
| 32 | + |
| 33 | +## DESCRIPTION |
| 34 | +New-AzExpressRoutePortLOA cmdlet downloads a letter of authorization document in PDF format for an express route port. |
| 35 | + |
| 36 | + |
| 37 | +## EXAMPLES |
| 38 | + |
| 39 | +### Example 1 |
| 40 | +```powershell |
| 41 | +PS C:\> New-AzExpressRoutePortLOA -ResourceGroupName myRg -PortName myPort -CustomerName Contoso -Destination loa.pdf |
| 42 | +``` |
| 43 | + |
| 44 | +Download the letter of authorization document for express route port 'myPort' and store it in file 'loa.pdf'. |
| 45 | + |
| 46 | +## PARAMETERS |
| 47 | + |
| 48 | +### -AsJob |
| 49 | +Run cmdlet in the background |
| 50 | + |
| 51 | +```yaml |
| 52 | +Type: System.Management.Automation.SwitchParameter |
| 53 | +Parameter Sets: (All) |
| 54 | +Aliases: |
| 55 | + |
| 56 | +Required: False |
| 57 | +Position: Named |
| 58 | +Default value: None |
| 59 | +Accept pipeline input: False |
| 60 | +Accept wildcard characters: False |
| 61 | +``` |
| 62 | +
|
| 63 | +### -CustomerName |
| 64 | +The customer name to whom this Express Route Port is assigned to. |
| 65 | +
|
| 66 | +```yaml |
| 67 | +Type: System.String |
| 68 | +Parameter Sets: (All) |
| 69 | +Aliases: Name |
| 70 | + |
| 71 | +Required: True |
| 72 | +Position: Named |
| 73 | +Default value: None |
| 74 | +Accept pipeline input: False |
| 75 | +Accept wildcard characters: False |
| 76 | +``` |
| 77 | +
|
| 78 | +### -DefaultProfile |
| 79 | +The credentials, account, tenant, and subscription used for communication with Azure. |
| 80 | +
|
| 81 | +```yaml |
| 82 | +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer |
| 83 | +Parameter Sets: (All) |
| 84 | +Aliases: AzContext, AzureRmContext, AzureCredential |
| 85 | + |
| 86 | +Required: False |
| 87 | +Position: Named |
| 88 | +Default value: None |
| 89 | +Accept pipeline input: False |
| 90 | +Accept wildcard characters: False |
| 91 | +``` |
| 92 | +
|
| 93 | +### -Destination |
| 94 | +The output filepath to store the Letter of Authorization to. |
| 95 | +
|
| 96 | +```yaml |
| 97 | +Type: System.String |
| 98 | +Parameter Sets: (All) |
| 99 | +Aliases: |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### -ExpressRoutePort |
| 109 | +The express route port resource. |
| 110 | +
|
| 111 | +```yaml |
| 112 | +Type: Microsoft.Azure.Commands.Network.Models.PSExpressRoutePort |
| 113 | +Parameter Sets: ResourceObjectParameterSet |
| 114 | +Aliases: |
| 115 | + |
| 116 | +Required: True |
| 117 | +Position: Named |
| 118 | +Default value: None |
| 119 | +Accept pipeline input: False |
| 120 | +Accept wildcard characters: False |
| 121 | +``` |
| 122 | +
|
| 123 | +### -Id |
| 124 | +ResourceId of the express route port. |
| 125 | +
|
| 126 | +```yaml |
| 127 | +Type: System.String |
| 128 | +Parameter Sets: ResourceIdParameterSet |
| 129 | +Aliases: ResourceId |
| 130 | + |
| 131 | +Required: True |
| 132 | +Position: Named |
| 133 | +Default value: None |
| 134 | +Accept pipeline input: True (ByPropertyName) |
| 135 | +Accept wildcard characters: False |
| 136 | +``` |
| 137 | +
|
| 138 | +### -PassThru |
| 139 | +Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. |
| 140 | +
|
| 141 | +```yaml |
| 142 | +Type: System.Management.Automation.SwitchParameter |
| 143 | +Parameter Sets: (All) |
| 144 | +Aliases: |
| 145 | + |
| 146 | +Required: False |
| 147 | +Position: Named |
| 148 | +Default value: None |
| 149 | +Accept pipeline input: False |
| 150 | +Accept wildcard characters: False |
| 151 | +``` |
| 152 | +
|
| 153 | +### -PortName |
| 154 | +The express route port name. |
| 155 | +
|
| 156 | +```yaml |
| 157 | +Type: System.String |
| 158 | +Parameter Sets: ResourceNameParameterSet |
| 159 | +Aliases: |
| 160 | + |
| 161 | +Required: True |
| 162 | +Position: Named |
| 163 | +Default value: None |
| 164 | +Accept pipeline input: False |
| 165 | +Accept wildcard characters: False |
| 166 | +``` |
| 167 | +
|
| 168 | +### -ResourceGroupName |
| 169 | +The resource group name of the express route port. |
| 170 | +
|
| 171 | +```yaml |
| 172 | +Type: System.String |
| 173 | +Parameter Sets: ResourceNameParameterSet |
| 174 | +Aliases: |
| 175 | + |
| 176 | +Required: True |
| 177 | +Position: Named |
| 178 | +Default value: None |
| 179 | +Accept pipeline input: False |
| 180 | +Accept wildcard characters: False |
| 181 | +``` |
| 182 | +
|
| 183 | +### CommonParameters |
| 184 | +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). |
| 185 | +
|
| 186 | +## INPUTS |
| 187 | +
|
| 188 | +### System.String |
| 189 | +
|
| 190 | +## OUTPUTS |
| 191 | +
|
| 192 | +### System.Boolean |
| 193 | +
|
| 194 | +## NOTES |
| 195 | +
|
| 196 | +## RELATED LINKS |
0 commit comments