Skip to content

Commit 928361e

Browse files
committed
Updates
1 parent c446363 commit 928361e

File tree

2 files changed

+29
-28
lines changed

2 files changed

+29
-28
lines changed

articles/attestation/quickstart-powershell.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.custom: devx-track-azurepowershell
1616
Follow the below steps to create and configure an attestation provider using Azure PowerShell. See [Overview of Azure PowerShell](/powershell/azure/) for information on how to install and run Azure PowerShell.
1717

1818
> [!NOTE]
19-
> Az.Attestation module is now integrated into Az PowerShell module. Minimum version of Az module required to support attestation operations:
19+
> The Az.Attestation PowerShell module is now integrated into Az PowerShell module. Minimum version of Az module required to support attestation operations:
2020
- Az PowerShell module 6.5.0
2121

2222
The PowerShell Gallery has deprecated Transport Layer Security (TLS) versions 1.0 and 1.1. TLS 1.2 or a later version is recommended. Hence you may receive the following errors:
@@ -121,14 +121,14 @@ In order to manage policies, an Azure AD user requires the following permissions
121121
- Microsoft.Attestation/attestationProviders/attestation/write
122122
- Microsoft.Attestation/attestationProviders/attestation/delete
123123

124-
To perform these actions, an Azure AD user must have **Attestation Contributor** role on the attestation provider. These permissions can be also be inherited with roles such as **Owner** (wildcard permissions)/ **Contributor** (wildcard permissions) on the subscription/ resource group.
124+
To perform these actions, an Azure AD user must have **Attestation Contributor** role on the attestation provider. These permissions can also be inherited with roles such as **Owner** (wildcard permissions)/ **Contributor** (wildcard permissions) on the subscription/ resource group.
125125

126126
In order to read policies, an Azure AD user requires the following permission for "Actions":
127127
- Microsoft.Attestation/attestationProviders/attestation/read
128128

129-
To perform this action, an Azure AD user must have **Attestation Reader** role on the attestation provider. The read permissions can be also be inherited with roles such as **Reader** (wildcard permissions) on the subscription/ resource group.
129+
To perform this action, an Azure AD user must have **Attestation Reader** role on the attestation provider. The read permissions can also be inherited with roles such as **Reader** (wildcard permissions) on the subscription/ resource group.
130130

131-
Below PowerShell cmdlets provide policy management for an attestation provider (one TEE at a time).
131+
These PowerShell cmdlets provide policy management for an attestation provider (one TEE at a time).
132132

133133
Get-AzAttestationPolicy returns the current policy for the specified TEE. The cmdlet displays policy in both text and JWT format of the policy.
134134

@@ -173,7 +173,7 @@ Remove-AzAttestationPolicySigner -Name $attestationProvider -ResourceGroupName $
173173

174174
Policy signer certificate is a signed JWT with claim named "maa-policyCertificate". Value of the claim is a JWK, which contains the trusted signing key to add. The JWT must be signed with private key corresponding to any of the existing policy signer certificates.
175175

176-
Note that all semantic manipulation of the policy signer certificate must be done outside of PowerShell. As far as PowerShell is concerned, it is a simple string.
176+
All semantic manipulation of the policy signer certificate must be done outside of PowerShell. As far as PowerShell is concerned, it is a simple string.
177177

178178
For policy signer certificate sample, see [examples of policy signer certificate](policy-signer-examples.md).
179179

