You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/containerregistry/container-registry/README.md
+91-14Lines changed: 91 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,20 @@
1
1
# Azure Container Registry client library for JavaScript
2
2
3
-
Azure [Container Registry](https://azure.microsoft.com/services/container-registry/) is a managed, private Docker registry service based on the open-source Docker Registry 2.0. Create and maintain Azure container registries to store and manage your private Docker container images and related artifacts.
3
+
Azure Container Registry allows you to store and manage container images and artifacts in a private registry for all types of container deployments.
4
4
5
-
Use Azure container registries with your existing container development and deployment pipelines, or use Azure Container Registry Tasks to build container images in Azure. Build on demand, or fully automate builds with triggers such as source code commits and base image updates.
5
+
Use the client library for Azure Container Registry to:
6
+
7
+
- List images or artifacts in a registry
8
+
- Obtain metadata for images and artifacts, repositories and tags
9
+
- Set read/write/delete properties on registry items
10
+
- Delete images and artifacts, repositories and tags
11
+
12
+
[Source code][source] |
13
+
[Package (NPM)]<!--[package]--> |
14
+
[API reference documentation]<!--[api_docs]--> |
15
+
[REST API documentation][rest_docs] |
16
+
[Product documentation][product_docs] |
17
+
[Samples][samples]
6
18
7
19
## Getting started
8
20
@@ -12,10 +24,15 @@ Use Azure container registries with your existing container development and depl
12
24
13
25
### Prerequisites
14
26
15
-
- An [Azure subscription][azure_sub].
16
-
- An [Azure Container Registry resource][acr_resource]
27
+
You need an [Azure subscription][azure_sub] and a [Container Registry account][container_registry_docs] to use this package.
17
28
18
-
Usually you'd put a shell command for provisioning the necessary Azure services here.
29
+
To create a new Container Registry, you can use the [Azure Portal][container_registry_create_portal],
30
+
[Azure PowerShell][container_registry_create_ps], or the [Azure CLI][container_registry_create_cli].
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
33
50
34
-
### Further examples
51
+
### Authenticate the client
52
+
53
+
The [Azure Identity library][identity] provides easy Azure Active Directory support for authentication.
Note that these samples assume you have a `REGISTRY_ENDPOINT` environment variable set, which is the URL including the name of the login server and the `https://` prefix.
35
65
36
-
Top-level examples usually include things like creating and authenticating the main Client. If your service supports multiple means of authenticating (e.g. key-based and Azure Active Directory) you can give a separate example of each.
66
+
For more information on using AAD with Azure Container Registry, please see the service's [Authentication Overview](https://docs.microsoft.com/azure/container-registry/container-registry-authentication).
37
67
38
68
## Key concepts
39
69
40
-
### ContainerRegistryClient
70
+
A **registry** stores Docker images and [OCI Artifacts](https://opencontainers.org/). An image or artifact consists of a **manifest** and **layers**. An image's manifest describes the layers that make up the image, and is uniquely identified by its **digest**. An image can also be "tagged" to give it a human-readable alias. An image or artifact can have zero or more **tags** associated with it, and each tag uniquely identifies the image. A collection of images that share the same name but have different tags, is referred to as a **repository**.
41
71
42
-
`ContainerRegistryClient` provides operations to interact with an Azure Container Registry instance.
72
+
For more information please see [Container Registry Concepts](https://docs.microsoft.com/azure/container-registry/container-registry-concepts).
43
73
44
74
## Examples
45
75
46
-
### First Example
76
+
### Listing repositories
47
77
48
-
<!-- Examples should showcase the primary, or "champion" scenarios of the client SDK. -->
78
+
Iterate through the collection of repositories in the registry.
console.error("The sample encountered an error:", err);
110
+
});
111
+
```
49
112
50
113
Create several code examples for how someone would use your library to accomplish a common task with the service.
51
114
@@ -63,18 +126,32 @@ setLogLevel("info");
63
126
64
127
## Next steps
65
128
66
-
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/containerregistry/container-registry/samples) directory for detailed examples that demonstrate how to use the client libraries.
129
+
Please take a look at the [samples][samples] directory for detailed examples that demonstrate how to use the client libraries.
67
130
68
131
## Contributing
69
132
70
133
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
71
134
72
135
## Related projects
73
136
74
-
-[Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
0 commit comments