Skip to content

Commit 593846b

Browse files
brandonv191brandonv191
committed
Add help md files
1 parent 99176e7 commit 593846b

File tree

2 files changed

+200
-5
lines changed

2 files changed

+200
-5
lines changed

‎src/Network/Network/help/New-AzVirtualNetworkGatewayCertificateAuthentication.md‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
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-azvirtualnetworkgatewaycertificateauthentication
5+
schema: 2.0.0
6+
---
7+
8+
# New-AzVirtualNetworkGatewayCertificateAuthentication
9+
10+
## SYNOPSIS
11+
Creates a certificate authentication object for VPN gateway connections.
12+
13+
## SYNTAX
14+
15+
```
16+
New-AzVirtualNetworkGatewayCertificateAuthentication [-OutboundAuthCertificate <String>]
17+
[-InboundAuthCertificateSubjectName <String>] [-InboundAuthCertificateChain <String[]>]
18+
[-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
19+
```
20+
21+
## DESCRIPTION
22+
The New-AzVirtualNetworkGatewayCertificateAuthentication cmdlet creates a certificate authentication object that can be used with New-AzVirtualNetworkGatewayConnection to configure certificate-based authentication for VPN gateway connections. This enables secure authentication using certificates instead of pre-shared keys.
23+
24+
## EXAMPLES
25+
26+
### Example 1: Create a certificate authentication object with outbound certificate
27+
```powershell
28+
PS C:\> $certAuth = New-AzVirtualNetworkGatewayCertificateAuthentication -OutboundAuthCertificate "https://myvault.vault.azure.net/secrets/client-cert"
29+
```
30+
31+
Creates a certificate authentication object with only an outbound authentication certificate from Azure Key Vault.
32+
33+
### Example 2: Create a complete certificate authentication object
34+
```powershell
35+
PS C:\> $certChain = @("-----BEGIN CERTIFICATE-----`nMIIC...`n-----END CERTIFICATE-----")
36+
PS C:\> $certAuth = New-AzVirtualNetworkGatewayCertificateAuthentication -OutboundAuthCertificate "https://myvault.vault.azure.net/secrets/client-cert" -InboundAuthCertificateSubjectName "CN=MyRootCA,O=MyOrg,C=US" -InboundAuthCertificateChain $certChain
37+
```
38+
39+
Creates a complete certificate authentication object with outbound certificate, inbound certificate subject name, and certificate chain.
40+
41+
## PARAMETERS
42+
43+
### -DefaultProfile
44+
The credentials, account, tenant, and subscription used for communication with Azure.
45+
46+
```yaml
47+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
48+
Parameter Sets: (All)
49+
Aliases: AzContext, AzureRmContext, AzureCredential
50+
51+
Required: False
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -InboundAuthCertificateChain
59+
Inbound authentication certificate public keys.
60+
61+
```yaml
62+
Type: System.String[]
63+
Parameter Sets: (All)
64+
Aliases:
65+
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: True (ByPropertyName)
70+
Accept wildcard characters: False
71+
```
72+
73+
### -InboundAuthCertificateSubjectName
74+
Inbound authentication certificate subject name.
75+
76+
```yaml
77+
Type: System.String
78+
Parameter Sets: (All)
79+
Aliases:
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: True (ByPropertyName)
85+
Accept wildcard characters: False
86+
```
87+
88+
### -OutboundAuthCertificate
89+
Keyvault secret ID for outbound authentication certificate.
90+
91+
```yaml
92+
Type: System.String
93+
Parameter Sets: (All)
94+
Aliases:
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: True (ByPropertyName)
100+
Accept wildcard characters: False
101+
```
102+
103+
### -ProgressAction
104+
{{ Fill ProgressAction Description }}
105+
106+
```yaml
107+
Type: System.Management.Automation.ActionPreference
108+
Parameter Sets: (All)
109+
Aliases: proga
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### CommonParameters
119+
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).
120+
121+
## INPUTS
122+
123+
### System.String
124+
125+
### System.String[]
126+
127+
## OUTPUTS
128+
129+
### Microsoft.Azure.Commands.Network.Models.PSCertificateAuthentication
130+
131+
## NOTES
132+
133+
## RELATED LINKS

‎src/Network/Network/help/New-AzVirtualNetworkGatewayConnection.md‎

