@@ -12,30 +12,37 @@ Creates a private endpoint.
12
12
13
13
## SYNTAX
14
14
15
+ ### All
16
+
15
17
```
16
18
New-AzPrivateEndpoint -Name <String> -ResourceGroupName <String> -Location <String> -Subnet <PSSubnet>
17
19
-PrivateLinkServiceConnection <PSPrivateLinkServiceConnection[]> [-ByManualRequest] [-Tag <Hashtable>]
18
20
[-Force] [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
19
21
```
20
22
21
23
## DESCRIPTION
24
+
22
25
The ** New-AzPrivateEndpoint** cmdlet creates a private endpoint.
23
26
24
27
## EXAMPLES
25
28
26
- ### 1: Create a private endpoint
27
- ```
28
- $virtualNetwork = Get-AzVirtualNetwork -ResourceName MyVirtualNetwork -ResourceGroupName TestResourceGroup
29
- $plsConnection= New-AzPrivateLinkServiceConnection -Name MyPLSConnections -PrivateLinkServiceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/TestResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService" -RequestMessage "Please Approve my request"
30
- New-AzPrivateEndpoint -Name MyPrivateEndpoint -ResourceGroup TestResourceGroup -Location centralus -PrivateLinkServiceConnection $plsConnection -Subnet $virtualNetwork.Subnets[0]
31
- ```
29
+ ### Example 1: Create a private endpoint
30
+
31
+ The following example creates a private endpoint with a specific private link service ID in the
32
+ specified subnet in a virtual network.
32
33
33
- This example creates a private endpoint with specific private link service id in a specific subnet in a virtual network.
34
+ ``` powershell
35
+ $virtualNetwork = Get-AzVirtualNetwork -ResourceName 'myVirtualNetwork' -ResourceGroupName 'myResourceGroup'
36
+ $subnet = $virtualNetwork | Select-Object -ExpandProperty subnets | Where-Object Name -eq 'mySubnet'
37
+ $plsConnection= New-AzPrivateLinkServiceConnection -Name 'MyPLSConnections' -PrivateLinkServiceId '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/privateLinkService' -RequestMessage 'Please Approve my request'
38
+ New-AzPrivateEndpoint -Name 'MyPrivateEndpoint' -ResourceGroup 'myResourceGroup' -Location 'centralus' -PrivateLinkServiceConnection $plsConnection -Subnet $subnet
39
+ ```
34
40
35
41
## PARAMETERS
36
42
37
43
### -AsJob
38
- Run cmdlet in the background
44
+
45
+ Run cmdlet as a job in the background.
39
46
40
47
``` yaml
41
48
Type : System.Management.Automation.SwitchParameter
@@ -50,7 +57,8 @@ Accept wildcard characters: False
50
57
` ` `
51
58
52
59
### -ByManualRequest
53
- Using manual request.
60
+
61
+ Use manual request to establish the connection.
54
62
55
63
` ` ` yaml
56
64
Type : System.Management.Automation.SwitchParameter
@@ -65,6 +73,7 @@ Accept wildcard characters: False
65
73
` ` `
66
74
67
75
### -DefaultProfile
76
+
68
77
The credentials, account, tenant, and subscription used for communication with Azure.
69
78
70
79
` ` ` yaml
@@ -80,7 +89,8 @@ Accept wildcard characters: False
80
89
` ` `
81
90
82
91
### -Force
83
- Do not ask for confirmation if you want to overwrite a resource
92
+
93
+ Do not ask for confirmation to overwrite a resource.
84
94
85
95
` ` ` yaml
86
96
Type : System.Management.Automation.SwitchParameter
@@ -95,7 +105,9 @@ Accept wildcard characters: False
95
105
` ` `
96
106
97
107
### -Location
98
- location.
108
+
109
+ Specifies a location for the private endpoint. Use [Get-AzLocation](/powershell/module/az.resources/get-azlocation)
110
+ to determine valid values for this parameter.
99
111
100
112
` ` ` yaml
101
113
Type : System.String
@@ -110,7 +122,8 @@ Accept wildcard characters: False
110
122
` ` `
111
123
112
124
### -Name
113
- The resource name.
125
+
126
+ Name of the private endpoint.
114
127
115
128
` ` ` yaml
116
129
Type : System.String
@@ -125,7 +138,8 @@ Accept wildcard characters: False
125
138
` ` `
126
139
127
140
### -PrivateLinkServiceConnection
128
- The private link service connection.
141
+
142
+ The resource ID to connect the private endpoint.
129
143
130
144
` ` ` yaml
131
145
Type : Microsoft.Azure.Commands.Network.Models.PSPrivateLinkServiceConnection[]
@@ -140,7 +154,8 @@ Accept wildcard characters: False
140
154
` ` `
141
155
142
156
### -ResourceGroupName
143
- The resource group name.
157
+
158
+ Specifies the name of the resource group.
144
159
145
160
` ` ` yaml
146
161
Type : System.String
@@ -155,7 +170,8 @@ Accept wildcard characters: False
155
170
` ` `
156
171
157
172
### -Subnet
158
- The subnet of the private endpoint
173
+
174
+ The subnet of the private endpoint.
159
175
160
176
` ` ` yaml
161
177
Type : Microsoft.Azure.Commands.Network.Models.PSSubnet
@@ -170,8 +186,9 @@ Accept wildcard characters: False
170
186
` ` `
171
187
172
188
### -Tag
189
+
173
190
Key-value pairs in the form of a hash table. For example:
174
- @{key0=" value0" ;key1=$null;key2=" value2" }
191
+ @{key0=' value0' ;key1=$null;key2=' value2' }
175
192
176
193
` ` ` yaml
177
194
Type : System.Collections.Hashtable
@@ -186,6 +203,7 @@ Accept wildcard characters: False
186
203
` ` `
187
204
188
205
### -Confirm
206
+
189
207
Prompts you for confirmation before running the cmdlet.
190
208
191
209
` ` ` yaml
@@ -201,6 +219,7 @@ Accept wildcard characters: False
201
219
` ` `
202
220
203
221
### -WhatIf
222
+
204
223
Shows what would happen if the cmdlet runs.
205
224
The cmdlet is not run.
206
225
@@ -217,7 +236,11 @@ Accept wildcard characters: False
217
236
` ` `
218
237
219
238
### CommonParameters
220
- 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).
239
+
240
+ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
241
+ -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
242
+ -WarningAction, and -WarningVariable. For more information, see
243
+ [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
221
244
222
245
## INPUTS
223
246
0 commit comments