Skip to content

Commit d17887b

Browse files
committed
Lots of updates
1 parent 0307310 commit d17887b

9 files changed

+173
-163
lines changed

articles/private-link/create-network-security-perimeter-cli.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: mbender-ms
55
ms.author: mbender
66
ms.service: azure-private-link
77
ms.topic: quickstart
8-
ms.date: 11/04/2024
8+
ms.date: 11/06/2024
99
#CustomerIntent: As a network administrator, I want to create a network security perimeter for an Azure resource using Azure CLI, so that I can control the network traffic to and from the resource.
1010
---
1111

@@ -46,7 +46,7 @@ To get started, connect to [Azure Cloud Shell](https://shell.azure.com) or use y
4646
4747
```azurecli-interactive
4848
# List all subscriptions
49-
az account set --subscription "Azure Subscription"
49+
az account set --subscription <Azure Subscription>
5050
5151
# Re-register the Microsoft.Network resource provider
5252
az provider register --namespace Microsoft.Network
@@ -55,23 +55,22 @@ To get started, connect to [Azure Cloud Shell](https://shell.azure.com) or use y
5555
## Create a resource group and key vault
5656
5757
Before you can create a network security perimeter, you have to create a resource group and a key vault resource.
58-
This example creates a resource group named **test-rg** in the WestCentralUS location and a key vault named **key-vault-YYYYDDMM** in the resource group with the following commands:
58+
This example creates a resource group named **resource-group** in the WestCentralUS location and a key vault named **key-vault-YYYYDDMM** in the resource group with the following commands:
5959
6060
```azurecli-interactive
6161
az group create \
62-
--name test-rg \
62+
--name resource-group \
6363
--location westcentralus
6464
6565
# Create a key vault using a datetime value to ensure a unique name
6666
6767
key_vault_name="key-vault-$(date +%s)"
6868
az keyvault create \
6969
--name $key_vault_name \
70-
--resource-group test-rg \
70+
--resource-group resource-group \
7171
--location westcentralus \
7272
--query 'id' \
7373
--output tsv
74-
7574
```
7675

7776
## Create a network security perimeter
@@ -84,7 +83,7 @@ In this step, create a network security perimeter with the `az network perimeter
8483
```azurecli-interactive
8584
az network perimeter create\
8685
--name network-security-perimeter \
87-
--resource-group test-rg \
86+
--resource-group resource-group \
8887
-l westcentralus
8988
```
9089

@@ -101,7 +100,7 @@ In this step, you create a new profile and associate the PaaS resource, the Azur
101100
# Create a new profile
102101
az network perimeter profile create \
103102
--name network-perimeter-profile \
104-
--resource-group test-rg \
103+
--resource-group resource-group \
105104
--perimeter-name network-security-perimeter
106105
107106
```
@@ -112,21 +111,21 @@ In this step, you create a new profile and associate the PaaS resource, the Azur
112111
# Get key vault id
113112
az keyvault show \
114113
--name $key_vault_name \
115-
--resource-group test-rg \
114+
--resource-group resource-group \
116115
--query 'id'
117116
118117
# Get the profile id
119118
az network perimeter profile show \
120119
--name network-perimeter-profile \
121-
--resource-group test-rg \
120+
--resource-group resource-group \
122121
--perimeter-name network-security-perimeter
123122
124123
# Associate the Azure Key Vault with the network security perimeter profile
125124
# Replace <PaaSArmId> and <networkSecurityPerimeterProfileId> with the ID values for your key vault and profile
126125
az network perimeter association create \
127126
--name network-perimeter-association \
128127
--perimeter-name network-security-perimeter \
129-
--resource-group test-rg \
128+
--resource-group resource-group \
130129
--access-mode Learning \
131130
--private-link-resource "{id:<PaaSArmId>}" \
132131
--profile "{id:<networkSecurityPerimeterProfileId>}"
@@ -139,15 +138,15 @@ In this step, you create a new profile and associate the PaaS resource, the Azur
139138
az network perimeter association create \
140139
--name network-perimeter-association \
141140
--perimeter-name network-security-perimeter \
142-
--resource-group test-rg \
141+
--resource-group resource-group \
143142
--access-mode Enforced \
144143
--private-link-resource "{id:<PaaSArmId>}" \
145144
--profile "{id:<networkSecurityPerimeterProfileId>}"
146145
```
146+
147+
## Manage network security perimeter access rules
147148
148-
## Create and update network security perimeter access rules
149-
150-
In this step, you create and update network security perimeter access rules with public IP address prefixes using the `az network perimeter profile access-rule create` command.
149+
In this step, you create, update, and delete a network security perimeter access rules with public IP address prefixes using the `az network perimeter profile access-rule` command.
151150
152151
1. Create an inbound access rule with a public IP address prefix for the profile created with the following command:
153152
@@ -158,7 +157,7 @@ In this step, you create and update network security perimeter access rules with
158157
--name access-rule \
159158
--profile-name network-perimeter-profile \
160159
--perimeter-name network-security-perimeter \
161-
--resource-group test-rg \
160+
--resource-group resource-group \
162161
--address-prefixes "[192.0.2.0/24]"
163162
164163
```
@@ -172,11 +171,21 @@ In this step, you create and update network security perimeter access rules with
172171
--name access-rule \
173172
--profile-name network-perimeter-profile \
174173
--perimeter-name network-security-perimeter \
175-
--resource-group test-rg \
174+
--resource-group resource-group \
176175
--address-prefixes "['198.51.100.0/24', '192.0.2.0/24']"
177176
178177
```
179178
179+
1. If you need to delete an access rule, use the following command:
180+
181+
```azurepowershell-interactive
182+
# Delete the access rule
183+
az network perimeter profile access-rule delete \
184+
--Name network-perimeter-association \
185+
--profile-name network-perimeter-profile \
186+
--perimeter-name network-security-perimeter \
187+
--resource-group resource-group
188+
180189
[!INCLUDE [network-security-perimeter-note-managed-id](../../includes/network-security-perimeter-note-managed-id.md)]
181190
182191
## Delete all resources
@@ -188,22 +197,22 @@ To delete a network security perimeter and other resources in this quickstart, u
188197
# Delete the network security perimeter association
189198
az network perimeter association delete \
190199
--name network-perimeter-association \
191-
--resource-group test-rg \
200+
--resource-group resource-group \
192201
--perimeter-name network-security-perimeter
193202
194203
# Delete the network security perimeter
195204
az network perimeter delete \
196-
--resource-group test-rg \
205+
--resource-group resource-group \
197206
--name network-security-perimeter --yes
198207
199208
# Delete the key vault
200209
az keyvault delete \
201210
--name $key_vault_name \
202-
--resource-group test-rg
211+
--resource-group resource-group
203212
204213
# Delete the resource group
205214
az group delete \
206-
--name test-rg \
215+
--name resource-group \
207216
--yes \
208217
--no-wait
209218

articles/private-link/create-network-security-perimeter-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ When you no longer need a network security perimeter, you remove any resources a
9898

9999
1. From your network security perimeter, select **Associated resources** under **Settings**.
100100
2. Select **key-vault-YYYYDDMM** from the list of associated resources.
101-
3. From the action bar,select **Settings ** and then select **Remove** in the .
101+
3. From the action bar,select **Settings ** and then select **Remove** in the confirmation window.
102102
4. Navigate back to the **Overview** page of your network security perimeter.
103103
5. Select **Delete** and confirm the deletion by entering **network-security-perimeter** in the text box for the name of the resource.
104104
6. Browse to the **resource-group** and select **Delete** to remove the resource group and all resources within it.

articles/private-link/create-network-security-perimeter-powershell.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ author: mbender-ms
55
ms.author: mbender
66
ms.service: azure-private-link
77
ms.topic: quickstart
8-
ms.date: 11/04/2024
8+
ms.date: 11/06/2024
99
#CustomerIntent: As a network administrator, I want to create a network security perimeter for an Azure resource using Azure PowerShell, so that I can control the network traffic to and from the resource.
1010
---
1111

1212
# Quickstart: Create a network security perimeter - Azure PowerShell
1313

14-
Get started with network security perimeter by creating a network security perimeter for an Azure key vault using Azure PowerShell. A [network security perimeter](network-security-perimeter-concepts.md) allows [Azure Platform as a Service (PaaS)](./network-security-perimeter-concepts.md#onboarded-private-link-resources) resources to communicate within an explicit trusted boundary. Next, You create and update a PaaS resource's association in a network security perimeter profile. Then you create and update network security perimeter access rules. When you're finished, you delete all resources created in this quickstart.
14+
Get started with network security perimeter by creating a network security perimeter for an Azure key vault using Azure PowerShell. A [network security perimeter](network-security-perimeter-concepts.md) allows [Azure Platform as a Service (PaaS)](./network-security-perimeter-concepts.md#onboarded-private-link-resources) resources to communicate within an explicit trusted boundary. You create and update a PaaS resource's association in a network security perimeter profile. Then you create and update network security perimeter access rules. When you're finished, you delete all resources created in this quickstart.
1515

1616
[!INCLUDE [network-security-perimeter-preview-message](../../includes/network-security-perimeter-preview-message.md)]
1717

@@ -24,22 +24,42 @@ Get started with network security perimeter by creating a network security perim
2424
- The latest version of the Azure PowerShell module with tools for network security perimeter.
2525

2626
```azurepowershell
27+
# Install the Az.Tools.Installer module
2728
Install-Module -Name Az.Tools.Installer -Repository PSGallery
2829
```
2930
3031
- Use `Az.Tools.Installer` to install the preview build of the `Az.Network`:
3132
3233
```azurepowershell-interactive
34+
# Install the preview build of the Az.Network module
3335
Install-Module -Name Az.Tools.Installer -Repository PSGallery -allowprerelease -force
36+
37+
# List the current versions of the Az.Network module available in the PowerShell Gallery
38+
Find-Module -Name Az.Network -Allversions -AllowPrerelease
39+
40+
# Install the preview build of the Az.Network module using the
41+
3442
Install-AzModule -Name Az.Network -AllowPrerelease -Force
35-
Install-AzModule -Path https://azposhpreview.blob.core.windows.net/public/Az.Network.5.6.1-preview.nupkg
43+
Install-AzModule -Path <previewVersionNumber>
3644
```
37-
* If you choose to use Azure PowerShell locally:
38-
* [Install the latest version of the Az PowerShell module](/powershell/azure/install-azure-powershell).
39-
* Connect to your Azure account using the
45+
> [!NOTE]
46+
> The preview version of the Az.Network module is required to use network security perimeter capabilities. The latest version of the Az.Network module is available in the PowerShell Gallery. Look for the newest version that ends in `-preview`.
47+
48+
- If you choose to use Azure PowerShell locally:
49+
- [Install the latest version of the Az PowerShell module](/powershell/azure/install-azure-powershell).
50+
- Connect to your Azure account using the
4051
[Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet.
41-
* If you choose to use Azure Cloud Shell:
42-
* For more information on Azure Cloud Shell, see [Overview of Azure Cloud Shell](/azure/cloud-shell/overview).
52+
- If you choose to use Azure Cloud Shell:
53+
- For more information on Azure Cloud Shell, see [Overview of Azure Cloud Shell](/azure/cloud-shell/overview).
54+
- To get help with the PowerShell cmdlets, use the `Get-Help` command:
55+
```azurepowershell-interactive
56+
57+
# Get help for a specific command
58+
get-help -Name <powershell-command> - full
59+
60+
# Example
61+
get-help -Name New-AzNetworkSecurityPerimeter - full
62+
```
4363
4464
## Sign in to your Azure account and select your subscription
4565
@@ -155,9 +175,9 @@ In this step, you create a new profile and associate the PaaS resource, the Azur
155175
Update-AzNetworkSecurityPerimeterAssociation @updateAssociation | format-list
156176
```
157177
158-
## Create and update network security perimeter access rules
178+
## Manage network security perimeter access rules
159179
160-
In this step, you create and update network security perimeter access rules with public IP address prefixes.
180+
In this step, you create, update and delete network security perimeter access rules with public IP address prefixes.
161181
162182
```azurepowershell-interactive
163183
# Create an inbound access rule for a public IP address prefix
@@ -185,9 +205,9 @@ In this step, you create and update network security perimeter access rules with
185205

186206
[!INCLUDE [network-security-pe~rimeter-note-managed-id](../../includes/network-security-perimeter-note-managed-id.md)]
187207

188-
## Delete a network security perimeter
208+
## Delete all resources
189209

190-
To delete a network security perimeter, use the following commands:
210+
When you no longer need the network security perimeter, remove all resources associated with the network security perimeter, remove the perimeter, and then remove the resource group.
191211

192212
```azurepowershell-interactive
193213

articles/private-link/network-security-perimeter-concepts.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,20 @@ When creating a network security perimeter, you can specify the following proper
5151
| **Property** | **Description** |
5252
|------------------|-------------|
5353
| **Name** | A unique name within the resource group. |
54-
| **Location** | Supported regions. |
54+
| **Location** | A supported Azure region where the resource is located. |
5555
| **Resource group name** | Name of the resource group where the network security perimeter should be present. |
5656

5757
## Access modes in network security perimeter
5858

59-
Administrators add PaaS resources to a perimeter by creating resource associations. These associations offer different access modes for PaaS resources. The access modes are:
59+
Administrators add PaaS resources to a perimeter by creating resource associations. These associations can be made in two access modes. The access modes are:
6060

6161
| **Mode** | **Description** |
6262
|----------------|--------|
6363
| **Learning mode** | - Default access mode.</br>- Helps network administrators to understand the existing access patterns of their PaaS resources.</br>- Advised mode of use before transitioning to enforced mode.|
6464
| **Enforced mode** | - Must be set by the administrator.</br>- By default, all traffic except intra perimeter traffic is denied in this mode unless an *Allow* access rule exists. |
6565

6666

67-
Learn more on transitioning from learning mode to enforced mode in [transitioning to a network security perimeter](network-security-perimeter-transition.md) article.
67+
Learn more on transitioning from learning mode to enforced mode in [Transitioning to a network security perimeter](network-security-perimeter-transition.md) article.
6868

6969
## Why use Network Security Perimeter?
7070

@@ -86,7 +86,6 @@ Access rules can be used to approve public inbound and outbound traffic outside
8686

8787
For example, when creating a network security perimeter and associating a set of PaaS resources, like Azure Key Vault and SQL DB, with the perimeter, all incoming and outgoing public traffic is denied to these PaaS resources by default. To allow any access outside the perimeter, necessary access rules can be created. Within the same perimeter, profiles can also be created to group PaaS resources with similar set of inbound and outbound access requirements.
8888

89-
9089
## Onboarded private link resources
9190
A network security perimeter-aware private link resource is a PaaS resource that can be associated with a network security perimeter. Currently the list of onboarded private link resources are as follows:
9291

0 commit comments

Comments
 (0)