Lines changed: 67 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ New-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String>
2323
[-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] [-IpsecPolicies <PSIpsecPolicy[]>]
2424
[-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-ConnectionProtocol <String>]
2525
[-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>]
26-
[-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AsJob] [-ExpressRouteGatewayBypass]
27-
[-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>]
26+
[-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AuthenticationType <String>]
27+
[-CertificateAuthentication <PSCertificateAuthentication>] [-AsJob] [-ExpressRouteGatewayBypass]
28+
[-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>]
2829
[-WhatIf] [-Confirm] [<CommonParameters>]
2930
```
3031

@@ -38,8 +39,9 @@ New-AzVirtualNetworkGatewayConnection -Name <String> -ResourceGroupName <String>
3839
[-Force] [-UsePolicyBasedTrafficSelectors <Boolean>] [-IpsecPolicies <PSIpsecPolicy[]>]
3940
[-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>] [-ConnectionProtocol <String>]
4041
[-IngressNatRule <PSResourceId[]>] [-EgressNatRule <PSResourceId[]>]
41-
[-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AsJob] [-ExpressRouteGatewayBypass]
42-
[-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>]
42+
[-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>] [-AuthenticationType <String>]
43+
[-CertificateAuthentication <PSCertificateAuthentication>] [-AsJob] [-ExpressRouteGatewayBypass]
44+
[-EnablePrivateLinkFastPath] [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>]
4345
[-WhatIf] [-Confirm] [<CommonParameters>]
4446
```
4547

@@ -69,7 +71,21 @@ The first command gets a virtual network gateway natRule named natRule1 that's t
6971
The second command gets a virtual network gateway natRule named natRule2 that's type is EgressSnat.
7072
The third command creates this new virtual Network gateway connection with Ingress and Egress NatRules.
7173

72-
### Example 3 Add GatewayCustomBgpIpAddress to virtual network gateway connection
74+
### Example 3 Create VPN connection with certificate authentication
75+
```powershell
76+
$vnetgw1 = Get-AzVirtualNetworkGateway -ResourceGroupName "Rg1" -Name "gw1"
77+
$localnetgw = Get-AzLocalNetworkGateway -ResourceGroupName "Rg1" -name "localgw1"
78+
$certAuth = New-AzVirtualNetworkGatewayCertificateAuthentication -OutboundAuthCertificate "MIICmjCCAYIGCSqGSIb3DQEJEjEOMAwGCisGAQQBgjcCAQwwHAYJKoZIhvcNAQkFMQ8XDTEzMDEwMzEyNTk1OVowLwYJKoZIhvcNAQkEMSIEII8Xqf/JHKJzaOPoCdQf2c7jZwYmK1hc8LTfBrMJuXzi"
79+
80+
New-AzVirtualNetworkGatewayConnection -Name conn-cert-1 -ResourceGroupName "Rg1" -Location "eastus" -VirtualNetworkGateway1 $vnetgw1 -LocalNetworkGateway2 $localnetgw -ConnectionType IPsec -AuthenticationType Certificate -CertificateAuthentication $certAuth
81+
```
82+
83+
The first command gets a virtual network gateway.
84+
The second command gets a local network gateway.
85+
The third command creates a certificate authentication object.
86+
The fourth command creates a new VPN connection using certificate authentication.
87+
88+
### Example 4 Add GatewayCustomBgpIpAddress to virtual network gateway connection
7389
```powershell
7490
$LocalnetGateway = Get-AzLocalNetworkGateway -ResourceGroupName "PS_testing" -name "testLng"
7591
$gateway = Get-AzVirtualNetworkGateway -ResourceGroupName PS_testing -ResourceName testGw
@@ -99,6 +115,22 @@ Accept pipeline input: False
99115
Accept wildcard characters: False
100116
```
101117
118+
### -AuthenticationType
119+
Gateway connection authentication type.
120+
121+
```yaml
122+
Type: System.String
123+
Parameter Sets: (All)
124+
Aliases:
125+
Accepted values: PSK, Certificate
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: True (ByPropertyName)
131+
Accept wildcard characters: False
132+
```
133+
102134
### -AuthorizationKey
103135
AuthorizationKey.
104136
@@ -114,6 +146,21 @@ Accept pipeline input: True (ByPropertyName)
114146
Accept wildcard characters: False
115147
```
116148
149+
### -CertificateAuthentication
150+
Certificate Authentication information for certificate based authentication connection.
151+
152+
```yaml
153+
Type: Microsoft.Azure.Commands.Network.Models.PSCertificateAuthentication
154+
Parameter Sets: (All)
155+
Aliases:
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: True (ByPropertyName)
161+
Accept wildcard characters: False
162+
```
163+
117164
### -ConnectionMode
118165
Virtual Network Gateway Connection Mode.
119166
@@ -387,6 +434,21 @@ Accept pipeline input: True (ByPropertyName)
387434
Accept wildcard characters: False
388435
```
389436
437+
### -ProgressAction
438+
{{ Fill ProgressAction Description }}
439+
440+
```yaml
441+
Type: System.Management.Automation.ActionPreference
442+
Parameter Sets: (All)
443+
Aliases: proga
444+
445+
Required: False
446+
Position: Named
447+
Default value: None
448+
Accept pipeline input: False
449+
Accept wildcard characters: False
450+
```
451+
390452
### -ResourceGroupName
391453
The resource group name.
392454

0 commit comments

Comments
 (0)