Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sample readmes to have absolute links to GitHub #12568

Merged
merged 7 commits into from
Jun 10, 2020
Merged

Update sample readmes to have absolute links to GitHub #12568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b70c8ee
Add sample link validation
JoshLove-msft Jun 5, 2020
9019e4f
Support asterisk passed in
JoshLove-msft Jun 5, 2020
ee93c12
move inline
JoshLove-msft Jun 5, 2020
7942c7a
pwsh fix
JoshLove-msft Jun 6, 2020
2b14935
Fix tab
JoshLove-msft Jun 6, 2020
ceaf62b
Update sample readmes
JoshLove-msft Jun 6, 2020
59e7809
Revert codechecks changes; update Search readme
JoshLove-msft Jun 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions sdk/appconfiguration/Azure.Data.AppConfiguration/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ description: Samples for the Azure.Data.AppConfiguration client library

# Azure App Configuration client SDK samples

- [Create, Retrieve and Delete a Configuration Setting](Sample1_HelloWorld.md)
- [Asynchronously Create, Update and Delete Configuration Setting With Labels](Sample2_HelloWorldExtended.md)
- [Make a Configuration Setting Read-Only](Sample3_SetClearReadOnly.md)
- [Read Revision History](Sample4_ReadRevisionHistory.md)
- [Get a Configuration Setting](Sample5_GetSettingIfChanged.md)
- [Update a Configuration If Unchanged](Sample6_UpdateSettingIfUnchanged.md)
- [Mock a client for testing using the Moq library](Sample7_MockClient.md)
- [Create, Retrieve and Delete a Configuration Setting](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample1_HelloWorld.md)
- [Asynchronously Create, Update and Delete Configuration Setting With Labels](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample2_HelloWorldExtended.md)
- [Make a Configuration Setting Read-Only](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample3_SetClearReadOnly.md)
- [Read Revision History](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample4_ReadRevisionHistory.md)
- [Get a Configuration Setting](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample5_GetSettingIfChanged.md)
- [Update a Configuration If Unchanged](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample6_UpdateSettingIfUnchanged.md)
- [Mock a client for testing using the Moq library](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample7_MockClient.md)
10 changes: 5 additions & 5 deletions sdk/core/Azure.Core/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ description: Samples for the Azure.Core client library

# Azure.Core Samples

- [Configuration](Configuration.md)
- [Response](Response.md)
- [Pipeline](Pipeline.md)
- [Long Running Operations](LongRunningOperations.md)
- [Mocking](Mocking.md)
- [Configuration](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Configuration.md)
- [Response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Response.md)
- [Pipeline](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Pipeline.md)
- [Long Running Operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/LongRunningOperations.md)
- [Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Mocking.md)
8 changes: 4 additions & 4 deletions sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Samples for the Azure.Messaging.EventHubs.Processor client library

# Azure.Messaging.EventHubs.Processor Samples

The Azure Event Hubs Processor samples are intended to serve as an example and introduction to common scenarios in which the Event Hubs Processor client library is used, and to help demonstrate library features. The samples are accompanied by a [console application](./Program.cs) which you can use to execute and debug them interactively. The simplest way to begin is to launch the project for debugging in Visual Studio or your preferred IDE and provide the Event Hubs connection information in response to the prompts.
The Azure Event Hubs Processor samples are intended to serve as an example and introduction to common scenarios in which the Event Hubs Processor client library is used, and to help demonstrate library features. The samples are accompanied by a [console application](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs.Processor/samples/Program.cs) which you can use to execute and debug them interactively. The simplest way to begin is to launch the project for debugging in Visual Studio or your preferred IDE and provide the Event Hubs connection information in response to the prompts.

Each of the samples is self-contained and focused on illustrating one specific scenario. Each is numbered, with the lower numbers concentrating on basic scenarios and building to more complex scenarios as they increase; though each sample is independent, it will assume an understanding of the content discussed in earlier samples.

Expand Down Expand Up @@ -73,6 +73,6 @@ When you submit a pull request, a CLA-bot will automatically determine whether y

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

Please see our [contributing guide](./../Azure.Messaging.EventHubs/CONTRIBUTING.md) for more information.
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Feventhub%2FAzure.Messaging.EventHubs.Processor/samples/%2FREADME.png)
Please see our [contributing guide](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/CONTRIBUTING.md) for more information.

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Feventhub%2FAzure.Messaging.EventHubs.Processor/samples/%2FREADME.png)
6 changes: 3 additions & 3 deletions sdk/eventhub/Azure.Messaging.EventHubs/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
---
page_type: sample
languages:
- csharp
Expand All @@ -11,7 +11,7 @@ description: Samples for the Azure.Messaging.EventHubs client library

