Move headers doc from docs.ms.com

This commit is contained in:
Marsh Macy 2018-01-04 12:31:37 -08:00
Родитель ab035829f0
Коммит 0525eb0f0b
2 изменённых файлов: 49 добавлений и 10 удалений

Просмотреть файл

@ -1,34 +1,36 @@
# Azure Container Registry
This repo contains Samples, Troubleshooting tips, and a collection of links for Azure Container Registry.
This repo contains [issues](https://github.com/Azure/acr/issues), [samples](./docs), [troubleshooting tips](./docs/Troubleshooting%20Guide.md), and a collection of links for Azure Container Registry.
## Blog posts
## Blog Posts ##
* [ACR User Accounts]( https://blogs.msdn.microsoft.com/stevelasker/2016/11/17/azure-container-registry-user-accounts/)
* [Managed Registry Preview](https://blogs.msdn.microsoft.com/stevelasker/2017/07/25/new-azure-container-registry-skus/)
* [Deploying Docker Images to Azure Container Instances](https://blogs.msdn.microsoft.com/stevelasker/2017/07/28/deploying-docker-images-from-the-azure-container-registry-to-azure-container-instances/)
## Resources ##
## Resources
* [Azure Container Registry Home Page](https://azure.microsoft.com/services/container-registry/)
* [Azure Container Registry Pricing](https://aka.ms/acr/pricing)
* [Official Documentation Page](https://aka.ms/acr/docs/)
* [Contribute to Documentation](https://github.com/Microsoft/azure-docs/blob/master/articles/container-registry/TOC.md)
* [Contribute to Documentation](https://github.com/MicrosoftDocs/azure-docs)
* [Azure Management Portal](https://portal.azure.com/#blade/HubsExtension/Resources/resourceType/Microsoft.ContainerRegistry%2Fregistries)
* [AZ CLI Reference](https://docs.microsoft.com/cli/azure/acr)
* [Azure PowerShell Reference](https://docs.microsoft.com/powershell/module/azurerm.containerregistry)
* [FAQ](docs/FAQ.md)
* [Troubleshooting](docs/Troubleshooting%20Guide.md)
* [FAQ](./docs/FAQ.md)
* [Troubleshooting](./docs/Troubleshooting%20Guide.md)
* [ACR Roadmap & Backlog](https://github.com/Azure/acr/blob/master/docs/acr-roadmap.md)
## Providing Feedback ##
## Provide feedback
* [StackOverflow / Community Support](https://stackoverflow.com/search?q=azure+container+registry)
* [UserVoice/Feature Voting](https://feedback.azure.com/forums/903958-azure-container-registry)
* [Logging Issues](https://github.com/Azure/acr/issues)
## API and SDK References ##
## API and SDK reference
* [REST API Reference](https://docs.microsoft.com/en-us/rest/api/containerregistry/)
* [Swagger Specification](https://github.com/Azure/azure-rest-api-specs/blob/master/arm-containerregistry/2017-03-01/swagger/containerregistry.json)
* [REST API Reference](https://docs.microsoft.com/rest/api/containerregistry/)
* [Swagger Specification](https://github.com/Azure/azure-rest-api-specs/blob/master/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json)
* [SDK for Python](https://pypi.python.org/pypi/azure-mgmt-containerregistry)
* [SDK for Python-Source](https://github.com/Azure/azure-sdk-for-python/tree/master/azure-mgmt-containerregistry)
* [SDK for .NET](https://www.nuget.org/packages/Microsoft.Azure.Management.ContainerRegistry)

37
docs/rest-api-headers.md Normal file
Просмотреть файл

@ -0,0 +1,37 @@
# Azure Container Registry HTTP headers
Azure container registries are compatible with a multitude of services and orchestrators. To make it easier to track the source services and agents from which ACR is used, we have started using the `HttpHeaders` field in the Docker `config.json` file.
## Header format
The ACR headers follow this format:
```HTTP
X-Meta-Source-Client: <cloud>/<service>/<optionalservicename>
```
* `cloud`: Azure, Azure Stack, or other government- or country-specific Azure cloud. Although Azure Stack and government clouds are not currently supported, this parameter enables future support.
* `service`: The name of the service.
* `optionalservicename`: An optional parameter for services with subservices, or for specifying a SKU. For example, Web Apps corresponds to `azure/app-service/web-apps`).
## Header values
Partner services and orchestrators are encouraged to use specific header values to help with our telemetry. Users can also modify the value passed to the header if they so desire.
The values we ask ACR partners to use when populating the `X-Meta-Source-Client` field are as follows:
| Service Name | Header |
| ------------------------- | ------------------------------------- |
| Azure Container Service | `azure/compute/azure-container-service` |
| App Service - Web Apps | `azure/app-service/web-apps` |
| App Service - Logic Apps | `azure/app-service/logic-apps` |
| Batch | `azure/compute/batch` |
| Cloud Console | `azure/cloud-console` |
| Functions | `azure/compute/functions` |
| Internet of Things - Hub | `azure/iot/hub` |
| HDInsight | `azure/data/hdinsight` |
| Jenkins | `azure/jenkins` |
| Machine Learning | `azure/data/machile-learning` |
| Service Fabric | `azure/compute/service-fabric` |
| VSTS | `azure/vsts` |