Microsoft.ContainerRegistry (stable:2025-04-01)

2025/05/06 • 4 updated methods

ConnectedRegistries_Get (updated)
Description :  Gets the properties of the connected registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedRegistries_Create (updated)
Description :  Creates a connected registry for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Create",
  "$parameters": {
    "connectedRegistryCreateParameters": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
connectedRegistryCreateParameters:
{
Description: The parameters for creating a connectedRegistry. ,
Required: True ,
}
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: An object that represents a connected registry for a container registry. ,
}
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedRegistries_Update (updated)
Description :  Updates a connected registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Update",
  "$parameters": {
    "connectedRegistryUpdateParameters": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "properties",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
connectedRegistryUpdateParameters:
{
Description: The parameters for updating a connectedRegistry. ,
Required: True ,
}
{
properties:
{
Description: The properties of the connected registry update parameters. ,
Required: False ,
}
{
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: False ,
}
{
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: An object that represents a connected registry for a container registry. ,
}
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ConnectedRegistries_List (updated)
Description :  Lists all connected registries for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "properties",
              "Type": {
                "new": "object",
                "old": "string"
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of connected registries. Since this list may be incomplete, the nextLink field should be used to request the next list of connected registries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: 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. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: 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. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
garbageCollection:
{
Description: The garbage collection properties of the connected registry. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether garbage collection is enabled for the connected registry. ,
Required: False ,
}
boolean ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will run garbage collection. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of connected registries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}