Skip to content

Commit 6c008cc

Browse files
authored
Merge pull request #114285 from msmbaldwin/avk-qs
Assorted chnages to address public PRs
2 parents 1694b0d + fffd827 commit 6c008cc

File tree

9 files changed

+34
-20
lines changed

9 files changed

+34
-20
lines changed

articles/key-vault/certificates/quick-create-python.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
6363

6464
### Create a service principal
6565

66-
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a .NET console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
66+
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
67+
68+
For the sake of simplicity however, this quickstart creates a desktop application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
6769

6870
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
6971

7072
```azurecli
71-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
73+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
7274
```
7375

7476
This operation will return a series of key / value pairs.

articles/key-vault/general/group-permissions-for-apps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ The objectId for an applications corresponds with its associated service princip
5656

5757
There are two ways to obtain an objectId for an application. The first is to register your application with Azure Active Directory. To do so, follow the steps in the quickstart [Register an application with the Microsoft identity platform](../../active-directory/develop/quickstart-register-app.md). When registration is complete, the objectID will be listed as the "Application (client) ID".
5858

59-
The second is to create a service principal in a terminal window. With the Azure CLI, use the [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command.
59+
The second is to create a service principal in a terminal window. With the Azure CLI, use the [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command, and provide a unique service principle name to the -n flag in the format "http://<my-unique-service-principle-name>".
6060

6161
```azurecli-interactive
62-
az ad sp create-for-rbac -n "http://mySP"
62+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name"
6363
```
6464

6565
The objectId will be listed in the output as `clientID`.
@@ -68,7 +68,7 @@ With Azure PowerShell, use the [New-AzADServicePrincipal](/powershell/module/Az.
6868

6969

7070
```azurepowershell-interactive
71-
New-AzADServicePrincipal -DisplayName mySP
71+
New-AzADServicePrincipal -DisplayName <my-unique-service-principle-name>
7272
```
7373

7474
The objectId will be listed in the output as `Id` (not `ApplicationId`).

articles/key-vault/keys/about-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ For more information, see [Key operations in the Key Vault REST API reference](/
100100
Once a key has been created in Key Vault, the following cryptographic operations may be performed using the key:
101101

102102
- **Sign and Verify**: Strictly, this operation is "sign hash" or "verify hash", as Key Vault doesn't support hashing of content as part of signature creation. Applications should hash the data to be signed locally, then request that Key Vault sign the hash.
103-
Verification of signed hashes is supported as a convenience operation for applications that may not have access to [public] key material. For best application performance, verify that operations are performed locally.
103+
Verification of signed hashes is supported as a convenience operation for applications that may not have access to [public] key material. For best application performance, VERIFY operations should be are performed locally.
104104
- **Key Encryption / Wrapping**: A key stored in Key Vault may be used to protect another key, typically a symmetric content encryption key (CEK). When the key in Key Vault is asymmetric, key encryption is used. For example, RSA-OAEP and the WRAPKEY/UNWRAPKEY operations are equivalent to ENCRYPT/DECRYPT. When the key in Key Vault is symmetric, key wrapping is used. For example, AES-KW. The WRAPKEY operation is supported as a convenience for applications that may not have access to [public] key material. For best application performance, WRAPKEY operations should be performed locally.
105-
- **Encrypt and Decrypt**: A key stored in Key Vault may be used to encrypt or decrypt a single block of data. The size of the block is determined by the key type and selected encryption algorithm. The Encrypt operation is provided for convenience, for applications that may not have access to [public] key material. For best application performance, encrypt operations should be performed locally.
105+
- **Encrypt and Decrypt**: A key stored in Key Vault may be used to encrypt or decrypt a single block of data. The size of the block is determined by the key type and selected encryption algorithm. The Encrypt operation is provided for convenience, for applications that may not have access to [public] key material. For best application performance, ENCRYPT operations should be performed locally.
106106

107107
While WRAPKEY/UNWRAPKEY using asymmetric keys may seem superfluous (as the operation is equivalent to ENCRYPT/DECRYPT), the use of distinct operations is important. The distinction provides semantic and authorization separation of these operations, and consistency when other key types are supported by the service.
108108

articles/key-vault/keys/quick-create-python.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
6363

6464
### Create a service principal
6565

66-
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a .NET console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
66+
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
67+
68+
For the sake of simplicity however, this quickstart creates a desktop application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
6769

6870
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
6971

7072
```azurecli
71-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
73+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
7274
```
7375

7476
This operation will return a series of key / value pairs.

articles/key-vault/secrets/quick-create-java.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
110110

111111
### Create a service principal
112112

113-
The simplest way to authenticate a cloud-based application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a desktop application, which requires the use of a service principal and an access control policy.
113+
The simplest way to authenticate a cloud-based application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
114+
115+
For the sake of simplicity however, this quickstart creates a desktop application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
114116

115117
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
116118

117119
```azurecli
118-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
120+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
119121
```
120122

121123
This operation will return a series of key / value pairs.

articles/key-vault/secrets/quick-create-net-v3.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
9595

9696
### Create a service principal
9797

98-
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a .NET console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
98+
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
99+
100+
For the sake of simplicity however, this quickstart creates a .NET console application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
99101

100102
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
101103

102104
```azurecli
103-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
105+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
104106
```
105107

106108
This operation will return a series of key / value pairs.

articles/key-vault/secrets/quick-create-net.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,14 @@ New-AzKeyVault -Name <your-unique-keyvault-name> -ResourceGroupName myResourceGr
9191

9292
### Create a service principal
9393

94-
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a .NET console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
94+
The simplest way to authenticate a cloud-based .NET application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
95+
96+
For the sake of simplicity however, this quickstart creates a .NET console application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
9597

9698
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
9799

98100
```azurecli
99-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
101+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
100102
```
101103

102104
This operation will return a series of key / value pairs.
@@ -119,7 +121,7 @@ Create a service principal using Azure PowerShell [New-AzADServicePrincipal](/po
119121

120122
```azurepowershell
121123
# Create a new service principal
122-
$spn = New-AzADServicePrincipal -DisplayName "http://mySP"
124+
$spn = New-AzADServicePrincipal -DisplayName "http://<my-unique-service-principle-name>"
123125
124126
# Get the tenant ID and subscription ID of the service principal
125127
$tenantId = (Get-AzContext).Tenant.Id

articles/key-vault/secrets/quick-create-node.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
6363

6464
### Create a service principal
6565

66-
The simplest way to authenticate an cloud-based application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstarts creates a console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
66+
The simplest way to authenticate an cloud-based application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
67+
68+
For the sake of simplicity however, this quickstart creates a desktop application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
6769

6870
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
6971

7072
```azurecli
71-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
73+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
7274
```
7375

7476
This operation will return a series of key / value pairs.

articles/key-vault/secrets/quick-create-python.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,14 @@ az keyvault create --name <your-unique-keyvault-name> -g "myResourceGroup"
6464
### Create a service principal
6565

6666

67-
The simplest way to authenticate a cloud-based Python application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details. For the sake of simplicity however, this quickstart creates a Python console application. Authenticating a desktop application with Azure requires the use of a service principal and an access control policy.
67+
The simplest way to authenticate a cloud-based Python application is with a managed identity; see [Use an App Service managed identity to access Azure Key Vault](../general/managed-identity.md) for details.
68+
69+
For the sake of simplicity however, this quickstart creates a .desktop application, which requires the use of a service principal and an access control policy. Your service principle requires a unique name in the format "http://<my-unique-service-principle-name>".
6870

6971
Create a service principle using the Azure CLI [az ad sp create-for-rbac](/cli/azure/ad/sp?view=azure-cli-latest#az-ad-sp-create-for-rbac) command:
7072

7173
```azurecli
72-
az ad sp create-for-rbac -n "http://mySP" --sdk-auth
74+
az ad sp create-for-rbac -n "http://<my-unique-service-principle-name>" --sdk-auth
7375
```
7476

7577
This operation will return a series of key / value pairs.

0 commit comments

Comments
 (0)