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

2025/10/27 • 56 updated methods

Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Lists all of the available Azure Container Registry REST API operations."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "isDataAction",
              "Description": {
                "new": "This property indicates if the operation is an action or a data action\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations",
                "old": "This property indicates if the operation is an action or a data action\r\nref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations"
              }
            }
          ]
        }
      }
    },
    "@added_624fcb111d26401ca1bc4b18f8dce8f5": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.ContainerRegistry/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of container registry operations. Since this list may be incomplete, the nextLink field should be used to request the next list of operations. ,
Required: False ,
}
[
{
origin:
{
Description: The origin information of the container registry operation. ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The display information for the container registry operation. ,
Required: False ,
}
{
provider:
{
Description: The resource provider name: Microsoft.ContainerRegistry. ,
Required: False ,
}
string ,
resource:
{
Description: The resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation that users can perform. ,
Required: False ,
}
string ,
description:
{
Description: The description for the operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties information for the container registry operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The definition of Azure Monitoring service. ,
Required: False ,
}
{
metricSpecifications:
{
Description: A list of Azure Monitoring metrics definition. ,
Required: False ,
}
[
{
name:
{
Description: Metric name. ,
Required: False ,
}
string ,
displayName:
{
Description: Metric display name. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Metric description. ,
Required: False ,
}
string ,
unit:
{
Description: Metric unit. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Metric aggregation type. ,
Required: False ,
}
string ,
internalMetricName:
{
Description: Internal metric name. ,
Required: False ,
}
string ,
}
,
]
,
logSpecifications:
{
Description: A list of Azure Monitoring log definitions. ,
Required: False ,
}
[
{
name:
{
Description: Log name. ,
Required: False ,
}
string ,
displayName:
{
Description: Log display name. ,
Required: False ,
}
string ,
blobDuration:
{
Description: Log blob duration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
isDataAction:
{
Description: This property indicates if the operation is an action or a data action ref: https://docs.microsoft.com/en-us/azure/role-based-access-control/role-definitions#management-and-data-operations ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container registry operations. ,
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 ,
}
,
]
,
}
,
}
Registries_CheckNameAvailability (updated)
Description :  Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_CheckNameAvailability",
  "$parameters": [
    {
      "#name": "registryNameCheckRequest",
      "Description": {
        "new": "The request body",
        "old": "The object containing information for the availability request."
      },
      "$schema": {
        "$properties": {
          "@added_d94b846429e448eea3b5040e31ac64f7": {
            "#name": "resourceGroupName",
            "Description": "The resource group name of the container registry.",
            "Required": false,
            "Type": "string"
          },
          "@added_add44c313e0a42fbbcfb88368a0ab91d": {
            "#name": "autoGeneratedDomainNameLabelScope",
            "Description": "The auto generated domain name label of the container registry. This value defaults to \"Unsecure\".",
            "Enum": [
              [
                "Unsecure",
                ""
              ],
              [
                "TenantReuse",
                ""
              ],
              [
                "SubscriptionReuse",
                ""
              ],
              [
                "ResourceGroupReuse",
                ""
              ],
              [
                "NoReuse",
                ""
              ]
            ],
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_dfcb91c1048b47fdafd4cda111451b86": {
          "#name": "availableLoginServerName",
          "Description": "The complete login server name with domain name label (DNL) hash, if available",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "@added_60b9fccaba344fe0be99cc1ff0565abe": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability
{
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 ,
registryNameCheckRequest:
{
Description: The request body ,
Required: True ,
}
{
name:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
type:
{
Description: The resource type of the container registry. This field must be set to 'Microsoft.ContainerRegistry/registries'. ,
Enum:
{
Microsoft.ContainerRegistry/registries: No description available. ,
}
,
Required: True ,
}
enum ,
resourceGroupName:
{
Description: The resource group name of the container registry. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: The auto generated domain name label of the container registry. This value defaults to "Unsecure". ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
availableLoginServerName:
{
Description: The complete login server name with domain name label (DNL) hash, if available ,
Required: False ,
}
string ,
nameAvailable:
{
Description: The value that indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: If any, the reason that the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: If any, the error message that provides more detail for the reason that the name is not available. ,
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 ,
}
,
]
,
}
,
}
Registries_List (updated)
Description :  Lists all the container registries under the specified subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "policies": [
                  {
                    "#name": "azureADAuthenticationAsArmPolicy",
                    "Description": {
                      "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                      "old": "The policy for using ARM audience token for a container registry."
                    }
                  }
                ]
              },
              {
                "@added_f1dc4e93cf2c46aeac565b84337dcb71": {
                  "#name": "autoGeneratedDomainNameLabelScope",
                  "Description": "Determines the domain name label reuse scope.",
                  "Enum": [
                    [
                      "Unsecure",
                      ""
                    ],
                    [
                      "TenantReuse",
                      ""
                    ],
                    [
                      "SubscriptionReuse",
                      ""
                    ],
                    [
                      "ResourceGroupReuse",
                      ""
                    ],
                    [
                      "NoReuse",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ],
            "identity": [
              {
                "#name": "userAssignedIdentities",
                "Description": {
                  "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                  "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
                }
              }
            ]
          }
        }
      }
    },
    "@added_264865ef5ab34d87a93c237980a2856f": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container 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 ,
}
,
]
,
}
,
}
Registries_ListByResourceGroup (updated)
Description :  Lists all the container registries under the specified resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "policies": [
                  {
                    "#name": "azureADAuthenticationAsArmPolicy",
                    "Description": {
                      "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                      "old": "The policy for using ARM audience token for a container registry."
                    }
                  }
                ]
              },
              {
                "@added_6ecab64457784930af0b4f491aab3024": {
                  "#name": "autoGeneratedDomainNameLabelScope",
                  "Description": "Determines the domain name label reuse scope.",
                  "Enum": [
                    [
                      "Unsecure",
                      ""
                    ],
                    [
                      "TenantReuse",
                      ""
                    ],
                    [
                      "SubscriptionReuse",
                      ""
                    ],
                    [
                      "ResourceGroupReuse",
                      ""
                    ],
                    [
                      "NoReuse",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ],
            "identity": [
              {
                "#name": "userAssignedIdentities",
                "Description": {
                  "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                  "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
                }
              }
            ]
          }
        }
      }
    },
    "@added_f07b56a8b9ef4973823e71a050cdcf23": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of container registries. Since this list may be incomplete, the nextLink field should be used to request the next list of container registries. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container 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 ,
}
,
]
,
}
,
}
Registries_Get (updated)
Description :  Gets the properties of the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "policies": [
              {
                "#name": "azureADAuthenticationAsArmPolicy",
                "Description": {
                  "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                  "old": "The policy for using ARM audience token for a container registry."
                }
              }
            ]
          },
          {
            "@added_db4216ba429c4300994b13808e745e63": {
              "#name": "autoGeneratedDomainNameLabelScope",
              "Description": "Determines the domain name label reuse scope.",
              "Enum": [
                [
                  "Unsecure",
                  ""
                ],
                [
                  "TenantReuse",
                  ""
                ],
                [
                  "SubscriptionReuse",
                  ""
                ],
                [
                  "ResourceGroupReuse",
                  ""
                ],
                [
                  "NoReuse",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ],
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ]
      }
    },
    "@added_202b90e80dec4ec59971a867f3ee2171": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_Create (updated)