# Azure.Messaging.EventHubs Samples

The Azure Event Hubs samples are intended to serve as an example and introduction to common scenarios in which the Event Hubs client library is used, and to help demonstrate library features. The samples are accompanied by a [console application](./Program.cs) which you can use to execute and debug them interactively. The simplest way to begin is to launch the project for debugging in Visual Studio or your preferred IDE and provide the Event Hubs connection information in response to the prompts.
The Azure Event Hubs samples are intended to serve as an example and introduction to common scenarios in which the Event Hubs client library is used, and to help demonstrate library features. The samples are accompanied by a [console application](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/Program.cs) which you can use to execute and debug them interactively. The simplest way to begin is to launch the project for debugging in Visual Studio or your preferred IDE and provide the Event Hubs connection information in response to the prompts.

Each of the samples is self-contained and focused on illustrating one specific scenario. Each is numbered, with the lower numbers concentrating on basic scenarios and building to more complex scenarios as they increase; though each sample is independent, it will assume an understanding of the content discussed in earlier samples.

Expand Down Expand Up @@ -79,6 +79,6 @@ When you submit a pull request, a CLA-bot will automatically determine whether y

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

Please see our [contributing guide](./CONTRIBUTING.md) for more information.
Please see our [contributing guide](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/eventhub/Azure.Messaging.EventHubs/samples/CONTRIBUTING.md) for more information.

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Feventhub%2FAzure.Messaging.EventHubs/samples/%2FREADME.png)
4 changes: 2 additions & 2 deletions sdk/keyvault/Azure.Security.KeyVault.Certificates/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ description: Samples for the Azure.Security.KeyVault.Certificates client library

# Azure.Security.KeyVault.Certificates Samples

- [Setting, getting, updating, and deleting certificates](Sample1_HelloWorld.md)
- [Listing certificates, certificate versions, and deleted certificates](Sample2_GetCertificates.md)
- [Setting, getting, updating, and deleting certificates](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Certificates/samples/Sample1_HelloWorld.md)
- [Listing certificates, certificate versions, and deleted certificates](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Certificates/samples/Sample2_GetCertificates.md)
12 changes: 6 additions & 6 deletions sdk/keyvault/Azure.Security.KeyVault.Keys/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ description: Samples for the Azure.Security.KeyVault.Keys client library.

# Azure.Security.KeyVault.Keys Samples

- [Creating, getting, updating, and deleting keys](Sample1_HelloWorld.md)
- [Back up and restore a key](Sample2_BackupAndRestore.md)
- [Listing keys, key versions, and deleted keys](Sample3_GetKeys.md)
- [Encrypting and decrypt keys](Sample4_EncryptDecrypt.md)
- [Signing and verifying keys](Sample5_SignVerify.md)
- [Wrapping and unwrap a key](Sample6_WrapUnwrap.md)
- [Creating, getting, updating, and deleting keys](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample1_HelloWorld.md)
- [Back up and restore a key](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample2_BackupAndRestore.md)
- [Listing keys, key versions, and deleted keys](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample3_GetKeys.md)
- [Encrypting and decrypt keys](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample4_EncryptDecrypt.md)
- [Signing and verifying keys](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample5_SignVerify.md)
- [Wrapping and unwrap a key](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample6_WrapUnwrap.md)
6 changes: 3 additions & 3 deletions sdk/keyvault/Azure.Security.KeyVault.Secrets/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ description: Samples for the Azure.Security.KeyVault.Secrets client library.

# Azure.Security.KeyVault.Secrets Samples

- [Creating, getting, updating, and deleting secrets](Sample1_HelloWorld.md)
- [Back up and restore a secret](Sample2_BackupAndRestore.md)
- [Listing secrets, secret versions, and deleted secrets](Sample3_GetSecrets.md)
- [Creating, getting, updating, and deleting secrets](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Secrets/samples/Sample1_HelloWorld.md)
- [Back up and restore a secret](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Secrets/samples/Sample2_BackupAndRestore.md)
- [Listing secrets, secret versions, and deleted secrets](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Secrets/samples/Sample3_GetSecrets.md)
6 changes: 3 additions & 3 deletions sdk/search/Azure.Search.Documents/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ description: Samples for the Azure.Search.Documents client library

