Skip to content

Commit bdd8f23

Browse files
committed
Clean up style
1 parent 5f97e4e commit bdd8f23

File tree

1 file changed

+47
-73
lines changed

1 file changed

+47
-73
lines changed

articles/operator-insights/data-product-create.md

Lines changed: 47 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,20 @@ az login
6363

6464
### Change the active subscription
6565

66-
Azure subscriptions have both a name and an ID. You can switch to a different subscription using [az account set](/cli/azure/account#az-account-set) specifying the desired subscription ID or name.
66+
Azure subscriptions have both a name and an ID. You can switch to a different subscription with [az account set](/cli/azure/account#az-account-set), specifying the desired subscription name or ID.
6767

68-
```azurecli-interactive
69-
# change the active subscription using the subscription name
70-
az account set --subscription "My Demos"
68+
- To use the name to change the active subscription:
69+
```azurecli-interactive
70+
az account set --subscription "<SubscriptionName>"
71+
```
72+
- To use the ID to change the active subscription:
73+
```azurecli-interactive
74+
az account set --subscription "<SubscriptionID>"
75+
```
76+
77+
> [!NOTE]
78+
> Replace any values shown in the form \<KeyVaultName\> with the values for your deployment.
7179
72-
# change the active subscription using the subscription ID
73-
az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
74-
```
7580
---
7681
7782
## Create a resource group
@@ -88,14 +93,14 @@ If you plan to use CMK-based data encryption or Microsoft Purview, set up a reso
8893
8994
For more information, see [Create a resource group](/azure-resource-manager/management/manage-resource-groups-portal#create-resource-groups).
9095
91-
If you don't plan to use CMK-based date encryption or Microsoft Purview, you can set up a resource group now or when you [the create the Data Product resource](#create-an-azure-operator-insights-data-product-resource).
96+
If you don't plan to use CMK-based date encryption or Microsoft Purview, you can set up a resource group now or when you [create the Data Product resource](#create-an-azure-operator-insights-data-product-resource).
9297
9398
# [Azure CLI](#tab/azure-cli)
9499
95-
Use the az group create command to create a resource group named myResourceGroup in the eastus location.
100+
Use the `az group create` command to create a resource group named \<ResourceGroup\> in the region where you want to deploy.
96101
97102
```azurecli-interactive
98-
az group create --name "myResourceGroup" --location "EastUS"
103+
az group create --name "<ResourceGroup>" --location "<Region>"
99104
```
100105
---
101106

@@ -109,7 +114,7 @@ Azure key Vault Resource is used to store your Customer Managed Key (CMK) for da
109114

110115
# [Portal](#tab/azure-portal)
111116

112-
1. [Create an Azure Key Vault resource](../key-vault/general/quick-create-portal.md) in the same subscription and resource group where you intend to deploy the Data Product resource.
117+
1. [Create an Azure Key Vault resource](../key-vault/general/quick-create-portal.md) in the same subscription and resource group that you set up in [Create a resource group](#create-a-resource-group).
113118
1. Provide your user account with the Key Vault Administrator role on the Azure Key Vault resource. This is done via the **Access Control (IAM)** tab on the Azure Key Vault resource.
114119
1. Navigate to the object and select **Keys**. Select **Generate/Import**.
115120
1. Enter a name for the key and select **Create**.
@@ -122,44 +127,38 @@ Azure key Vault Resource is used to store your Customer Managed Key (CMK) for da
122127

123128
#### Create a key vault
124129

125-
Use the Azure CLI az keyvault create command to create a Key Vault in the resource group from the previous step. You will need to provide some information:
126-
127-
- Key vault name: A string of 3 to 24 characters that can contain only numbers (0-9), letters (a-z, A-Z), and hyphens (-)
128-
129-
Important
130-
131-
Each key vault must have a unique name. Replace <your-unique-keyvault-name> with the name of your key vault in the following examples.
130+
Use the Azure CLI `az keyvault create` command to create a Key Vault in the resource group from the previous step. You must provide:
132131

133-
- Resource group name: myResourceGroup.
134-
135-
- The location: EastUS.
132+
- A name for the key vault: A string of 3 to 24 characters that can contain only numbers (0-9), letters (a-z, A-Z), and hyphens (-). Each key vault must have a unique name.
133+
- The resource group that you created in [Create a resource group](#create-a-resource-group).
134+
- The region in which you created the resource group.
136135

137136
```azurecli-interactive
138-
az keyvault create --name "<your-unique-keyvault-name>" --resource-group "myResourceGroup" --location "EastUS"
137+
az keyvault create --name "<KeyVaultName>" --resource-group "<ResourceGroup>" --location "<Region>"
139138
```
140139

141-
The output of this command shows properties of the newly created key vault. Take note of the two properties listed below:
140+
The output of this command shows properties of the newly created key vault. Take note of:
141+
142+
- Vault Name: The name you provided to the `--name` parameter you ran.
143+
- Vault URI: In the example, the URI is `https://<KeyVaultName>.vault.azure.net/`. Applications that use your vault through its REST API must use this URI.
142144

143-
Vault Name: The name you provided to the --name parameter above.
144-
Vault URI: In the example, this is https://<your-unique-keyvault-name>.vault.azure.net/. Applications that use your vault through its REST API must use this URI.
145145
At this point, your Azure account is the only one authorized to perform any operations on this new vault.
146146

147147
#### Assign roles for the key vault
148148

149149
Provide your user account with the Key Vault Administrator role on the Azure Key Vault resource.
150150

151151
```azurecli-interactive
152-
az role assignment create --role "Key Vault Administrator" --assignee <<user email address>> --scope /subscriptions/{subscriptionid}/resourcegroups/{resource-group-name}/providers/Microsoft.KeyVault/vaults/{key-vault-name}
152+
az role assignment create --role "Key Vault Administrator" --assignee <YourEmailAddress> --scope /subscriptions/<SubscriptionID>/resourcegroups/<ResourceGroup>/providers/Microsoft.KeyVault/vaults/<KeyVaultName>
153153
```
154-
Replace the values for subscriptionid, resource-group-name, and key-vault-name with the appropriate values.
155154

156-
#### Create a Key
155+
#### Create a key
157156

158157
```azurecli-interactive
159-
az keyvault key create --vault-name "<your-unique-keyvault-name>" -n ExampleKey --protection software
158+
az keyvault key create --vault-name "<KeyVaultName>" -n <keyName> --protection software
160159
```
161160

162-
From the output screen copy the KeyID and store it in your clipboard for later use.
161+
From the output screen, copy the `KeyID` and store it in your clipboard for later use.
163162

164163
---
165164

@@ -180,22 +179,21 @@ From the output screen copy the KeyID and store it in your clipboard for later u
180179

181180
To create a user-assigned managed identity, your account needs the Managed Identity Contributor role assignment.
182181

183-
Use the az identity create command to create a user-assigned managed identity. The -g parameter specifies the resource group where to create the user-assigned managed identity. The -n parameter specifies its name. Replace the <RESOURCE GROUP> and <USER ASSIGNED IDENTITY NAME> parameter values with your own values.
184-
185-
Important
182+
Use the `az identity create` command to create a user-assigned managed identity. The -g parameter specifies the resource group where to create the user-assigned managed identity. The -n parameter specifies its name. Replace the \<ResourceGroup\> and \<UserAssignedIdentityName\> parameter values with your own values.
186183

187-
When you create user-assigned managed identities, only alphanumeric characters (0-9, a-z, and A-Z) and the hyphen (-) are supported.
184+
> [!IMPORTANT]
185+
> When you create user-assigned managed identities, only alphanumeric characters (0-9, a-z, and A-Z) and the hyphen (-) are supported.
188186
189187
```azurecli-interactive
190-
az identity create -g <RESOURCE GROUP> -n <USER ASSIGNED IDENTITY NAME>
188+
az identity create -g <ResourceGroup> -n <UserAssignedIdentityName>
191189
```
192190

193-
Copy the principalId from the output screen and store it in your clipboard for later use.
191+
Copy the `principalId` from the output screen and store it in your clipboard for later use.
194192

195193
#### Assign the user-assigned managed identity to the key vault
196194

197195
```azurecli-interactive
198-
az role assignment create --role "Key Vault Administrator" --assignee <<pricipalID from above step>> --scope /subscriptions/{subscriptionid}/resourcegroups/{resource-group-name}/providers/Microsoft.KeyVault/vaults/{key-vault-name}
196+
az role assignment create --role "Key Vault Administrator" --assignee <principalId> --scope /subscriptions/<SubscriptionID>/resourcegroups/<ResourceGroup>/providers/Microsoft.KeyVault/vaults/<KeyVaultName>
199197
```
200198

201199
---
@@ -236,51 +234,27 @@ You create the Azure Operator Insights Data Product resource.
236234

237235
# [Azure CLI](#tab/azure-cli)
238236

239-
To create a Azure Operator Insights DataProduct with just mandatory parameters, use the following command:
237+
To create an Azure Operator Insights Data Product with the minimum required parameters, use the following command:
240238

241239
```azurecli-interactive
242-
az network-analytics data-product create --name <<dpname>> --resource-group <<rgname>> --location <<azurelocation>> --publisher Microsoft --product <<product name>> --major-version <<product major version>>
240+
az network-analytics data-product create --name <DataProductName> --resource-group <ResourceGroup> --location <Region> --publisher Microsoft --product <ProductName> --major-version <ProductMajorVersion>
243241
```
244242

245-
To create a Azure Operator Insights DataProduct with all parameters, use the following command:
243+
Use the following values for \<ProductName\> and \<ProductMajorVersion>.
246244

247-
```azurecli-interactive
248-
az network-analytics data-product create --data-product-name
249-
--resource-group
250-
[--encryption-key]
251-
[--identity]
252-
[--key-encryption-enable {Disabled, Enabled}]
253-
[--location]
254-
[--major-version]
255-
[--managed-rg]
256-
[--networkacls]
257-
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
258-
[--owners]
259-
[--private-links-enabled {Disabled, Enabled}]
260-
[--product]
261-
[--public-network-access {Disabled, Enabled}]
262-
[--publisher]
263-
[--purview-account]
264-
[--purview-collection]
265-
[--redundancy {Disabled, Enabled}]
266-
[--tags]
267-
```
245+
246+
|Date Product |\<ProductName\> |\<ProductMajorVersion>|
247+
|---------|---------|---------|
248+
|Quality of Experience - Affirmed MCC GIGW |`Quality of Experience - Affirmed MCC GIGW`|`1.0`|
249+
|Quality of Experience - Affirmed MCC PGW or GGSN |`Quality of Experience - Affirmed MCC PGW or GGSN`|`1.0`|
250+
|Monitoring - Affirmed MCC|`Monitoring - Affirmed MCC`|`0` or `1`|
268251

269252

270-
Create data product with all parameter
253+
To create an Azure Operator Insights DataProduct with all parameters, use the following command:
271254

272255
```azurecli-interactive
273-
az network-analytics data-product create --name <<dpname>> --resource-group <<rgname>> --location <<azurelocation>> --publisher Microsoft --product <<productname>> --major-version <<product major version> --owners <<xyz@email>> --customer-managed-key-encryption-enabled Enabled --key-encryption-enable Enabled --encryption-key '{"keyVaultUri":"<vaulturi>","keyName":"<keyname>","keyVersion":"<version>"}' --purview-account purviewaccount --purview-collection collection --identity '{"type":"userAssigned","userAssignedIdentities":{"/subscriptions/<subid>/resourceGroups/<rgname>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<idname>"}}' --tags '{"key1":"value1","key2":"value2"}'
256+
az network-analytics data-product create --name <DataProductName> --resource-group <ResourceGroup> --location <Region> --publisher Microsoft --product <ProductName> --major-version <ProductMajorVersion --owners <<xyz@email>> --customer-managed-key-encryption-enabled Enabled --key-encryption-enable Enabled --encryption-key '{"keyVaultUri":"<VaultURI>","keyName":"<KeyName>","keyVersion":"<KeyVersion>"}' --purview-account <PurviewAccount> --purview-collection <PurviewCollection> --identity '{"type":"userAssigned","userAssignedIdentities":{"/subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<UserAssignedIdentityName>"}}' --tags '{"key1":"value1","key2":"value2"}'
274257
```
275-
For dpname, rgname, azurelocation use the use desired values.
276-
For Product name and corresponding versions
277-
- Quality of Experience - Affirmed MCC GIGW
278-
- 1.0
279-
- Quality of Experience - Affirmed MCC PGW or GGSN
280-
- 1.0
281-
- Monitoring - Affirmed MCC
282-
- 0 or 1
283-
For ownersemail, vaulturi, keyname, version, purviewaccount, collection, uami and tags use the desired values.
284258

285259
---
286260

@@ -359,6 +333,6 @@ When you have finished exploring Azure Operator Insights Data Product, you shoul
359333
# [Azure CLI](#tab/azure-cli)
360334
361335
```azurecli-interactive
362-
az group delete --name "myResourceGroup"
336+
az group delete --name "ResourceGroup"
363337
```
364338
---

0 commit comments

Comments
 (0)