Skip to content

Commit 1dc7c8a

Browse files
committed
Improve az acr credential-set command documentation
The CLI documentation for `az acr credential-set` is confusing. In the example it uses `az acr credential-set create -r MyRegistry -n MyRule` to demonstrate how to create a credential set. Technically there is no errors in this command, however the term `MyRule` has been used to refer to an ACR cache rule in other examples on the page. For customer who is new to Azure Container Registry this can be very confusing, as they started grappling with new concepts such as _cache rule_ and _credential set_. This commit introduces small polishes to make the documentation clearer: - Use `MyDockerHubCredSet` when demonstrating how to operate credential set. This name is carefully chosen as it clearly identifies itself as a _credential set_, also it implies it stores credentials for DockerHub, and customer could create other credential sets for other registries. - Fixed small errors on section heading, i.e. from `az-acr-credential-set-show` to `az acr credential-set show`.
1 parent 09a8caa commit 1dc7c8a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

articles/container-registry/container-registry-artifact-cache.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Before configuring the Credentials, you have to create and store secrets in the
170170
```azurecli-interactive
171171
az acr credential-set create
172172
-r MyRegistry \
173-
-n MyRule \
173+
-n MyDockerHubCredSet \
174174
-l docker.io \
175175
-u https://MyKeyvault.vault.azure.net/secrets/usernamesecret \
176176
-p https://MyKeyvault.vault.azure.net/secrets/passwordsecret
@@ -181,15 +181,15 @@ Before configuring the Credentials, you have to create and store secrets in the
181181
- For example, to update the username or password KV secret ID on the credentials for a given `MyRegistry` Azure Container Registry.
182182
183183
```azurecli-interactive
184-
az acr credential-set update -r MyRegistry -n MyRule -p https://MyKeyvault.vault.azure.net/secrets/newsecretname
184+
az acr credential-set update -r MyRegistry -n MyDockerHubCredSet -p https://MyKeyvault.vault.azure.net/secrets/newsecretname
185185
```
186186
187-
3. Run [az-acr-credential-set-show][az-acr-credential-set-show] to show the credentials.
187+
3. Run [az acr credential-set show][az-acr-credential-set-show] to show the credentials.
188188
189-
- For example, to show the credentials for a given `MyRegistry` Azure Container Registry.
189+
- For example, to show a credential set in a given `MyRegistry` Azure Container Registry.
190190
191191
```azurecli-interactive
192-
az acr credential-set show -r MyRegistry -n MyCredSet
192+
az acr credential-set show -r MyRegistry -n MyDockerHubCredSet
193193
```
194194
195195
### Configure and create a cache rule with the credentials
@@ -199,7 +199,7 @@ Before configuring the Credentials, you have to create and store secrets in the
199199
- For example, to create a cache rule with the credentials for a given `MyRegistry` Azure Container Registry.
200200
201201
```azurecli-interactive
202-
az acr cache create -r MyRegistry -n MyRule -s docker.io/library/ubuntu -t ubuntu -c MyCredSet
202+
az acr cache create -r MyRegistry -n MyRule -s docker.io/library/ubuntu -t ubuntu -c MyDockerHubCredSet
203203
```
204204
205205
2. Run [az acr cache update][az-acr-cache-update] command to update the credentials on a cache rule.
@@ -230,7 +230,7 @@ Before configuring the Credentials, you have to create and store secrets in the
230230
231231
```azurecli-interactive
232232
PRINCIPAL_ID=$(az acr credential-set show
233-
-n MyCredSet \
233+
-n MyDockerHubCredSet \
234234
-r MyRegistry \
235235
--query 'identity.principalId' \
236236
-o tsv)
@@ -282,12 +282,12 @@ Before configuring the Credentials, you have to create and store secrets in the
282282
az acr credential-set list -r MyRegistry
283283
```
284284
285-
4. Run [az-acr-credential-set-delete][az-acr-credential-set-delete] to delete the credentials.
285+
4. Run [az acr credential-set delete][az-acr-credential-set-delete] to delete the credentials.
286286
287287
- For example, to delete the credentials for a given `MyRegistry` Azure Container Registry.
288288
289289
```azurecli-interactive
290-
az acr credential-set delete -r MyRegistry -n MyCredSet
290+
az acr credential-set delete -r MyRegistry -n MyDockerHubCredSet
291291
```
292292
293293
:::zone-end

0 commit comments

Comments
 (0)