Skip to content

Commit a84190b

Browse files
committed
conflicts
2 parents b659446 + 14f236b commit a84190b

271 files changed

Lines changed: 4136 additions & 2500 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/copilot-instructions.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Copilot Instructions for Microsoft Learn
2+
3+
These instructions define a unified style and process standard for authoring and maintaining learn.microsoft.com documentation with GitHub Copilot or other AI assistance.
4+
5+
## Learn-wide Instructions
6+
7+
Below are instructions that apply to all Microsoft Learn documentation authored with AI assistance. Learn product team will update this periodically as needed. Each repository SHOULD NOT update this to avoid being overwritten, but update the repository-specific instructions below as needed.
8+
9+
### AI Usage & Disclosure
10+
All Markdown content created or substantially modified with AI assistance must include an `ai-usage` front matter entry:
11+
- `ai-usage: ai-generated` – AI produced the initial draft with minimal human authorship
12+
- `ai-usage: ai-assisted` – Human-directed, reviewed, and edited with AI support
13+
- Omit only for purely human-authored legacy content
14+
15+
If missing, **add it**. However, do not add or update the ai-usage tag if the changes proposed are confined solely to:
16+
- Links (link text and/or URLs)
17+
- Single words or short phrases, such as entries in table cells
18+
- Less than 5% of the article's word count
19+
20+
### Writing Style
21+
22+
Follow [Microsoft Writing Style Guide](https://learn.microsoft.com/style-guide/welcome/) with these specifics:
23+
24+
#### Voice and Tone
25+
26+
- Active voice, second person addressing reader directly
27+
- Conversational tone with contractions
28+
- Present tense for instructions/descriptions
29+
- Imperative mood for instructions ("Call the method" not "You should call the method")
30+
- Use "might" instead of "may" for possibility
31+
- Avoid "we"/"our" referring to documentation authors
32+
33+
#### Structure and Format
34+
35+
- Sentence case headings (no gerunds in titles)
36+
- Be concise, break up long sentences
37+
- Oxford comma in lists
38+
- Number all ordered list items as "1." (not sequential numbering like "1.", "2.", "3.", etc.)
39+
- Complete sentences with proper punctuation in all list items
40+
- Avoid "etc." or "and so on" - provide complete lists or use "for example"
41+
- No consecutive headings without content between them
42+
43+
#### Formatting Conventions
44+
45+
- **Bold** for UI elements
46+
- `Code style` for file names, folders, custom types, non-localizable text
47+
- Raw URLs in angle brackets
48+
- Use relative links for files in this repo
49+
- Remove `https://learn.microsoft.com/en-us` from learn.microsoft.com links
50+
51+
## Repository-Specific Instructions
52+
53+
Below are instructions specific to this repository. These may be updated by repository maintainers as needed.
54+
55+
<!--- Add additional repository level instructions below. Do NOT update this line or above. --->
56+
57+

.openpublishing.redirection.defender-for-cloud.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@
462462
},
463463
{
464464
"source_path_from_root": "/articles/defender-for-cloud/identify-sql-servers-protected-by-mma.md",
465-
"redirect_url": "/azure/defender-for-cloud/defender-for-sql-servers-introduction",
465+
"redirect_url": "/azure/defender-for-cloud/identify-sql-servers-protected-by-monitor-agent",
466466
"redirect_document_id": false
467467
},
468468
{

.openpublishing.redirection.key-vault.json

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"redirections": [
3+
{
4+
"source_path_from_root": "/articles/key-vault/general/how-to-azure-key-vault-network-security.md",
5+
"redirect_url": "/azure/key-vault/general/network-security",
6+
"redirect_document_id": false
7+
},
38
{
49
"source_path_from_root": "/articles/key-vault/general/soft-delete-change.md",
510
"redirect_url": "/azure/key-vault/general/soft-delete-overview",
@@ -42,7 +47,12 @@
4247
},
4348
{
4449
"source_path_from_root": "/articles/key-vault/common-parameters-and-headers.md",
45-
"redirect_url": "/azure/key-vault/general/common-parameters-and-headers",
50+
"redirect_url": "/azure/key-vault/general/authentication-requests-and-responses",
51+
"redirect_document_id": false
52+
},
53+
{
54+
"source_path_from_root": "/articles/key-vault/general/common-parameters-and-headers.md",
55+
"redirect_url": "/azure/key-vault/general/authentication-requests-and-responses",
4656
"redirect_document_id": false
4757
},
4858
{
@@ -247,12 +257,17 @@
247257
},
248258
{
249259
"source_path_from_root": "/articles/key-vault/key-vault-manage-with-cli.md",
250-
"redirect_url": "/azure/key-vault/key-vault-manage-with-cli2",
260+
"redirect_url": "/azure/key-vault/general/quick-create-cli",
251261
"redirect_document_id": false
252262
},
253263
{
254264
"source_path_from_root": "/articles/key-vault/key-vault-manage-with-cli2.md",
255-
"redirect_url": "/azure/key-vault/general/manage-with-cli2",
265+
"redirect_url": "/azure/key-vault/general/quick-create-cli",
266+
"redirect_document_id": false
267+
},
268+
{
269+
"source_path_from_root": "/articles/key-vault/general/manage-with-cli2.md",
270+
"redirect_url": "/azure/key-vault/general/quick-create-cli",
256271
"redirect_document_id": false
257272
},
258273
{
@@ -332,7 +347,12 @@
332347
},
333348
{
334349
"source_path_from_root": "/articles/key-vault/key-vault-versions.md",
335-
"redirect_url": "/azure/key-vault",
350+
"redirect_url": "/azure/key-vault/general/whats-new",
351+
"redirect_document_id": false
352+
},
353+
{
354+
"source_path_from_root": "/articles/key-vault/general/versions.md",
355+
"redirect_url": "/azure/key-vault/general/whats-new",
336356
"redirect_document_id": false
337357
},
338358
{

articles/attestation/azure-tpm-vbs-attestation-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Service endpoint setup is the first step for any attestation to be performed. Se
3030

3131
Here's how you can set up an attestation endpoint using Portal
3232

33-
1. Prerequisite: Access to the Microsoft Entra tenant and subscription under which you want to create the attestation endpoint. For more information, see [Microsoft Entra tenant](/azure/active-directory/develop/quickstart-create-new-tenant).
33+
1. Prerequisite: Access to the Microsoft Entra tenant and subscription under which you want to create the attestation endpoint. For more information, see [Microsoft Entra tenant](/entra/identity-platform/quickstart-create-new-tenant).
3434
1. Create an endpoint under the desired resource group, with the desired name.
3535
> [!VIDEO https://learn-video.azurefd.net/vod/player?id=8d3c6aa5-7712-4b47-b3ea-23c49539cd31]
3636
1. Add Attestation Contributor Role to the Identity who will be responsible to update the attestation policy.
@@ -48,7 +48,7 @@ Sample policies can be found in the [policy section](tpm-attestation-sample-poli
4848

4949
A client to communicate with the attestation service endpoint needs to ensure it's following the protocol as described in the [protocol documentation](virtualization-based-security-protocol.md). Use the [Attestation Client NuGet](https://www.nuget.org/packages/Microsoft.Attestation.Client) to ease the integration.
5050

51-
1. Prerequisite: a Microsoft Entra identity is needed to access the TPM endpoint. For more information, see [Microsoft Entra identity tokens](/azure/active-directory/develop/v2-overview).
51+
1. Prerequisite: a Microsoft Entra identity is needed to access the TPM endpoint. For more information, see [Microsoft Entra identity tokens](/entra/identity-platform/v2-overview).
5252
2. Add Attestation Reader Role to the identity that will be need for authentication against the endpoint.
5353
> [!VIDEO https://learn-video.azurefd.net/vod/player?id=1c70f4b2-e3e7-4b64-9fb1-ceb2810c669c]
5454

articles/attestation/basic-concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This article defines some basic concepts related to Microsoft Azure Attestation.
1616

1717
## JSON Web Token (JWTs)
1818

19-
[JSON Web Token (JWT)](/azure/active-directory/develop/security-tokens#json-web-tokens-and-claims) is an open standard [RFC7519](https://tools.ietf.org/html/rfc7519) method for securely transmitting information between parties as a JavaScript Object Notation (JSON) object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret or a public/private key pair.
19+
[JSON Web Token (JWT)](/entra/identity-platform/security-tokens#json-web-tokens-and-claims) is an open standard [RFC7519](https://tools.ietf.org/html/rfc7519) method for securely transmitting information between parties as a JavaScript Object Notation (JSON) object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret or a public/private key pair.
2020

2121
## JSON Web Key (JWK)
2222

articles/attestation/trust-domain-extensions-eat-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom:
1414

1515
This profile outlines claims for an [Intel® Trust Domain Extensions (TDX)](https://www.intel.com/content/www/us/en/developer/tools/trust-domain-extensions/overview.html) attestation result generated as an Entity Attestation Token (EAT) by Azure Attestation.
1616

17-
The profile includes claims from the IETF [JWT](https://datatracker.ietf.org/doc/html/rfc7519) specification, the [EAT](https://datatracker.ietf.org/doc/html/draft-ietf-rats-eat-21)) specification, Intel's TDX specification and Microsoft specific claims.
17+
The profile includes claims from the IETF [JWT](https://datatracker.ietf.org/doc/html/rfc7519) specification, the [EAT](https://datatracker.ietf.org/doc/rfc9711/) specification, Intel's TDX specification and Microsoft specific claims.
1818

1919
## JWT claims
2020

articles/cloud-hsm/authentication.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,17 @@ When you use an OpenSSL engine for Azure Cloud HSM, environmental variables supp
6868

6969
```sh
7070
export azcloudhsm_password="cu1:user1234"
71-
export azcloudhsm_openssl_conf=/usr/local/bin/AzureCloudHSM-ClientSDK-1.0.4.0/azcloudhsm_openssl_dynamic.conf
72-
export LD_LIBRARY_PATH=/usr/local/lib64/AzureCloudHSM-ClientSDK-1.0.4.0/:$LD_LIBRARY_PATH
71+
export azcloudhsm_openssl_conf=/opt/azurecloudhsm/bin/azcloudhsm_openssl_dynamic.conf
72+
export LD_LIBRARY_PATH=/opt/azurecloudhsm/lib64/:$LD_LIBRARY_PATH
7373
7474
sudo ./azcloudhsm_client azcloudhsm_client.cfg > /dev/null 2>&1 &
7575
openssl genpkey -algorithm RSA -out private_key.pem -engine azcloudhsm_openssl
7676
7777
```
7878

79+
> [!NOTE]
80+
> Update the paths to match your installed SDK version. The default installation path is `/opt/azurecloudhsm/`. For the latest SDK, see the [Azure Cloud HSM SDK releases](https://github.com/microsoft/MicrosoftAzureCloudHSM/releases).
81+
7982
For authentication details with OpenSSL, consult the [guide for integrating OpenSSL with Azure Cloud HSM](https://github.com/microsoft/MicrosoftAzureCloudHSM/blob/main/IntegrationGuides/Azure%20Cloud%20HSM%20OpenSSL%20Integration%20Guide.pdf).
8083

8184
## Multithreading techniques

articles/cloud-hsm/faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ sections:
1919
2020
Azure Cloud HSM supports various applications, including PKCS#11, offloading of Secure Sockets Layer (SSL) or Transport Layer Security (TLS) processing, certificate authority (CA) private key protection, and transparent data encryption (TDE). It also supports document and code signing.
2121
22-
Azure Cloud HSM provides high availability and redundancy by grouping multiple HSMs into a cluster and automatically synchronizing across three HSM instances. The HSM cluster supports load balancing of cryptographic operations. Periodic HSM backups help ensure secure and simple data recovery. For more information, see [What is Azure Cloud HSM?](overview.md).
22+
Azure Cloud HSM provides high availability and redundancy by grouping multiple HSMs into a cluster and automatically synchronizing across three HSM nodes. The HSM cluster supports load balancing of cryptographic operations. Periodic HSM backups help ensure secure and simple data recovery. For more information, see [What is Azure Cloud HSM?](overview.md).
2323
- question: |-
2424
What is an HSM?
2525
answer: |-

articles/cloud-hsm/key-management.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ To avoid exceeding Azure Cloud HSM service limits, consider using one or more of
2828
> [!NOTE]
2929
> Wait 24 hours after you create a key to ensure that synchronization and backups within your Azure Cloud HSM deployment are complete.
3030
31+
> [!CAUTION]
32+
> If a key exists on only one node and that node fails without a backup, you can be permanently locked out of your encrypted data with no recovery option. Always verify that keys are synchronized across all nodes and maintain regular backups.
33+
>
34+
> When creating users, it is the customer's responsibility to ensure users are present on all nodes of the Azure Cloud HSM cluster. For more information, see [Ensure your HSM users are available on all nodes of your cluster](user-management.md#ensure-your-hsm-users-are-available-on-all-nodes-of-your-cluster). For steps on synchronizing missing keys, see [Synchronize users and keys across Azure Cloud HSM nodes](synchronize-users-keys.md).
35+
3136
## Manage key wrapping
3237

3338
You use the `EXTRACTABLE` attribute in Azure Cloud HSM to mark keys as either extractable or nonextractable. By default, HSM keys are set as extractable. You can export extractable keys from the HSM through key wrapping, which encrypts the keys. The keys then require unwrapping via the same wrapping key before use.

articles/cloud-hsm/onboarding-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: keithp
1313

1414
# Azure Cloud HSM onboarding guide
1515

16-
Microsoft Azure Cloud HSM provides dedicated, FIPS 140-2 Level 3 validated hardware security modules (HSMs) for customers who require high levels of cryptographic key security. To help new users get started, Microsoft published a comprehensive onboarding guide that outlines the steps for provisioning, configuring, and using Azure Cloud HSM effectively.
16+
Microsoft Azure Cloud HSM provides dedicated, FIPS 140-3 Level 3 validated hardware security modules (HSMs) for customers who require high levels of cryptographic key security. To help new users get started, Microsoft published a comprehensive onboarding guide that outlines the steps for provisioning, configuring, and using Azure Cloud HSM effectively.
1717

1818
The onboarding guide is available as a PDF. It includes detailed instructions, best practices, and prerequisites for a smooth setup process. You can access the full guide here: [Microsoft Azure Cloud HSM Onboarding Guide](https://github.com/microsoft/MicrosoftAzureCloudHSM/blob/main/OnboardingGuides/Azure%20Cloud%20HSM%20Onboarding.pdf).
1919

0 commit comments

Comments
 (0)