# Azure.Search.Documents Samples

- Get started either [synchronously](Sample01a_HelloWorld.md) or [asynchronously](Sample01b_HelloWorldAsync.md).
- Perform [service level operations](Sample02_Service.md).
- Perform [index level operations](Sample03_Index.md).
- Get started either [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample01a_HelloWorld.md) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample01b_HelloWorldAsync.md).
- Perform [service level operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample02_Service.md).
- Perform [index level operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample03_Index.md).
2 changes: 1 addition & 1 deletion sdk/storage/Azure.Storage.Blobs.Batch/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ description: Samples for the Azure.Storage.Blobs.Batch client library

# Azure.Storage.Blobs.Batch Samples

- Delete or set access tiers in batches [synchronously](Sample03a_Batching.cs) or [asynchronously](Sample03b_BatchingAsync.cs).
- Delete or set access tiers in batches [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs.Batch/samples/Sample03a_Batching.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs.Batch/samples/Sample03b_BatchingAsync.cs).
6 changes: 3 additions & 3 deletions sdk/storage/Azure.Storage.Blobs/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ description: Samples for the Azure.Storage.Blobs client library

# Azure.Storage.Blobs Samples

- Upload, download, list blobs, and check for errors [synchronously](Sample01a_HelloWorld.cs) or [asynchronously](Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, public access, shared keys, shared access signatures, and Azure Active Directory.](Sample02_Auth.cs)
- Delete or set access tiers in batches [synchronously](Sample03a_Batching.cs) or [asynchronously](Sample03b_BatchingAsync.cs).
- Upload, download, list blobs, and check for errors [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/samples/Sample01a_HelloWorld.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/samples/Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, public access, shared keys, shared access signatures, and Azure Active Directory.](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs/samples/Sample02_Auth.cs)
- Delete or set access tiers in batches [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs.Batch/samples/Sample03a_Batching.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blobs.Batch/samples/Sample03b_BatchingAsync.cs).
2 changes: 1 addition & 1 deletion sdk/storage/Azure.Storage.Common/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ description: Samples for the Azure.Storage.Common client library

# Azure.Storage.Common Samples

- [Configure Retries](Sample01a_HelloWorld.cs)
- [Configure Retries](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Common/samples/Sample01a_HelloWorld.cs)
4 changes: 2 additions & 2 deletions sdk/storage/Azure.Storage.Files.DataLake/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ description: Samples for the Azure.Storage.Files.DataLake client library

# Azure.Storage.Files.DataLake Samples

- Create and manipulate file systems, directories, and files [synchronously](Sample01a_HelloWorld.cs) or [asynchronously](Sample01b_HelloWorldAsync.cs).
- [Authenticate with public access, shared keys, shared access signatures, and Azure Active Directory.](Sample02_Auth.cs)
- Create and manipulate file systems, directories, and files [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.DataLake/samples/Sample01a_HelloWorld.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.DataLake/samples/Sample01b_HelloWorldAsync.cs).
- [Authenticate with public access, shared keys, shared access signatures, and Azure Active Directory.](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.DataLake/samples/Sample02_Auth.cs)
4 changes: 2 additions & 2 deletions sdk/storage/Azure.Storage.Files.Shares/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ description: Samples for the Azure.Storage.Files.Shares client library

# Azure.Storage.Files.Shares Samples

- Create, upload, download, and traverse file shares [synchronously](Sample01a_HelloWorld.cs) or [asynchronously](Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, shared keys, and shared access signatures.](Sample02_Auth.cs)
- Create, upload, download, and traverse file shares [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.Shares/samples/Sample01a_HelloWorld.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.Shares/samples/Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, shared keys, and shared access signatures.](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Files.Shares/samples/Sample02_Auth.cs)
4 changes: 2 additions & 2 deletions sdk/storage/Azure.Storage.Queues/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ description: Samples for the Azure.Storage.Queues client library

# Azure.Storage.Queues Samples

- Create and interact with queues by sending and receiving messages [synchronously](Sample01a_HelloWorld.cs) or [asynchronously](Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, shared keys, shared access signatures, and Azure Active Directory.](Sample02_Auth.cs)
- Create and interact with queues by sending and receiving messages [synchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Queues/samples/Sample01a_HelloWorld.cs) or [asynchronously](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Queues/samples/Sample01b_HelloWorldAsync.cs).
- [Authenticate with connection strings, shared keys, shared access signatures, and Azure Active Directory.](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Queues/samples/Sample02_Auth.cs)