articles/attestation/troubleshoot-guide.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Error handling in Azure Attestation is implemented following [Microsoft REST API
1717

1818
If your issue isn't addressed in this article, you can also submit an Azure support request on the [Azure support page](https://azure.microsoft.com/support/options/).
1919

20-
## 1. HTTP–401: Unauthorized exception
20+
## HTTP–401: Unauthorized exception
2121

2222
### HTTP status code
2323
401
@@ -62,22 +62,22 @@ b. Refer to the guidance [here](../role-based-access-control/role-assignments-li
6262

6363
c. If you don't find an appropriate role assignment, follow the instructions in [here](../role-based-access-control/role-assignments-powershell.md)
6464

65-
## 2. HTTP – 400 errors
65+
## HTTP – 400 errors
6666

6767
### HTTP status code
6868
400
6969

70-
There are different reasons why a request may return 400. Below are some examples of errors returned by Azure Attestation APIs:
70+
There are different reasons why a request may return 400. Here are some examples of errors returned by Azure Attestation APIs.
7171

72-
### 2.1. Attestation failure due to policy evaluation errors
72+
### Attestation failure due to policy evaluation errors
7373

74-
Attestation policy includes authorization rules and issuance rules. Enclave evidence is evaluated based on the authorization rules. Issuance rules define the claims to be included in attestation token. If claims in enclave evidence do not comply with authorization rules, attest calls will return policy evaluation error.
74+
Attestation policy includes authorization rules and issuance rules. Enclave evidence is evaluated based on the authorization rules. Issuance rules define the claims to be included in attestation token. If claims in enclave evidence don't comply with authorization rules, attest calls will return policy evaluation error.
7575

7676
**Error code**
7777
PolicyEvaluationError
7878

7979
**Scenario examples**
80-
When claims in the enclave quote do not match with the authorization rules of attestation policy
80+
When claims in the enclave quote don't match with the authorization rules of attestation policy
8181

8282
```
8383
Native operation failed with 65518: G:\Az\security\Attestation\src\AttestationServices\Instance\NativePolicyWrapper\NativePolicyEngine.cpp(168)\(null)!00007FF801762308: (caller: 00007FF80143DCC8) Exception(0) 83FFFFEE Policy Evaluation Error has occurred Msg:[Policy Engine Exception: A Deny claim was issued, authorization failed.]
@@ -93,7 +93,7 @@ Send a request to attest API by providing policy text in “draftPolicyForAttest
9393

9494
See [attestation policy examples](./policy-examples.md)
9595

96-
### 2.2. Attestation failure due to invalid input
96+
### Attestation failure due to invalid input
9797

9898
**Error code**
9999
InvalidParameter
@@ -110,7 +110,7 @@ Microsoft Azure Attestation supports attestation of SGX quotes generated by Inte
110110

111111
Refer to [code samples](/samples/browse/?expanded=azure&terms=attestation) for performing attestation using Open Enclave SDK/ Intel SDK
112112

113-
### 2.3. Invalid certificate chain error while uploading policy/policy signer
113+
### Invalid certificate chain error while uploading policy/policy signer
114114

115115
**Error code**
116116
InvalidParameter
@@ -138,7 +138,7 @@ Else the certificate chain is considered to be invalid.
138138

139139
See [policy signer](./policy-signer-examples.md) and [policy](./policy-examples.md) examples
140140

141-
### 2.4. Add/Delete policy signer failure
141+
### Add/Delete policy signer failure
142142

143143
**Error code**
144144
InvalidOperation
@@ -186,7 +186,7 @@ At line:1 char:1
186186
**Troubleshooting steps**
187187
To add/delete a new policy signer certificate, use RFC7519 JSON Web Token (JWT) with a claim named "x-ms-policyCertificate". Value of the claim is an RFC7517 JSON Web Key, which contains the certificate to be added. JWT must be signed with private key of any of the valid policy signer certificates associated with the provider. See [policy signer examples](./policy-signer-examples.md).
188188

189-
### 2.5. Attestation policy configuration failure
189+
### Attestation policy configuration failure
190190

191191
**Error code**
192192
PolicyParsingError
@@ -238,9 +238,9 @@ In PowerShell, specify PolicyFormat as JWT to configure policy in JWT format. De
238238

239239
See attestation [policy examples](./policy-examples.md) and [how to author an attestation policy](./author-sign-policy.md)
240240

241-
## 3. Az.Attestation installation issues in PowerShell
241+
## Az.Attestation installation issues in PowerShell
242242

243-
Unable to install Az Powershell or Az.Attestation PowerShell modules in PowerShell
243+
Unable to install the Az PowerShell module or Az.Attestation PowerShell module in PowerShell.
244244

245245
### Error
246246

@@ -257,29 +257,30 @@ To continue to interact with the PowerShell Gallery, run the following command b
257257

258258
**[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12**
259259

260-
## 4. Policy access/configuration issues in PowerShell
260+
## Policy access/configuration issues in PowerShell
261261

262262
User assigned with appropriate roles. But facing authorization issues while managing attestation policies through PowerShell.
263263

264264
### Error
265-
The client with object ID <object Id> does not have authorization to perform action Microsoft.Authorization/roleassignments/write over scope ‘subcriptions/<subscriptionId>resourcegroups/secure_enclave_poc/providers/Microsoft.Authorization/roleassignments/<role assignmentId>’ or the scope is invalid. If access was recently granted, please refresh your credentials
265+
266+
The client with object ID <object Id> does not have authorization to perform action Microsoft.Authorization/roleassignments/write over scope ‘subcriptions/<subscriptionId>resourcegroups/secure_enclave_poc/providers/Microsoft.Authorization/roleassignments/<role assignmentId>’ or the scope is invalid. If access was recently granted, refresh your credentials
266267

267268
### Troubleshooting steps
268269

269-
Minimum version of Az modules required to support attestation operations are the below:
270+
The minimum version of the Az PowerShell modules required to support attestation operations are:
270271

271-
**Az 4.5.0**
272-
273-
**Az.Accounts 1.9.2**
274-
275-
**Az.Attestation 0.1.8**
272+
- **Az 4.5.0**
273+
- **Az.Accounts 1.9.2**
274+
- **Az.Attestation 0.1.8**
276275

277276
Run the below command to verify the installed version of all Az modules
278277

279-
```powershell
278+
```azurepowershell-interactive
280279
Get-InstalledModule
281280
```
282281

283-
If the versions are not matching with the minimum requirement, run Update-Module commands
282+
If the versions do not meet the minimum requirement, run the Update-Module PowerShell cmdlet.
284283

285-
e.g. - Update-Module -Name Az.Attestation
284+
```azurepowershell-interactive
285+
Update-Module -Name Az.Attestation
286+
```

0 commit comments

Comments
 (0)