Description :  Creates a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_Create",
  "$parameters": {
    "registry": {
      "$properties": {
        "properties": [
          {
            "policies": [
              {
                "#name": "azureADAuthenticationAsArmPolicy",
                "Description": {
                  "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                  "old": "The policy for using ARM audience token for a container registry."
                }
              }
            ]
          },
          {
            "@added_16fef74595794142a133b97eb32d42b4": {
              "#name": "autoGeneratedDomainNameLabelScope",
              "Description": "Determines the domain name label reuse scope.",
              "Enum": [
                [
                  "Unsecure",
                  ""
                ],
                [
                  "TenantReuse",
                  ""
                ],
                [
                  "SubscriptionReuse",
                  ""
                ],
                [
                  "ResourceGroupReuse",
                  ""
                ],
                [
                  "NoReuse",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ],
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "policies": [
                {
                  "#name": "azureADAuthenticationAsArmPolicy",
                  "Description": {
                    "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                    "old": "The policy for using ARM audience token for a container registry."
                  }
                }
              ]
            },
            {
              "@added_bfd5888dc5aa471c9696151aa91f6d9b": {
                "#name": "autoGeneratedDomainNameLabelScope",
                "Description": "Determines the domain name label reuse scope.",
                "Enum": [
                  [
                    "Unsecure",
                    ""
                  ],
                  [
                    "TenantReuse",
                    ""
                  ],
                  [
                    "SubscriptionReuse",
                    ""
                  ],
                  [
                    "ResourceGroupReuse",
                    ""
                  ],
                  [
                    "NoReuse",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_ad924450c45a4931aba144412f697244": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "policies": [
                {
                  "#name": "azureADAuthenticationAsArmPolicy",
                  "Description": {
                    "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                    "old": "The policy for using ARM audience token for a container registry."
                  }
                }
              ]
            },
            {
              "@added_9b59cc4965df497aafae5ef0e56ef46b": {
                "#name": "autoGeneratedDomainNameLabelScope",
                "Description": "Determines the domain name label reuse scope.",
                "Enum": [
                  [
                    "Unsecure",
                    ""
                  ],
                  [
                    "TenantReuse",
                    ""
                  ],
                  [
                    "SubscriptionReuse",
                    ""
                  ],
                  [
                    "ResourceGroupReuse",
                    ""
                  ],
                  [
                    "NoReuse",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "@added_f6df6c9460ed4406b6507500913b7811": {
        "default": {
          "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
          "Type": "object",
          "$properties": [
            {
              "#name": "error",
              "Description": "The error object.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "code",
                  "Description": "The error code.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "message",
                  "Description": "The error message.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "target",
                  "Description": "The error target.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "details",
                  "Description": "The error details.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "additionalInfo",
                  "Description": "The error additional info.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "The resource management error additional info.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "type",
                        "Description": "The additional info type.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "info",
                        "Description": "The additional info.",
                        "Required": false,
                        "Type": "object"
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
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 ,
registry:
{
Description: The parameters for creating a container registry. ,
Required: True ,
}
{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a container registry. ,
}
{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_Update (updated)
Description :  Updates a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_Update",
  "$parameters": {
    "registryUpdateParameters": {
      "$properties": {
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ],
        "properties": [
          {
            "policies": [
              {
                "#name": "azureADAuthenticationAsArmPolicy",
                "Description": {
                  "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                  "old": "The policy for using ARM audience token for a container registry."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "policies": [
                {
                  "#name": "azureADAuthenticationAsArmPolicy",
                  "Description": {
                    "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                    "old": "The policy for using ARM audience token for a container registry."
                  }
                }
              ]
            },
            {
              "@added_8d81b2b2efb643e8b59b96128c57e79e": {
                "#name": "autoGeneratedDomainNameLabelScope",
                "Description": "Determines the domain name label reuse scope.",
                "Enum": [
                  [
                    "Unsecure",
                    ""
                  ],
                  [
                    "TenantReuse",
                    ""
                  ],
                  [
                    "SubscriptionReuse",
                    ""
                  ],
                  [
                    "ResourceGroupReuse",
                    ""
                  ],
                  [
                    "NoReuse",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_92af438b8c4c49ada567393268c1d327": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "policies": [
                {
                  "#name": "azureADAuthenticationAsArmPolicy",
                  "Description": {
                    "new": "The policy for using Azure Resource Manager audience token for a container registry.",
                    "old": "The policy for using ARM audience token for a container registry."
                  }
                }
              ]
            },
            {
              "@added_2c0cd0c08ccd46e4a5ca4ac68cd21390": {
                "#name": "autoGeneratedDomainNameLabelScope",
                "Description": "Determines the domain name label reuse scope.",
                "Enum": [
                  [
                    "Unsecure",
                    ""
                  ],
                  [
                    "TenantReuse",
                    ""
                  ],
                  [
                    "SubscriptionReuse",
                    ""
                  ],
                  [
                    "ResourceGroupReuse",
                    ""
                  ],
                  [
                    "NoReuse",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "@added_1d4049a8be3a4f7ea97fba2cd75e7fe8": {
        "default": {
          "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
          "Type": "object",
          "$properties": [
            {
              "#name": "error",
              "Description": "The error object.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "code",
                  "Description": "The error code.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "message",
                  "Description": "The error message.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "target",
                  "Description": "The error target.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "details",
                  "Description": "The error details.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "additionalInfo",
                  "Description": "The error additional info.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "The resource management error additional info.",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "type",
                        "Description": "The additional info type.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "info",
                        "Description": "The additional info.",
                        "Required": false,
                        "Type": "object"
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
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 ,
registryUpdateParameters:
{
Description: The parameters for updating a container registry. ,
Required: True ,
}
{
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: The tags for the container registry. ,
Required: False ,
}
object ,
sku:
{
Description: The SKU of the container registry. ,
Required: False ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The properties that the container registry will be updated with. ,
Required: False ,
}
{
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether to allow ACR Tasks service to access a network restricted registry. ,
Required: False ,
}
boolean ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a container registry. ,
}
{
properties:
{
Description: The properties of the container registry. ,
Required: False ,
}
{
loginServer:
{
Description: The URL that can be used to log into the container registry. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the container registry in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the container registry at the time the operation was called. ,
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 ,
status:
{
Description: The status of the container registry at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
adminUserEnabled:
{
Description: The value that indicates whether the admin user is enabled. ,
Required: False ,
}
boolean ,
networkRuleSet:
{
Description: The network rule set for a container registry. ,
Required: False ,
}
{
defaultAction:
{
Description: The default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
ipRules:
{
Description: The IP ACL rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
}
,
]
,
}
,
policies:
{
Description: The policies for a container registry. ,
Required: False ,
}
{
quarantinePolicy:
{
Description: The quarantine policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
trustPolicy:
{
Description: The content trust policy for a container registry. ,
Required: False ,
}
{
type:
{
Description: The type of trust policy. ,
Enum:
{
Notary: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
retentionPolicy:
{
Description: The retention policy for a container registry. ,
Required: False ,
}
{
days:
{
Description: The number of days to retain an untagged manifest after which it gets purged. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedTime:
{
Description: The timestamp when the policy was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
exportPolicy:
{
Description: The export policy for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
azureADAuthenticationAsArmPolicy:
{
Description: The policy for using Azure Resource Manager audience token for a container registry. ,
Required: False ,
}
{
status:
{
Description: The value that indicates whether the policy is enabled or not. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
encryption:
{
Description: The encryption settings of container registry. ,
Required: False ,
}
{
status:
{
Description: Indicates whether or not the encryption is enabled for container registry. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Key vault properties. ,
Required: False ,
}
{
keyIdentifier:
{
Description: Key vault uri to access the encryption key. ,
Required: False ,
}
string ,
versionedKeyIdentifier:
{
Description: The fully qualified key identifier that includes the version of the key that is actually used for encryption. ,
Required: False ,
}
string ,
identity:
{
Description: The client id of the identity which will be used to access key vault. ,
Required: False ,
}
string ,
keyRotationEnabled:
{
Description: Auto key rotation status for a CMK enabled registry. ,
Required: False ,
}
boolean ,
lastKeyRotationTimestamp:
{
Description: Timestamp of the last successful key rotation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
dataEndpointEnabled:
{
Description: Enable a single data endpoint per region for serving data. ,
Required: False ,
}
boolean ,
dataEndpointHostNames:
{
Description: List of host names that will serve data when dataEndpointEnabled is true. ,
Required: False ,
}
[
string ,
]
,
privateEndpointConnections:
{
Description: List of private endpoint connections for a container registry. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for the container registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassOptions:
{
Description: Whether to allow trusted Azure services to access a network restricted registry. ,
Enum:
{
AzureServices: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
networkRuleBypassAllowedForTasks:
{
Description: Whether or not Tasks allowed to bypass the network rules for this container registry. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
autoGeneratedDomainNameLabelScope:
{
Description: Determines the domain name label reuse scope. ,
Enum:
{
Unsecure: No description available. ,
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
roleAssignmentMode:
{
Description: Determines registry role assignment mode. ,
Enum:
{
AbacRepositoryPermissions: No description available. ,
LegacyRegistryPermissions: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The SKU of the container registry. ,
Required: True ,
}
{
name:
{
Description: The SKU name of the container registry. Required for registry creation. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier based on the SKU name. ,
Enum:
{
Classic: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity of the container registry. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_Delete (updated)
Description :  Deletes a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_Delete",
  "$responses": {
    "202": [
      {
        "@added_cd6f9687d77a4a81990294960cd2fe27": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_72713b49fa32459e8b52413e384008b3": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
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 ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
CacheRules_List (updated)
Description :  Lists all cache rule resources for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CacheRules_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The list of cache rules. Since this list may be incomplete, the nextLink field should be used to request the next list of cache rules.",
            "old": "The list of cache rules."
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "targetRepository",
                  "Description": {
                    "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
                    "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The URI that can be used to request the next list of cache rules.",
            "old": "If provided, client must use NextLink URI to request next list of cache rules."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of cache rules. Since this list may be incomplete, the nextLink field should be used to request the next list of cache rules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of cache rules. ,
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 ,
}
,
]
,
}
,
}
CacheRules_Get (updated)
Description :  Gets the properties of the specified cache rule resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CacheRules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "targetRepository",
            "Description": {
              "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
              "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}
{
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 ,
cacheRuleName:
{
Description: The name of the cache rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CacheRules_Create (updated)
Description :  Creates a cache rule for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CacheRules_Create",
  "$parameters": {
    "cacheRuleCreateParameters": {
      "$properties": {
        "properties": [
          {
            "#name": "targetRepository",
            "Description": {
              "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
              "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "targetRepository",
              "Description": {
                "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
                "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_891956c8d09c460c89b086ac6bd9dee0": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "targetRepository",
              "Description": {
                "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
                "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}
{
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 ,
cacheRuleName:
{
Description: The name of the cache rule. ,
Required: True ,
}
string ,
cacheRuleCreateParameters:
{
Description: The parameters for creating a cache rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a cache rule for a container registry. ,
}
{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CacheRules_Update (updated)
Description :  Updates a cache rule for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CacheRules_Update",
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "targetRepository",
              "Description": {
                "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
                "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_231eedf9ff70440f8f24098cae2dba06": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "targetRepository",
              "Description": {
                "new": "Target repository specified in docker pull command.\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}",
                "old": "Target repository specified in docker pull command.\r\nEg: docker pull myregistry.azurecr.io/{targetRepository}:{tag}"
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}
{
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 ,
cacheRuleName:
{
Description: The name of the cache rule. ,
Required: True ,
}
string ,
cacheRuleUpdateParameters:
{
Description: The parameters for updating a cache rule. ,
Required: True ,
}
{
properties:
{
Description: The properties of the cache rule update parameters. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the Cache rule. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a cache rule for a container registry. ,
}
{
properties:
{
Description: The properties of the cache rule. ,
Required: False ,
}
{
credentialSetResourceId:
{
Description: The ARM resource ID of the credential store which is associated with the cache rule. ,
Required: False ,
}
string ,
sourceRepository:
{
Description: Source repository pulled from upstream. ,
Required: False ,
}
string ,
targetRepository:
{
Description: Target repository specified in docker pull command. Eg: docker pull myregistry.azurecr.io/{targetRepository}:{tag} ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of the cache rule. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CacheRules_Delete (updated)
Description :  Deletes a cache rule resource from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CacheRules_Delete",
  "$responses": {
    "202": [
      {
        "@added_e7478221c19d49d0872ade0a1e620efb": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/cacheRules/{cacheRuleName}
{
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 ,
cacheRuleName:
{
Description: The name of the cache rule. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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": {
            "properties": [
              {
                "statusDetails": {
                  "$properties": [
                    {
                      "#name": "code",
                      "Description": {
                        "new": "The HTTP status code.",
                        "old": "The code of the status."
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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. ,
Format: arm-id ,
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 HTTP status code. ,
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 ,
}
,
]
,
}
,
}
ConnectedRegistries_Get (updated)
Description :  Gets the properties of the connected registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "statusDetails": {
              "$properties": [
                {
                  "#name": "code",
                  "Description": {
                    "new": "The HTTP status code.",
                    "old": "The code of the status."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ 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. ,
Format: arm-id ,
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 HTTP status code. ,
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": {
        "properties": [
          {
            "statusDetails": {
              "$properties": [
                {
                  "#name": "code",
                  "Description": {
                    "new": "The HTTP status code.",
                    "old": "The code of the status."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "statusDetails": {
                "$properties": [
                  {
                    "#name": "code",
                    "Description": {
                      "new": "The HTTP status code.",
                      "old": "The code of the status."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_7b001b76a246499ba4717d486a1753fa": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "statusDetails": {
                "$properties": [
                  {
                    "#name": "code",
                    "Description": {
                      "new": "The HTTP status code.",
                      "old": "The code of the status."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ 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. ,
Format: arm-id ,
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 HTTP status code. ,
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. ,
Format: arm-id ,
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 HTTP status code. ,
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:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$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. ,
Format: arm-id ,
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 HTTP status code. ,
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",
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "statusDetails": {
                "$properties": [
                  {
                    "#name": "code",
                    "Description": {
                      "new": "The HTTP status code.",
                      "old": "The code of the status."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_90dbcf7940de4f6f8bb466caaa92b573": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "statusDetails": {
                "$properties": [
                  {
                    "#name": "code",
                    "Description": {
                      "new": "The HTTP status code.",
                      "old": "The code of the status."
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ 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. ,
Format: arm-id ,
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 HTTP status code. ,
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:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$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. ,
Format: arm-id ,
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 HTTP status code. ,
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_Delete (updated)
Description :  Deletes a connected registry from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Delete",
  "$responses": {
    "202": [
      {
        "@added_d7a190d7d0d0436fa92b03f927361518": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /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)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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_Deactivate (updated)
Description :  Deactivates the connected registry instance.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConnectedRegistries_Deactivate",
  "$responses": {
    "202": [
      {
        "@added_e0e6edad7cee4d17b47fea5e299ed798": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate
{
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)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
CredentialSets_List (updated)
Description :  Lists all credential set resources for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CredentialSets_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "authCredentials",
                "Description": {
                  "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
                  "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
                }
              }
            ],
            "identity": [
              {
                "#name": "userAssignedIdentities",
                "Description": {
                  "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                  "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of credential sets. Since this list may be incomplete, the nextLink field should be used to request the next list of credential sets. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of credential sets. ,
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 ,
}
,
]
,
}
,
}
CredentialSets_Get (updated)
Description :  Gets the properties of the specified credential set resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CredentialSets_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "authCredentials",
            "Description": {
              "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
              "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
            }
          }
        ],
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}
{
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 ,
credentialSetName:
{
Description: The name of the credential set. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CredentialSets_Create (updated)
Description :  Creates a credential set for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CredentialSets_Create",
  "$parameters": {
    "credentialSetCreateParameters": {
      "$properties": {
        "properties": [
          {
            "#name": "authCredentials",
            "Description": {
              "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
              "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
            }
          }
        ],
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "authCredentials",
              "Description": {
                "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
                "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_b0c8358e3a6b4314a4d3abc7d37d7468": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "authCredentials",
              "Description": {
                "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
                "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}
{
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 ,
credentialSetName:
{
Description: The name of the credential set. ,
Required: True ,
}
string ,
credentialSetCreateParameters:
{
Description: The parameters for creating a credential set. ,
Required: True ,
}
{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a credential set resource for a container registry. ,
}
{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CredentialSets_Update (updated)
Description :  Updates a credential set for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CredentialSets_Update",
  "$parameters": {
    "credentialSetUpdateParameters": {
      "$properties": {
        "properties": [
          {
            "#name": "authCredentials",
            "Description": {
              "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
              "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
            }
          }
        ],
        "identity": [
          {
            "#name": "userAssignedIdentities",
            "Description": {
              "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
              "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "authCredentials",
              "Description": {
                "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
                "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_2f49288a91a74866b3f9dff7815d28b9": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "authCredentials",
              "Description": {
                "new": "List of authentication credentials stored for an upstream.\nUsually consists of a primary and an optional secondary credential.",
                "old": "List of authentication credentials stored for an upstream.\r\nUsually consists of a primary and an optional secondary credential."
              }
            }
          ],
          "identity": [
            {
              "#name": "userAssignedIdentities",
              "Description": {
                "new": "The list of user identities associated with the resource. The user identity\ndictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\nproviders/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.",
                "old": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n    providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'."
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}
{
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 ,
credentialSetName:
{
Description: The name of the credential set. ,
Required: True ,
}
string ,
credentialSetUpdateParameters:
{
Description: The parameters for updating a credential set. ,
Required: True ,
}
{
properties:
{
Description: The properties of the credential set update parameters ,
Required: False ,
}
{
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a credential set resource for a container registry. ,
}
{
properties:
{
Description: The properties of the credential set. ,
Required: False ,
}
{
loginServer:
{
Description: The credentials are stored for this upstream or login server. ,
Required: False ,
}
string ,
authCredentials:
{
Description: List of authentication credentials stored for an upstream. Usually consists of a primary and an optional secondary credential. ,
Required: False ,
}
[
{
name:
{
Description: The name of the credential. ,
Enum:
{
Credential1: No description available. ,
}
,
Required: False ,
}
enum ,
usernameSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the username. ,
Required: False ,
}
string ,
passwordSecretIdentifier:
{
Description: KeyVault Secret URI for accessing the password. ,
Required: False ,
}
string ,
credentialHealth:
{
Description: This provides data pertaining to the health of the auth credential. ,
Required: False ,
}
{
status:
{
Description: The health status of credential. ,
Enum:
{
Healthy: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code representing the health check error. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Descriptive message representing the health check error. ,
Required: False ,
}
string ,
}
,
}
,
]
,
creationDate:
{
Description: The creation date of credential store resource. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
}
,
identity:
{
Description: Identities associated with the resource. This is used to access the KeyVault secrets. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CredentialSets_Delete (updated)
Description :  Deletes a credential set from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CredentialSets_Delete",
  "$responses": {
    "202": [
      {
        "@added_d797c7f625ea4d8b9d59f5c28beab2d2": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/credentialSets/{credentialSetName}
{
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 ,
credentialSetName:
{
Description: The name of the credential set. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_GenerateCredentials (updated)
Description :  Generate keys for a token of a specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_GenerateCredentials",
  "$responses": {
    "202": [
      {
        "@added_626afe56ee6e4fc5890391ef808f0d85": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials
{
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 ,
generateCredentialsParameters:
{
Description: The parameters for generating credentials. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the token for which credentials have to be generated. ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry date of the generated credentials after which the credentials become invalid. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Specifies name of the password which should be regenerated if any -- password1 or password2. ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
username:
{
Description: The username for a container registry. ,
Required: False ,
}
string ,
passwords:
{
Description: The list of passwords for a container registry. ,
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_ImportImage (updated)
Description :  Copies an image to this container registry from the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_ImportImage",
  "$parameters": {
    "parameters": {
      "$properties": {
        "source": [
          {
            "#name": "sourceImage",
            "Description": {
              "new": "Repository name of the source image.\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\nSpecify an image by tag ('hello-world:latest').\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123').",
              "old": "Repository name of the source image.\r\nSpecify an image by repository ('hello-world'). This will use the 'latest' tag.\r\nSpecify an image by tag ('hello-world:latest').\r\nSpecify an image by sha256-based manifest digest ('hello-world@sha256:abc123')."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "202": [
      {
        "@added_bbafc6fe160944c5b2f12a6f541647da": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_cd3f6662557a4c2ca14fedfa29402d24": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage
{
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 ,
parameters:
{
Description: The parameters specifying the image to copy and the source container registry. ,
Required: True ,
}
{
source:
{
Description: The source of the image. ,
Required: True ,
}
{
resourceId:
{
Description: The resource identifier of the source Azure Container Registry. ,
Required: False ,
}
string ,
registryUri:
{
Description: The address of the source registry (e.g. 'mcr.microsoft.com'). ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials used when importing from a registry uri. ,
Required: False ,
}
{
username:
{
Description: The username to authenticate with the source registry. ,
Required: False ,
}
string ,
password:
{
Description: The password used to authenticate with the source registry. ,
Required: True ,
}
string ,
}
,
sourceImage:
{
Description: Repository name of the source image. Specify an image by repository ('hello-world'). This will use the 'latest' tag. Specify an image by tag ('hello-world:latest'). Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). ,
Required: True ,
}
string ,
}
,
targetTags:
{
Description: List of strings of the form repo[:tag]. When tag is omitted the source will be used (or 'latest' if source tag is also omitted). ,
Required: False ,
}
[
string ,
]
,
untaggedTargetRepositories:
{
Description: List of strings of repository names to do a manifest only copy. No tag will be created. ,
Required: False ,
}
[
string ,
]
,
mode:
{
Description: When Force, any existing target tags will be overwritten. When NoForce, any existing target tags will fail the operation before any copying begins. ,
Enum:
{
NoForce: No description available. ,
Force: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_ListCredentials (updated)
Description :  Lists the login credentials for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_ListCredentials",
  "$responses": {
    "@added_aee0e0b94651422cbd7d87757c55c217": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials
{
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 ,
}

⚐ Response (200)

{
username:
{
Description: The username for a container registry. ,
Required: False ,
}
string ,
passwords:
{
Description: The list of passwords for a container registry. ,
Required: False ,
}
[
{
name:
{
Description: The password name. ,
Enum:
{
password: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
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 ,
}
,
]
,
}
,
}
Registries_ListUsages (updated)
Description :  Gets the quota usages for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_ListUsages",
  "$responses": {
    "@added_66e27b4394414d1cb35e5b9d6fc7ad56": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of container registry quota usages. ,
Required: False ,
}
[
{
name:
{
Description: The name of the usage. ,
Required: False ,
}
string ,
limit:
{
Description: The limit of the usage. ,
Format: int64 ,
Required: False ,
}
integer ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: False ,
}
integer ,
unit:
{
Description: The unit of measurement. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (updated)
Description :  List all private endpoint connections in a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_List",
  "$responses": {
    "@added_d75dc60f200f4815ad5caebb880b8ef9": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of private endpoint connections. Since this list may be incomplete, the nextLink field should be used to request the next list of private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of private endpoint connections. ,
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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (updated)
Description :  Get the specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Get",
  "$responses": {
    "@added_4aa612b91e1341f39c87e5628fae2534": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (updated)
Description :  Update the state of specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_CreateOrUpdate",
  "$responses": {
    "201": [
      {
        "@added_12ee597d89c84d2ead7db6f67205992c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_6bb9702766824a68b014b3d1a009d937": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
privateEndpointConnection:
{
Description: The parameters for creating a private endpoint connection. ,
Required: True ,
}
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a private endpoint connection for a container registry. ,
}
{
properties:
{
Description: The properties of a private endpoint connection. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private endpoint. ,
Required: False ,
}
{
id:
{
Description: This is private endpoint resource created with Microsoft.Network resource provider. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: False ,
}
{
status:
{
Description: The private link service connection status. ,
Enum:
{
Approved: No description available. ,
Pending: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The description for connection status. For example if connection is rejected it can indicate reason for rejection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Enum:
{
None: No description available. ,
Recreate: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The provisioning state of private endpoint connection 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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (updated)
Description :  Deletes the specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_Delete",
  "$responses": {
    "202": [
      {
        "@added_4c13537a65fc48cd9c73e784e3ed13f0": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_7a6747fc8a6a40f497ace74792f831a7": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Registries_ListPrivateLinkResources (updated)
Description :  Lists the private link resources for a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_ListPrivateLinkResources",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A private link resource.",
            "old": "A resource that supports private link capabilities."
          },
          "$properties": [
            {
              "#name": "properties",
              "Description": {
                "new": "Resource properties.",
                "old": "A resource that supports private link capabilities."
              },
              "$properties": [
                {
                  "#name": "requiredZoneNames",
                  "Description": {
                    "new": "The private link resource private link DNS zone name.",
                    "old": "The private link resource Private link DNS zone name."
                  }
                }
              ]
            },
            {
              "@removed_4e604c70c8b74981b0f2aaf584a8c96e": {
                "#name": "type",
                "Description": "The resource type is private link resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_787af044c7af465e88c1ccd80cfd3c74": {
                "#name": "id",
                "Description": "The resource ID.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@removed_3b3fb95e27434977a0ca1a10213f1324": {
                "#name": "name",
                "Description": "The name of the resource.",
                "Required": false,
                "Type": "string"
              }
            }
          ]
        }
      }
    },
    "@added_ebf6b219808e4519a03366ac732d3647": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of private link resources. Since this list may be incomplete, the nextLink field should be used to request the next list of private link resources. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of private link resources. ,
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 ,
}
,
]
,
}
,
}
Registries_GetPrivateLinkResource (updated)
Description :  Gets a private link resource by a specified group name for a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_GetPrivateLinkResource",
  "$parameters": [
    {
      "#name": "groupName",
      "Description": {
        "new": "The name of the private link associated with the Azure resource.",
        "old": "The name of the private link resource."
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A private link resource.",
        "old": "A resource that supports private link capabilities."
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Resource properties.",
            "old": "A resource that supports private link capabilities."
          },
          "$properties": [
            {
              "#name": "requiredZoneNames",
              "Description": {
                "new": "The private link resource private link DNS zone name.",
                "old": "The private link resource Private link DNS zone name."
              }
            }
          ]
        },
        {
          "@removed_5cc0300400cc4e45b872b946d4fe3a8a": {
            "#name": "type",
            "Description": "The resource type is private link resource.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_4f7da6288b5248e883cbaf1c5efee5df": {
            "#name": "id",
            "Description": "The resource ID.",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@removed_a1352f0d6f3d4e20a6444f593438aa19": {
            "#name": "name",
            "Description": "The name of the resource.",
            "Required": false,
            "Type": "string"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}
{
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 ,
groupName:
{
Description: The name of the private link associated with the Azure resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource private link DNS zone name. ,
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 ,
}
,
]
,
}
,
}
Registries_RegenerateCredential (updated)
Description :  Regenerates one of the login credentials for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Registries_RegenerateCredential",
  "$responses": {
    "@added_14ab28a1523546febb81e56ee42f8f91": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential
{
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 ,
regenerateCredentialParameters:
{
Description: Specifies name of the password which should be regenerated -- password or password2. ,
Required: True ,
}
{
name:
{
Description: Specifies name of the password which should be regenerated -- password or password2. ,
Enum:
{
password: No description available. ,
password2: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
username:
{
Description: The username for a container registry. ,
Required: False ,
}
string ,
passwords:
{
Description: The list of passwords for a container registry. ,
Required: False ,
}
[
{
name:
{
Description: The password name. ,
Enum:
{
password: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
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 ,
}
,
]
,
}
,
}
Replications_List (updated)
Description :  Lists all the replications for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replications_List",
  "$responses": {
    "@added_367f60a2b9424a3caf5a11daffe84d94": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of replications. Since this list may be incomplete, the nextLink field should be used to request the next list of replications. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of replications. ,
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 ,
}
,
]
,
}
,
}
Replications_Get (updated)
Description :  Gets the properties of the specified replication.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replications_Get",
  "$responses": {
    "@added_bb8b309777c649a49f8178b0ba3376e0": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
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 ,
replicationName:
{
Description: The name of the replication. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Replications_Create (updated)
Description :  Creates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replications_Create",
  "$responses": {
    "201": [
      {
        "@added_7821b6ebbd454b1a961c4c29a01917ab": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_8b4cd8366851466aa77ad1384c88adfb": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
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 ,
replicationName:
{
Description: The name of the replication. ,
Required: True ,
}
string ,
replication:
{
Description: The parameters for creating a replication. ,
Required: True ,
}
{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a replication for a container registry. ,
}
{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Replications_Update (updated)
Description :  Updates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replications_Update",
  "$responses": {
    "201": [
      {
        "@added_b25deed0c1a54ae099dc67b4b0e0765d": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_57a0ecbfe1e34d89a1e75bead36209c1": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
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 ,
replicationName:
{
Description: The name of the replication. ,
Required: True ,
}
string ,
replicationUpdateParameters:
{
Description: The parameters for updating a replication. ,
Required: True ,
}
{
tags:
{
Description: The tags for the replication. ,
Required: False ,
}
object ,
properties:
{
Description: The parameters for updating a replication's properties ,
Required: False ,
}
{
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a replication for a container registry. ,
}
{
properties:
{
Description: The properties of the replication. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the replication at the time the operation was called. ,
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 ,
status:
{
Description: The status of the replication at the time the operation was called. ,
Required: False ,
}
{
displayStatus:
{
Description: The short label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message for the status, including alerts and error messages. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the status was changed to the current value. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
regionEndpointEnabled:
{
Description: Specifies whether the replication's regional endpoint is enabled. Requests will not be routed to a replication whose regional endpoint is disabled, however its data will continue to be synced with other replications. ,
Required: False ,
}
boolean ,
zoneRedundancy:
{
Description: Whether or not zone redundancy is enabled for this container registry replication ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Replications_Delete (updated)
Description :  Deletes a replication from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Replications_Delete",
  "$responses": {
    "202": [
      {
        "@added_162f0cb1e2bf47cf9056a9b7ff38e9c7": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_3de5ccfb65cd48289672f9803b588fb0": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
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 ,
replicationName:
{
Description: The name of the replication. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ScopeMaps_List (updated)
Description :  Lists all the scope maps for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScopeMaps_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "actions",
                "Description": {
                  "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
                  "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of scope maps. Since this list may be incomplete, the nextLink field should be used to request the next list of scope maps. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of scope maps. ,
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 ,
}
,
]
,
}
,
}
ScopeMaps_Get (updated)
Description :  Gets the properties of the specified scope map.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScopeMaps_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "actions",
            "Description": {
              "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
              "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
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 ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
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 ,
}
,
]
,
}
,
}
ScopeMaps_Create (updated)
Description :  Creates a scope map for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScopeMaps_Create",
  "$parameters": {
    "scopeMapCreateParameters": {
      "$properties": {
        "properties": [
          {
            "#name": "actions",
            "Description": {
              "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
              "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "actions",
              "Description": {
                "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
                "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_569732dad8f94ee58b17c08f66e76a8a": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "actions",
              "Description": {
                "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
                "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
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 ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapCreateParameters:
{
Description: The parameters for creating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a scope map for a container registry. ,
}
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
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 ,
}
,
]
,
}
,
}
ScopeMaps_Update (updated)
Description :  Updates a scope map with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScopeMaps_Update",
  "$parameters": {
    "scopeMapUpdateParameters": {
      "$properties": {
        "properties": [
          {
            "#name": "actions",
            "Description": {
              "new": "The list of scope permissions for registry artifacts.\nE.g. repositories/repository-name/pull,\nrepositories/repository-name/delete",
              "old": "The list of scope permissions for registry artifacts.\r\nE.g. repositories/repository-name/pull, \r\nrepositories/repository-name/delete"
            }
          }
        ]
      }
    }
  },
  "$responses": [
    {
      "200": {
        "$properties": {
          "properties": [
            {
              "#name": "actions",
              "Description": {
                "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
                "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": {
        "@added_e1db59ebaafd4ff8ad1d7fd2ddf14b0a": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "actions",
              "Description": {
                "new": "The list of scoped permissions for registry artifacts.\nE.g. repositories/repository-name/content/read,\nrepositories/repository-name/metadata/write",
                "old": "The list of scoped permissions for registry artifacts.\r\nE.g. repositories/repository-name/content/read,\r\nrepositories/repository-name/metadata/write"
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
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 ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
scopeMapUpdateParameters:
{
Description: The parameters for updating a scope map. ,
Required: True ,
}
{
properties:
{
Description: The update parameters for scope map properties. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
actions:
{
Description: The list of scope permissions for registry artifacts. E.g. repositories/repository-name/pull, repositories/repository-name/delete ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a scope map for a container registry. ,
}
{
properties:
{
Description: The properties of the scope map. ,
Required: False ,
}
{
description:
{
Description: The user friendly description of the scope map. ,
Required: False ,
}
string ,
type:
{
Description: The type of the scope map. E.g. BuildIn scope map. ,
Required: False ,
}
string ,
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
actions:
{
Description: The list of scoped permissions for registry artifacts. E.g. repositories/repository-name/content/read, repositories/repository-name/metadata/write ,
Required: True ,
}
[
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 ,
}
,
]
,
}
,
}
ScopeMaps_Delete (updated)
Description :  Deletes a scope map from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ScopeMaps_Delete",
  "$responses": {
    "202": [
      {
        "@added_303e336e5df8486e88a09bea167c11e1": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
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 ,
scopeMapName:
{
Description: The name of the scope map. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Tokens_Create (updated)
Description :  Creates a token for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tokens_Create",
  "$responses": {
    "201": [
      {
        "@added_c52405f6f7fd4399abf26f3622f903f0": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
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 ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenCreateParameters:
{
Description: The parameters for creating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a token for a container registry. ,
}
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Tokens_Update (updated)
Description :  Updates a token with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tokens_Update",
  "$responses": {
    "201": [
      {
        "@added_114a31a776534de0a0e747b16f541d20": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
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 ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
tokenUpdateParameters:
{
Description: The parameters for updating a token. ,
Required: True ,
}
{
properties:
{
Description: The properties of the token update parameters. ,
Required: False ,
}
{
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a token for a container registry. ,
}
{
properties:
{
Description: The properties of the token. ,
Required: False ,
}
{
creationDate:
{
Description: The creation date of scope map. ,
Format: date-time ,
Required: False ,
}
string ,
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 ,
scopeMapId:
{
Description: The resource ID of the scope map to which the token will be associated with. ,
Required: False ,
}
string ,
credentials:
{
Description: The credentials that can be used for authenticating the token. ,
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
{
name:
{
Enum:
{
certificate1: No description available. ,
certificate2: No description available. ,
}
,
Required: False ,
}
enum ,
expiry:
{
Description: The expiry datetime of the certificate. ,
Format: date-time ,
Required: False ,
}
string ,
thumbprint:
{
Description: The thumbprint of the certificate. ,
Required: False ,
}
string ,
encodedPemCertificate:
{
Description: Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. ,
Required: False ,
}
string ,
}
,
]
,
passwords:
{
Required: False ,
}
[
{
creationTime:
{
Description: The creation datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
expiry:
{
Description: The expiry datetime of the password. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: The password name "password1" or "password2" ,
Enum:
{
password1: No description available. ,
password2: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
status:
{
Description: The status of the token example enabled or disabled. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Tokens_Delete (updated)
Description :  Deletes a token from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Tokens_Delete",
  "$responses": {
    "202": [
      {
        "@added_91e0e76f22184c9998e5dfe9567205c5": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
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 ,
tokenName:
{
Description: The name of the token. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_List (updated)
Description :  Lists all the webhooks for the specified container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_List",
  "$responses": {
    "@added_a75d67839d4c4f4c85f36647540dc9e3": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of webhooks. Since this list may be incomplete, the nextLink field should be used to request the next list of webhooks. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of webhooks. ,
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 ,
}
,
]
,
}
,
}
Webhooks_Get (updated)
Description :  Gets the properties of the specified webhook.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_Get",
  "$responses": {
    "@added_086114f1b3004c2b84961ca5867ced2c": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_Create (updated)
Description :  Creates a webhook for a container registry with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_Create",
  "$responses": {
    "201": [
      {
        "@added_486f696cb3b340bfac82f9aa4cda6d1c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_deac8bbd2b98466d902d77536d53ec90": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
webhookCreateParameters:
{
Description: The parameters for creating a webhook. ,
Required: True ,
}
{
tags:
{
Description: The tags for the webhook. ,
Required: False ,
}
object ,
location:
{
Description: The location of the webhook. This cannot be changed after the resource is created. ,
Required: True ,
}
string ,
properties:
{
Description: The properties that the webhook will be created with. ,
Required: False ,
}
{
serviceUri:
{
Description: The service URI for the webhook to post notifications. ,
Format: password ,
Required: True ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
Format: password ,
Required: False ,
}
object ,
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a webhook for a container registry. ,
}
{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_Update (updated)
Description :  Updates a webhook with the specified parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_Update",
  "$responses": {
    "201": [
      {
        "@added_fd68bb6f06eb4de8bb41a27bd973e2d3": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_5aa02567b9c8472086b99caa9bdc1459": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
webhookUpdateParameters:
{
Description: The parameters for updating a webhook. ,
Required: True ,
}
{
tags:
{
Description: The tags for the webhook. ,
Required: False ,
}
object ,
properties:
{
Description: The properties that the webhook will be updated with. ,
Required: False ,
}
{
serviceUri:
{
Description: The service URI for the webhook to post notifications. ,
Format: password ,
Required: False ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
Format: password ,
Required: False ,
}
object ,
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An object that represents a webhook for a container registry. ,
}
{
properties:
{
Description: The properties of the webhook. ,
Required: False ,
}
{
status:
{
Description: The status of the webhook at the time the operation was called. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scope:
{
Description: The scope of repositories where the event can be triggered. For example, 'foo:*' means events for all tags under repository 'foo'. 'foo:bar' means events for 'foo:bar' only. 'foo' is equivalent to 'foo:latest'. Empty means all events. ,
Required: False ,
}
string ,
actions:
{
Description: The list of actions that trigger the webhook to post notifications. ,
Required: True ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the webhook at the time the operation was called. ,
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_Delete (updated)
Description :  Deletes a webhook from a container registry.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_Delete",
  "$responses": {
    "202": [
      {
        "@added_bd54fcb56ceb4ae7b58beb2a4233c7ee": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "@added_eaf9296ef6924f17a8b76d8c1e559d92": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_GetCallbackConfig (updated)
Description :  Gets the configuration of service URI and custom headers for the webhook.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_GetCallbackConfig",
  "$responses": {
    "@added_4babe449588442e0946a69d2eb818d26": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceUri:
{
Description: The service URI for the webhook to post notifications. ,
Required: True ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Webhooks_ListEvents (updated)
Description :  Lists recent events for the specified webhook.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_ListEvents",
  "$responses": {
    "@added_6908fd2e2448465fb498a2f47b968d67": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of events. Since this list may be incomplete, the nextLink field should be used to request the next list of events. ,
Required: False ,
}
[
{
eventRequestMessage:
{
Description: The event request message sent to the service URI. ,
Required: False ,
}
{
content:
{
Description: The content of the event request message. ,
Required: False ,
}
{
id:
{
Description: The event ID. ,
Required: False ,
}
string ,
timestamp:
{
Description: The time at which the event occurred. ,
Format: date-time ,
Required: False ,
}
string ,
action:
{
Description: The action that encompasses the provided event. ,
Required: False ,
}
string ,
target:
{
Description: The target of the event. ,
Required: False ,
}
{
mediaType:
{
Description: The MIME type of the referenced object. ,
Required: False ,
}
string ,
size:
{
Description: The number of bytes of the content. Same as Length field. ,
Format: int64 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest of the content, as defined by the Registry V2 HTTP API Specification. ,
Required: False ,
}
string ,
length:
{
Description: The number of bytes of the content. Same as Size field. ,
Format: int64 ,
Required: False ,
}
integer ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
url:
{
Description: The direct URL to the content. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
name:
{
Description: The name of the artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the artifact. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The request that generated the event. ,
Required: False ,
}
{
id:
{
Description: The ID of the request that initiated the event. ,
Required: False ,
}
string ,
addr:
{
Description: The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. ,
Required: False ,
}
string ,
host:
{
Description: The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. ,
Required: False ,
}
string ,
method:
{
Description: The request method that generated the event. ,
Required: False ,
}
string ,
useragent:
{
Description: The user agent header of the request. ,
Required: False ,
}
string ,
}
,
actor:
{
Description: The agent that initiated the event. For most situations, this could be from the authorization context of the request. ,
Required: False ,
}
{
name:
{
Description: The subject or username associated with the request context that generated the event. ,
Required: False ,
}
string ,
}
,
source:
{
Description: The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. ,
Required: False ,
}
{
addr:
{
Description: The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. ,
Required: False ,
}
string ,
instanceID:
{
Description: The running instance of an application. Changes after each restart. ,
Required: False ,
}
string ,
}
,
}
,
headers:
{
Description: The headers of the event request message. ,
Required: False ,
}
object ,
method:
{
Description: The HTTP method used to send the event request message. ,
Required: False ,
}
string ,
requestUri:
{
Description: The URI used to send the event request message. ,
Required: False ,
}
string ,
version:
{
Description: The HTTP message version. ,
Required: False ,
}
string ,
}
,
eventResponseMessage:
{
Description: The event response message received from the service URI. ,
Required: False ,
}
{
content:
{
Description: The content of the event response message. ,
Required: False ,
}
string ,
headers:
{
Description: The headers of the event response message. ,
Required: False ,
}
object ,
reasonPhrase:
{
Description: The reason phrase of the event response message. ,
Required: False ,
}
string ,
statusCode:
{
Description: The status code of the event response message. ,
Required: False ,
}
string ,
version:
{
Description: The HTTP message version. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of events. ,
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 ,
}
,
]
,
}
,
}
Webhooks_Ping (updated)
Description :  Triggers a ping event to be sent to the webhook.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Webhooks_Ping",
  "$responses": {
    "@added_e6933c93112e48308b0b46f527d0709d": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping
{
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 ,
webhookName:
{
Description: The name of the webhook. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The event ID. ,
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 ,
}
,
]
,
}
,
}