Skip to content

[Provisioning] Add examples section to provisioning libraries #51412

@ArcturusZhang

Description

@ArcturusZhang

Now provisioning libraries cannot pass the readme validations because their readme files are missing an Examples section.

- ['sdk/provisioning/Azure.Provisioning.AppService/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Sql/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.ServiceBus/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Redis/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.EventGrid/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.SignalR/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.OperationalInsights/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Storage/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.KubernetesConfiguration/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.CosmosDB/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.EventHubs/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.CognitiveServices/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.WebPubSub/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.PostgreSql/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.AppContainers/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.KeyVault/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.ContainerRegistry/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.AppConfiguration/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Search/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Kubernetes/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Communication/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.ApplicationInsights/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.ContainerService/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']
- ['sdk/provisioning/Azure.Provisioning.Deployment/README.md', 'https://github.com/Azure/azure-sdk-tools/issues/404']

We should add an example sections to them.

The example should be possible to fetch from the corresponding test project of that provisioning library.

Please take this commit as an example of how to get the code for example: 98fe65b0272deb51d2a9c252c869ff60d8e288a4
We need to:

  1. Add a region with a name in the desired part in our corresponding test code.
  2. Update the readme's code snippet with the same name of the region above.
  3. Call /eng/scripts/Update-Snippets.ps1 provisioning to sync the code in our test cases into the markdown file.

Metadata

Metadata

Assignees

Labels

ClientThis issue is related to a non-management packageProvisioning

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions