Skip to content

Commit 5570d88

Browse files
committed
Standardize placeholders in attestation, confidential-ledger, and payment-hsm docsets
1 parent 0e45705 commit 5570d88

23 files changed

Lines changed: 181 additions & 182 deletions

articles/attestation/private-endpoint-powershell.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Create a resource group with [New-AzResourceGroup](/powershell/module/az.resourc
3434
```azurepowershell-interactive
3535
## Create to your Azure account subscription and create a resource group in a desired location. ##
3636
Connect-AzAccount
37-
Set-AzSubscription "mySubscription"
37+
Set-AzSubscription "<subscription-name>"
3838
$rg = "CreateAttestationPrivateLinkTutorial-rg"
3939
$loc= "eastus"
4040
New-AzResourceGroup -Name $rg -Location $loc
@@ -109,7 +109,7 @@ $attestationProvider = New-AzAttestation -Name $attestationProviderName -Resourc
109109
$attestationProviderId = $attestationProvider.Id
110110
```
111111
## Access the attestation provider from local machine ##
112-
Enter `nslookup <provider-name>.attest.azure.net`. Replace **\<provider-name>** with the name of the attestation provider instance you created in the previous steps.
112+
Enter `nslookup <provider-name>.attest.azure.net`. Replace `<provider-name>` with the name of the attestation provider instance you created in the previous steps.
113113
```azurepowershell-interactive
114114
## Access the attestation provider from local machine ##
115115
nslookup myattestationprovider.eus.attest.azure.net
@@ -189,7 +189,7 @@ In this section, you'll use the virtual machine you created in the previous step
189189

190190
8. Open Windows PowerShell on the server after you connect.
191191

192-
9. Enter `nslookup <provider-name>.attest.azure.net`. Replace **\<provider-name>** with the name of the attestation provider instance you created in the previous steps:
192+
9. Enter `nslookup <provider-name>.attest.azure.net`. Replace `<provider-name>` with the name of the attestation provider instance you created in the previous steps:
193193

194194
```azurepowershell-interactive
195195
## Access the attestation provider from local machine ##

articles/attestation/quickstart-azure-cli.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ Here are commands you can use to create and manage the attestation provider:
6868
1. Run the [az attestation create](/cli/azure/attestation#az-attestation-create) command to create an attestation provider without policy signing requirement:
6969

7070
```azurecli
71-
az attestation create --name "myattestationprovider" --resource-group "MyResourceGroup" --location westus
71+
az attestation create --name "<attestation-provider-name>" --resource-group "<resource-group>" --location westus
7272
```
7373

7474
1. Run the [az attestation show](/cli/azure/attestation#az-attestation-show) command to retrieve attestation provider properties such as status and AttestURI:
7575

7676
```azurecli
77-
az attestation show --name "myattestationprovider" --resource-group "MyResourceGroup"
77+
az attestation show --name "<attestation-provider-name>" --resource-group "<resource-group>"
7878
```
7979

8080
This command displays values like the following output:
@@ -94,7 +94,7 @@ Here are commands you can use to create and manage the attestation provider:
9494
You can delete an attestation provider by using the [az attestation delete](/cli/azure/attestation#az-attestation-delete) command:
9595

9696
```azurecli
97-
az attestation delete --name "myattestationprovider" --resource-group "sample-resource-group"
97+
az attestation delete --name "<attestation-provider-name>" --resource-group "<resource-group>"
9898
```
9999

100100
## Policy management
@@ -104,7 +104,7 @@ Use the commands described here to provide policy management for an attestation
104104
The [az attestation policy show](/cli/azure/attestation/policy#az-attestation-policy-show) command returns the current policy for the specified TEE:
105105

106106
```azurecli
107-
az attestation policy show --name "myattestationprovider" --resource-group "MyResourceGroup" --attestation-type SGX-IntelSDK
107+
az attestation policy show --name "<attestation-provider-name>" --resource-group "<resource-group>" --attestation-type SGX-IntelSDK
108108
```
109109

110110
> [!NOTE]
@@ -127,7 +127,7 @@ az attestation policy set --name testatt1 --resource-group testrg --attestation-
127127
To set policy in JWT format for a given kind of attestation type using file path:
128128

129129
```azurecli
130-
az attestation policy set --name "myattestationprovider" --resource-group "MyResourceGroup" \
130+
az attestation policy set --name "<attestation-provider-name>" --resource-group "<resource-group>" \
131131
--attestation-type SGX-IntelSDK -f "{file_path}" --policy-format JWT
132132
```
133133

articles/confidential-ledger/create-power-automate-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Create a workflow that:
174174

175175
1. Create a ledger entry action:
176176

177-
- **Ledger name**: Use `your-ledger-name` (not the full URL, just the name).
177+
- **Ledger name**: Use `<ledger-name>` (not the full URL, just the name).
178178
- **Collection ID**: Use `audit-logs` (optional: leave empty for default collection).
179179
- **Entry contents**: Use the following command:
180180

articles/confidential-ledger/includes/confidential-ledger-rg-create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ ms.author: msmbaldwin
77

88
---
99

10-
A resource group is a logical container into which Azure resources are deployed and managed. Use the Azure CLI [az group create](/cli/azure/group#az-group-create) command or the Azure PowerShell [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup) cmdlet to create a resource group named *myResourceGroup* in the *eastus* location.
10+
A resource group is a logical container into which Azure resources are deployed and managed. Use the Azure CLI [az group create](/cli/azure/group#az-group-create) command or the Azure PowerShell [New-AzResourceGroup](/powershell/module/az.resources/new-azresourcegroup) cmdlet to create a resource group in your desired location.
1111

1212
# [Azure CLI](#tab/azure-cli)
1313
```azurecli
14-
az group create --name "myResourceGroup" -l "EastUS"
14+
az group create --name "<resource-group>" -l "EastUS"
1515
```
1616
# [Azure PowerShell](#tab/azurepowershell)
1717

1818
```azurepowershell
19-
New-AzResourceGroup -Name myResourceGroup -Location eastus
19+
New-AzResourceGroup -Name <resource-group> -Location eastus
2020
```
2121
---

articles/confidential-ledger/quickstart-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Your result is in the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`.
4040
Use the Azure CLI [az confidentialledger create](/cli/azure/confidentialledger#az-confidentialledger-create) command to create a confidential ledger in your new resource group.
4141

4242
```azurecli
43-
az confidentialledger create --name "myLedger" --resource-group "myResourceGroup" --location "EastUS" --ledger-type "Public" --aad-based-security-principals ledger-role-name="Administrator" principal-id="<your-principal-id>"
43+
az confidentialledger create --name "<ledger-name>" --resource-group "<resource-group>" --location "EastUS" --ledger-type "Public" --aad-based-security-principals ledger-role-name="Administrator" principal-id="<principal-id>"
4444
```
4545

4646
A successful operation returns the properties of the newly created ledger. Take note of the **ledgerUri**. In our example, this URI is "https://myledger.confidential-ledger.azure.com".
@@ -52,7 +52,7 @@ You need this URI to transact with the confidential ledger from the data plane.
5252
You can view the properties associated with your newly created confidential ledger using the Azure CLI [az confidentialledger show](/cli/azure/confidentialledger#az-confidentialledger-show) command.
5353

5454
```azurecli
55-
az confidentialledger show --name "myLedger" --resource-group "myResourceGroup"
55+
az confidentialledger show --name "<ledger-name>" --resource-group "<resource-group>"
5656
```
5757

5858
The returned JSON object displays the ledger's properties, including your role:
@@ -64,7 +64,7 @@ The returned JSON object displays the ledger's properties, including your role:
6464
To update the properties of a confidential ledger, use do so, use the Azure CLI [az confidentialledger update](/cli/azure/confidentialledger#az-confidentialledger-update) command. For instance, to update your ledger to change your role to "Reader", run:
6565

6666
```azurecli
67-
az confidentialledger update --name "myLedger" --resource-group "myResourceGroup" --ledger-type "Public" --aad-based-security-principals ledger-role-name="Reader" principal-id="<your-principal-id>"
67+
az confidentialledger update --name "<ledger-name>" --resource-group "<resource-group>" --ledger-type "Public" --aad-based-security-principals ledger-role-name="Reader" principal-id="<principal-id>"
6868
```
6969

7070
If you again run [az confidentialledger show](/cli/azure/confidentialledger#az-confidentialledger-show), you see that the role is updated.

articles/confidential-ledger/quickstart-net.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ using Azure.Security.ConfidentialLedger.Certificate;
8282

8383
### Authenticate and create a client
8484

85-
In this quickstart, logged in user is used to authenticate to Azure confidential ledger, which is preferred method for local development. The name of your confidential ledger is expanded to the key vault URI, in the format "https://\<your-confidential-ledger-name\>.confidential-ledger.azure.com". This example is using ['DefaultAzureCredential()'](/dotnet/api/azure.identity.defaultazurecredential) class from [Azure Identity Library](/dotnet/api/overview/azure/identity-readme), which allows to use the same code across different environments with different options to provide identity.
85+
In this quickstart, logged in user is used to authenticate to Azure confidential ledger, which is preferred method for local development. The name of your confidential ledger is expanded to the key vault URI, in the format `https://<ledger-name>.confidential-ledger.azure.com`. This example is using ['DefaultAzureCredential()'](/dotnet/api/azure.identity.defaultazurecredential) class from [Azure Identity Library](/dotnet/api/overview/azure/identity-readme), which allows to use the same code across different environments with different options to provide identity.
8686

8787
```csharp
8888
credential = DefaultAzureCredential()
@@ -151,7 +151,7 @@ namespace acl_app
151151

152152
// Replace with the name of your confidential ledger
153153
154-
const string ledgerName = "myLedger";
154+
const string ledgerName = "<ledger-name>";
155155
var ledgerUri = $"https://{ledgerName}.confidential-ledger.azure.com";
156156

157157
// Create a confidential ledger client using the ledger URI and DefaultAzureCredential

articles/confidential-ledger/quickstart-powershell.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ Your result is listed under "Id", in the format `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx
4242
Use the Azure PowerShell [New-AzConfidentialLedger](/powershell/module/az.confidentialledger/new-azconfidentialledger) command to create a confidential ledger in your new resource group.
4343

4444
```azurepowershell
45-
New-AzConfidentialLedger -Name "myLedger" -ResourceGroupName "myResourceGroup" -Location "EastUS" -LedgerType "Public" -AadBasedSecurityPrincipal @{ LedgerRoleName="Administrator"; PrincipalId="aaaaaaaa-bbbb-cccc-1111-222222222222"; }
46-
45+
New-AzConfidentialLedger -Name "<ledger-name>" -ResourceGroupName "<resource-group>" -Location "EastUS" -LedgerType "Public" -AadBasedSecurityPrincipal @{ LedgerRoleName="Administrator"; PrincipalId="<principal-id>"; }
4746
```
4847

4948
A successful operation returns the properties of the newly created ledger. Take note of the **ledgerUri**. In the example above, this URI is "https://myledger.confidential-ledger.azure.com".
@@ -55,13 +54,13 @@ You need this URI to transact with the confidential ledger from the data plane.
5554
You can view the properties associated with your newly created confidential ledger using the Azure PowerShell [Get-AzConfidentialLedger](/powershell/module/az.confidentialledger/get-azconfidentialledger) cmdlet.
5655

5756
```azurepowershell
58-
Get-AzConfidentialLedger -Name "myLedger" -ResourceGroupName "myResourceGroup"
57+
Get-AzConfidentialLedger -Name "<ledger-name>" -ResourceGroupName "<resource-group>"
5958
```
6059

6160
To update the properties of a confidential ledger, use do so, use the Azure PowerShell [Update-AzConfidentialLedger](/powershell/module/az.confidentialledger/update-azconfidentialledger) cmdlet. For instance, to update your ledger to change your role to "Reader", run:
6261

6362
```azurepowershell
64-
Update-AzConfidentialLedger -Name "myLedger" -ResourceGroupName "myResourceGroup" -Location "EastUS" -LedgerType "Public" -AadBasedSecurityPrincipal @{ LedgerRoleName="Reader"; PrincipalId="aaaaaaaa-bbbb-cccc-1111-222222222222"; }
63+
Update-AzConfidentialLedger -Name "<ledger-name>" -ResourceGroupName "<resource-group>" -Location "EastUS" -LedgerType "Public" -AadBasedSecurityPrincipal @{ LedgerRoleName="Reader"; PrincipalId="<principal-id>"; }
6564
```
6665

6766
If you again run [Get-AzConfidentialLedger](/powershell/module/az.confidentialledger/get-azconfidentialledger), you see that the role is updated.

articles/confidential-ledger/quickstart-python.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,15 @@ Next, use the [DefaultAzureCredential Class](/python/api/azure-identity/azure.id
9292
credential = DefaultAzureCredential()
9393
```
9494

95-
Finish setup by setting some variables for use in your application: the resource group (myResourceGroup), the name of ledger you want to create, and two urls to be used by the data plane client library.
95+
Finish setup by setting some variables for use in your application: the resource group, the name of ledger you want to create, and two urls to be used by the data plane client library.
9696

9797
> [!Important]
98-
> Each ledger must have a globally unique name. Replace \<your-unique-ledger-name\> with the name of your ledger in the following example.
98+
> Each ledger must have a globally unique name. Replace `<ledger-name>` with the name of your ledger in the following example.
9999
100100
```python
101-
resource_group = "<azure-resource-group>"
102-
ledger_name = "<your-unique-ledger-name>"
103-
subscription_id = "<azure-subscription-id>"
101+
resource_group = "<resource-group>"
102+
ledger_name = "<ledger-name>"
103+
subscription_id = "<subscription-id>"
104104

105105
identity_url = "https://identity.confidential-ledger.core.azure.com"
106106
ledger_url = "https://" + ledger_name + ".confidential-ledger.azure.com"
@@ -223,9 +223,9 @@ from azure.confidentialledger.certificate import ConfidentialLedgerCertificateCl
223223

224224
# Set variables
225225

226-
resource_group = "<azure-resource-group>"
227-
ledger_name = "<your-unique-ledger-name>"
228-
subscription_id = "<azure-subscription-id>"
226+
resource_group = "<resource-group>"
227+
ledger_name = "<ledger-name>"
228+
subscription_id = "<subscription-id>"
229229

230230
identity_url = "https://identity.confidential-ledger.core.azure.com"
231231
ledger_url = "https://" + ledger_name + ".confidential-ledger.azure.com"
@@ -329,7 +329,7 @@ Other Azure confidential ledger articles can build upon this quickstart. If you
329329
Otherwise, when you're finished with the resources created in this article, use the Azure CLI [az group delete](/cli/azure/group?#az-group-delete) command to delete the resource group and all its contained resources:
330330

331331
```azurecli
332-
az group delete --resource-group myResourceGroup
332+
az group delete --resource-group <resource-group>
333333
```
334334

335335
## Next steps

articles/confidential-ledger/verify-write-transaction-receipts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ It's assumed that both the receipt and the service certificate can be loaded fro
102102
import json
103103

104104
# Constants
105-
service_certificate_file_name = "<your-service-certificate-file>"
106-
receipt_file_name = "<your-receipt-file>"
105+
service_certificate_file_name = "<service-certificate-file>"
106+
receipt_file_name = "<receipt-file>"
107107

108108
# Use the receipt and the service identity to verify the receipt content
109109
with open(service_certificate_file_name, "r") as service_certificate_file, open(

articles/confidential-ledger/write-transaction-receipts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following are the constant values used to set up the Azure Confidential Ledg
4242

4343
```python
4444
# Constants for our program
45-
ledger_name = "<your-unique-ledger-name>"
45+
ledger_name = "<ledger-name>"
4646
identity_url = "https://identity.confidential-ledger.core.azure.com"
4747
ledger_url = "https://" + ledger_name + ".confidential-ledger.azure.com"
4848
```
@@ -123,7 +123,7 @@ from azure.confidentialledger.certificate import ConfidentialLedgerCertificateCl
123123
from receipt_verification import verify_receipt
124124

125125
# Constants
126-
ledger_name = "<your-unique-ledger-name>"
126+
ledger_name = "<ledger-name>"
127127
identity_url = "https://identity.confidential-ledger.core.azure.com"
128128
ledger_url = "https://" + ledger_name + ".confidential-ledger.azure.com"
129129

0 commit comments

Comments
 (0)