Connected Registries - Update
Updates a connected registry with the specified parameters.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}?api-version=2025-11-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
connected
|
path | True |
string minLength: 5maxLength: 50 pattern: ^[a-zA-Z0-9]*$ |
The name of the connected registry. |
|
registry
|
path | True |
string minLength: 5maxLength: 50 pattern: ^[a-zA-Z0-9]*$ |
The name of the container registry. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Request Body
| Name | Type | Description |
|---|---|---|
| properties.clientTokenIds |
string[] |
The list of the ACR token resource IDs used to authenticate clients to the connected registry. |
| properties.garbageCollection |
The garbage collection properties of the connected registry. |
|
| properties.logging |
The logging properties of the connected registry. |
|
| properties.notificationsList |
string[] |
The list of notifications subscription information for the connected registry. |
| properties.syncProperties |
The sync properties of the connected registry with its parent. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure operation completed successfully. |
|
| 201 Created |
Resource 'ConnectedRegistry' create operation succeeded Headers
|
|
| Other Status Codes |
An unexpected error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
ConnectedRegistryUpdate
Sample request
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myScopeMap?api-version=2025-11-01
{
"properties": {
"syncProperties": {
"schedule": "0 0 */10 * *",
"messageTtl": "P30D",
"syncWindow": "P2D"
},
"logging": {
"logLevel": "Debug",
"auditLogStatus": "Enabled"
},
"clientTokenIds": [
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
],
"notificationsList": [
"hello-world:*:*",
"sample/repo/*:1.0:*"
],
"garbageCollection": {
"enabled": true,
"schedule": "0 5 * * *"
}
}
}
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
"name": "myConnectedRegistry",
"type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
"properties": {
"mode": "ReadWrite",
"parent": {
"syncProperties": {
"tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
"schedule": "0 0 */10 * *",
"messageTtl": "P30D",
"syncWindow": "P2D"
}
},
"clientTokenIds": [
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
],
"logging": {
"logLevel": "Debug",
"auditLogStatus": "Enabled"
},
"notificationsList": [
"hello-world:*:*",
"sample/repo/*:1.0:*"
],
"garbageCollection": {
"enabled": true,
"schedule": "0 5 * * *"
}
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry/operationStatuses/connectedregistries-00000000-0000-0000-0000-000000000000?api-version=2025-11-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/connectedRegistries/myConnectedRegistry",
"name": "myConnectedRegistry",
"type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
"properties": {
"mode": "ReadWrite",
"parent": {
"syncProperties": {
"tokenId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/syncToken",
"schedule": "0 0 */10 * *",
"messageTtl": "P30D",
"syncWindow": "P2D"
}
},
"clientTokenIds": [
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client1Token",
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tokens/client2Token"
],
"logging": {
"logLevel": "Debug",
"auditLogStatus": "Enabled"
},
"notificationsList": [
"hello-world:*:*",
"sample/repo/*:1.0:*"
],
"garbageCollection": {
"enabled": true,
"schedule": "0 5 * * *"
}
}
}
Definitions
| Name | Description |
|---|---|
|
Activation |
The activation properties of the connected registry. |
|
Activation |
The activation status of the connected registry. |
|
Audit |
Indicates whether audit logs are enabled on the connected registry. |
|
Certificate |
The type of certificate location. |
|
Connected |
An object that represents a connected registry for a container registry. |
|
Connected |
The mode of the connected registry resource that indicates the permissions of the registry. |
|
Connected |
The parameters for updating a connected registry. |
|
Connection |
The current connection state of the connected registry. |
|
created |
The type of identity that created the resource. |
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Garbage |
The garbage collection properties of the connected registry. |
|
Logging |
The logging properties of the connected registry. |
|
Login |
The login server properties of the connected registry. |
|
Log |
The verbosity of logs persisted on the connected registry. |
|
Parent |
The properties of the connected registry parent. |
|
Provisioning |
The provisioning state of the archive at the time the operation was called. |
|
Status |
The status detail properties of the connected registry. |
|
Sync |
The sync properties of the connected registry with its parent. |
|
Sync |
The parameters for updating the sync properties of the connected registry with its parent. |
|
system |
Metadata pertaining to creation and last modification of the resource. |
|
Tls |
The TLS certificate properties of the connected registry login server. |
|
Tls |
The TLS properties of the connected registry login server. |
|
Tls |
Indicates whether HTTPS is enabled for the login server. |
ActivationProperties
The activation properties of the connected registry.
| Name | Type | Description |
|---|---|---|
| status |
The activation status of the connected registry. |
ActivationStatus
The activation status of the connected registry.
| Value | Description |
|---|---|
| Active | |
| Inactive |
AuditLogStatus
Indicates whether audit logs are enabled on the connected registry.
| Value | Description |
|---|---|
| Enabled | |
| Disabled |
CertificateType
The type of certificate location.
| Value | Description |
|---|---|
| LocalDirectory |
ConnectedRegistry
An object that represents a connected registry for a container registry.
| Name | Type | Description |
|---|---|---|
| id |
string (arm-id) |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
The name of the resource |
| properties.activation |
The activation properties of the connected registry. |
|
| properties.clientTokenIds |
string[] |
The list of the ACR token resource IDs used to authenticate clients to the connected registry. |
| properties.connectionState |
The current connection state of the connected registry. |
|
| properties.garbageCollection |
The garbage collection properties of the connected registry. |
|
| properties.lastActivityTime |
string (date-time) |
The last activity time of the connected registry. |
| properties.logging |
The logging properties of the connected registry. |
|
| properties.loginServer |
The login server properties of the connected registry. |
|
| properties.mode |
The mode of the connected registry resource that indicates the permissions of the registry. |
|
| properties.notificationsList |
string[] |
The list of notifications subscription information for the connected registry. |
| properties.parent |
The parent of the connected registry. |
|
| properties.provisioningState |
Provisioning state of the resource. |
|
| properties.statusDetails |
The list of current statuses of the connected registry. |
|
| properties.version |
string |
The current version of ACR runtime on the connected registry. |
| systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
| type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ConnectedRegistryMode
The mode of the connected registry resource that indicates the permissions of the registry.
| Value | Description |
|---|---|
| ReadWrite | |
| ReadOnly | |
| Registry | |
| Mirror |
ConnectedRegistryUpdateParameters
The parameters for updating a connected registry.
| Name | Type | Description |
|---|---|---|
| properties.clientTokenIds |
string[] |
The list of the ACR token resource IDs used to authenticate clients to the connected registry. |
| properties.garbageCollection |
The garbage collection properties of the connected registry. |
|
| properties.logging |
The logging properties of the connected registry. |
|
| properties.notificationsList |
string[] |
The list of notifications subscription information for the connected registry. |
| properties.syncProperties |
The sync properties of the connected registry with its parent. |
ConnectionState
The current connection state of the connected registry.
| Value | Description |
|---|---|
| Online | |
| Offline | |
| Syncing | |
| Unhealthy |
createdByType
The type of identity that created the resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
The resource management error additional info.
| Name | Type | Description |
|---|---|---|
| info |
object |
The additional info. |
| type |
string |
The additional info type. |
ErrorDetail
The error detail.
| Name | Type | Description |
|---|---|---|
| additionalInfo |
The error additional info. |
|
| code |
string |
The error code. |
| details |
The error details. |
|
| message |
string |
The error message. |
| target |
string |
The error target. |
ErrorResponse
Error response
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
GarbageCollectionProperties
The garbage collection properties of the connected registry.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Indicates whether garbage collection is enabled for the connected registry. |
| schedule |
string |
The cron expression indicating the schedule that the connected registry will run garbage collection. |
LoggingProperties
The logging properties of the connected registry.
| Name | Type | Default value | Description |
|---|---|---|---|
| auditLogStatus | Disabled |
Indicates whether audit logs are enabled on the connected registry. |
|
| logLevel | Information |
The verbosity of logs persisted on the connected registry. |
LoginServerProperties
The login server properties of the connected registry.
| Name | Type | Description |
|---|---|---|
| host |
string |
The host of the connected registry. Can be FQDN or IP. |
| tls |
The TLS properties of the connected registry login server. |
LogLevel
The verbosity of logs persisted on the connected registry.
| Value | Description |
|---|---|
| Debug | |
| Information | |
| Warning | |
| Error | |
| None |
ParentProperties
The properties of the connected registry parent.
| Name | Type | Description |
|---|---|---|
| id |
string (arm-id) |
The resource ID of the parent to which the connected registry will be associated. |
| syncProperties |
The sync properties of the connected registry with its parent. |
ProvisioningState
The provisioning state of the archive at the time the operation was called.
| Value | Description |
|---|---|
| Creating | |
| Updating | |
| Deleting | |
| Succeeded | |
| Failed | |
| Canceled |
StatusDetailProperties
The status detail properties of the connected registry.
| Name | Type | Description |
|---|---|---|
| code |
string |
The HTTP status code. |
| correlationId |
string |
The correlation ID of the status. |
| description |
string |
The description of the status. |
| timestamp |
string (date-time) |
The timestamp of the status. |
| type |
string |
The component of the connected registry corresponding to the status. |
SyncProperties
The sync properties of the connected registry with its parent.
| Name | Type | Description |
|---|---|---|
| gatewayEndpoint |
string |
The gateway endpoint used by the connected registry to communicate with its parent. |
| lastSyncTime |
string (date-time) |
The last time a sync occurred between the connected registry and its parent. |
| messageTtl |
string (duration) |
The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. |
| schedule |
string |
The cron expression indicating the schedule that the connected registry will sync with its parent. |
| syncWindow |
string (duration) |
The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. |
| tokenId |
string |
The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. |
SyncUpdateProperties
The parameters for updating the sync properties of the connected registry with its parent.
| Name | Type | Description |
|---|---|---|
| messageTtl |
string (duration) |
The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. |
| schedule |
string |
The cron expression indicating the schedule that the connected registry will sync with its parent. |
| syncWindow |
string (duration) |
The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. |
systemData
Metadata pertaining to creation and last modification of the resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of resource creation (UTC). |
| createdBy |
string |
The identity that created the resource. |
| createdByType |
The type of identity that created the resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of resource last modification (UTC) |
| lastModifiedBy |
string |
The identity that last modified the resource. |
| lastModifiedByType |
The type of identity that last modified the resource. |
TlsCertificateProperties
The TLS certificate properties of the connected registry login server.
| Name | Type | Description |
|---|---|---|
| location |
string |
Indicates the location of the certificates. |
| type |
The type of certificate location. |
TlsProperties
The TLS properties of the connected registry login server.
| Name | Type | Description |
|---|---|---|
| certificate |
The certificate used to configure HTTPS for the login server. |
|
| status |
Indicates whether HTTPS is enabled for the login server. |
TlsStatus
Indicates whether HTTPS is enabled for the login server.
| Value | Description |
|---|---|
| Enabled | |
| Disabled |