Microsoft.ContainerRegistry (preview:2021-12-01)

2025/09/04 • 60 new, 60 deleted methods

ConnectedRegistries_List (new)
Description :  Lists all connected registries for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Get (new)
Description :  Gets the properties of the connected registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Create (new)
Description :  Creates a connected registry for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
connectedRegistryCreateParameters:
{
Description: The parameters for creating a connectedRegistry. ,
Required: True ,
}
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Delete (new)
Description :  Deletes a connected registry from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Update (new)
Description :  Updates a connected registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
]
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Deactivate (new)
Description :  Deactivates the connected registry instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_List (new)
Description :  Lists all export pipelines for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of export pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of export pipelines. ,
Required: False ,
}
[
{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Get (new)
Description :  Gets the properties of the export pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Create (new)
Description :  Creates an export pipeline for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
exportPipelineCreateParameters:
{
Description: The parameters for creating an export pipeline. ,
Required: True ,
}
{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 (200)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Delete (new)
Description :  Deletes an export pipeline from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ImportImage (new)
Description :  Copies an image to this container registry from the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}
ImportPipelines_List (new)
Description :  Lists all import pipelines for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of import pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of import pipelines. ,
Required: False ,
}
[
{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Get (new)
Description :  Gets the properties of the import pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Create (new)
Description :  Creates an import pipeline for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
importPipelineCreateParameters:
{
Description: The parameters for creating an import pipeline. ,
Required: True ,
}
{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 (200)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Delete (new)
Description :  Deletes an import pipeline from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Azure Container Registry REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerRegistry/operations
{
api-version:
{
Description: The client API version. ,
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 ,
}
Registries_CheckNameAvailability (new)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
registryNameCheckRequest:
{
Description: The object containing information for the availability request. ,
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 ,
}
,
}

⚐ Response (200)

{
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 ,
}
PipelineRuns_List (new)
Description :  Lists all the pipeline runs for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of pipeline runs. Since this list may be incomplete, the nextLink field should be used to request the next list of pipeline runs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Get (new)
Description :  Gets the detailed information for a given pipeline run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Create (new)
Description :  Creates a pipeline run for a container registry with the specified parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
pipelineRunCreateParameters:
{
Description: The parameters for creating a pipeline run. ,
Required: True ,
}
{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Delete (new)
Description :  Deletes a pipeline run from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List all private endpoint connections in a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
PrivateEndpointConnections_Get (new)
Description :  Get the specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (new)
Description :  Update the state of specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Registries_List (new)
Description :  Lists all the container registries under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
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 ,
}
[
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container registries. ,
Required: False ,
}
string ,
}
Registries_ListByResourceGroup (new)
Description :  Lists all the container registries under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
[
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container registries. ,
Required: False ,
}
string ,
}
Registries_Get (new)
Description :  Gets the properties of the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_Create (new)
Description :  Creates a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_Delete (new)
Description :  Deletes a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Registries_Update (new)
Description :  Updates a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_ListUsages (new)
Description :  Gets the quota usages for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Registries_ListPrivateLinkResources (new)
Description :  Lists the private link resources for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
[
{
type:
{
Description: The resource type is private link resource. ,
Required: False ,
}
string ,
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: A resource that supports private link capabilities. ,
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 ,
}
Registries_GetPrivateLinkResource (new)
Description :  Gets a private link resource by a specified group name for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: The resource type is private link resource. ,
Required: False ,
}
string ,
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: A resource that supports private link capabilities. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ListCredentials (new)
Description :  Lists the login credentials for the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Registries_RegenerateCredential (new)
Description :  Regenerates one of the login credentials for the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Replications_List (new)
Description :  Lists all the replications for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Replications_Get (new)
Description :  Gets the properties of the specified replication.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
Replications_Create (new)
Description :  Creates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Replications_Update (new)
Description :  Updates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Get (new)
Description :  Gets the properties of the specified scope map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Create (new)
Description :  Creates a scope map for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Delete (new)
Description :  Deletes a scope map from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Update (new)
Description :  Updates a scope map with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_List (new)
Description :  Lists all the tokens for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens. ,
Required: False ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of tokens. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Get (new)
Description :  Gets the properties of the specified token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Create (new)
Description :  Creates a token for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Delete (new)
Description :  Deletes a token from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Update (new)
Description :  Updates a token with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_GenerateCredentials (new)
Description :  Generate keys for a token of a specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Webhooks_List (new)
Description :  Lists all the webhooks for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_Get (new)
Description :  Gets the properties of the specified webhook.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
Webhooks_Create (new)
Description :  Creates a webhook for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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. ,
Required: True ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Webhooks_Update (new)
Description :  Updates a webhook with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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. ,
Required: False ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
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)

{
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 ,
}
,
}
Webhooks_Ping (new)
Description :  Triggers a ping event to be sent to the webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_ListEvents (new)
Description :  Lists recent events for the specified webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_GetCallbackConfig (new)
Description :  Gets the configuration of service URI and custom headers for the webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
ConnectedRegistries_List (removed)
Description :  Lists all connected registries for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData filter expression that describes a subset of connectedRegistries to return. The parameters that can be filtered are parent.id (the resource id of the connectedRegistry parent), mode, and connectionState. The supported operator is eq. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Get (removed)
Description :  Gets the properties of the connected registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Create (removed)
Description :  Creates a connected registry for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
connectedRegistryName:
{
Description: The name of the connected registry. ,
Required: True ,
}
string ,
connectedRegistryCreateParameters:
{
Description: The parameters for creating a connectedRegistry. ,
Required: True ,
}
{
properties:
{
Description: The properties of the connected registry. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode of the connected registry resource that indicates the permissions of the registry. ,
Enum:
{
ReadWrite: No description available. ,
ReadOnly: No description available. ,
Registry: No description available. ,
Mirror: No description available. ,
}
,
Required: True ,
}
enum ,
version:
{
Description: The current version of ACR runtime on the connected registry. ,
Required: False ,
}
string ,
connectionState:
{
Description: The current connection state of the connected registry. ,
Enum:
{
Online: No description available. ,
Offline: No description available. ,
Syncing: No description available. ,
Unhealthy: No description available. ,
}
,
Required: False ,
}
enum ,
lastActivityTime:
{
Description: The last activity time of the connected registry. ,
Format: date-time ,
Required: False ,
}
string ,
activation:
{
Description: The activation properties of the connected registry. ,
Required: False ,
}
{
status:
{
Description: The activation status of the connected registry. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
parent:
{
Description: The parent of the connected registry. ,
Required: True ,
}
{
id:
{
Description: The resource ID of the parent to which the connected registry will be associated. ,
Required: False ,
}
string ,
syncProperties:
{
Description: The sync properties of the connected registry with its parent. ,
Required: True ,
}
{
tokenId:
{
Description: The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. ,
Required: True ,
}
string ,
schedule:
{
Description: The cron expression indicating the schedule that the connected registry will sync with its parent. ,
Required: False ,
}
string ,
syncWindow:
{
Description: The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. ,
Format: duration ,
Required: False ,
}
string ,
messageTtl:
{
Description: The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. ,
Format: duration ,
Required: True ,
}
string ,
lastSyncTime:
{
Description: The last time a sync occurred between the connected registry and its parent. ,
Format: date-time ,
Required: False ,
}
string ,
gatewayEndpoint:
{
Description: The gateway endpoint used by the connected registry to communicate with its parent. ,
Required: False ,
}
string ,
}
,
}
,
clientTokenIds:
{
Description: The list of the ACR token resource IDs used to authenticate clients to the connected registry. ,
Required: False ,
}
[
string ,
]
,
loginServer:
{
Description: The login server properties of the connected registry. ,
Required: False ,
}
{
host:
{
Description: The host of the connected registry. Can be FQDN or IP. ,
Required: False ,
}
string ,
tls:
{
Description: The TLS properties of the connected registry login server. ,
Required: False ,
}
{
status:
{
Description: Indicates whether HTTPS is enabled for the login server. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
certificate:
{
Description: The certificate used to configure HTTPS for the login server. ,
Required: False ,
}
{
type:
{
Description: The type of certificate location. ,
Enum:
{
LocalDirectory: No description available. ,
}
,
Required: False ,
}
enum ,
location:
{
Description: Indicates the location of the certificates. ,
Required: False ,
}
string ,
}
,
}
,
}
,
logging:
{
Description: The logging properties of the connected registry. ,
Required: False ,
}
{
logLevel:
{
Description: The verbosity of logs persisted on the connected registry. ,
Enum:
{
Debug: No description available. ,
Information: No description available. ,
Warning: No description available. ,
Error: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
auditLogStatus:
{
Description: Indicates whether audit logs are enabled on the connected registry. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
statusDetails:
{
Description: The list of current statuses of the connected registry. ,
Required: False ,
}
[
{
type:
{
Description: The component of the connected registry corresponding to the status. ,
Required: False ,
}
string ,
code:
{
Description: The code of the status. ,
Required: False ,
}
string ,
description:
{
Description: The description of the status. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the status. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: The correlation ID of the status. ,
Required: False ,
}
string ,
}
,
]
,
notificationsList:
{
Description: The list of notifications subscription information for the connected registry. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Delete (removed)
Description :  Deletes a connected registry from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Update (removed)
Description :  Updates a connected registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
]
,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ConnectedRegistries_Deactivate (removed)
Description :  Deactivates the connected registry instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/connectedRegistries/{connectedRegistryName}/deactivate
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_List (removed)
Description :  Lists all export pipelines for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of export pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of export pipelines. ,
Required: False ,
}
[
{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Get (removed)
Description :  Gets the properties of the export pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Create (removed)
Description :  Creates an export pipeline for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
exportPipelineCreateParameters:
{
Description: The parameters for creating an export pipeline. ,
Required: True ,
}
{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 (200)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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)

{
location:
{
Description: The location of the export pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the export pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the export pipeline. ,
Required: False ,
}
{
target:
{
Description: The target properties of the export pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ExportPipelines_Delete (removed)
Description :  Deletes an export pipeline from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/exportPipelines/{exportPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
exportPipelineName:
{
Description: The name of the export pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ImportImage (removed)
Description :  Copies an image to this container registry from the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}
ImportPipelines_List (removed)
Description :  Lists all import pipelines for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of import pipelines. Since this list may be incomplete, the nextLink field should be used to request the next list of import pipelines. ,
Required: False ,
}
[
{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Get (removed)
Description :  Gets the properties of the import pipeline.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Create (removed)
Description :  Creates an import pipeline for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
importPipelineCreateParameters:
{
Description: The parameters for creating an import pipeline. ,
Required: True ,
}
{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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 (200)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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)

{
location:
{
Description: The location of the import pipeline. ,
Required: False ,
}
string ,
identity:
{
Description: The identity of the import pipeline. ,
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 ,
}
,
properties:
{
Description: The properties of the import pipeline. ,
Required: False ,
}
{
source:
{
Description: The source properties of the import pipeline. ,
Required: True ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
trigger:
{
Description: The properties that describe the trigger of the import pipeline. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger properties of the pipeline. ,
Required: False ,
}
{
status:
{
Description: The current status of the source trigger. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
options:
{
Description: The list of all options configured for the pipeline. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the pipeline 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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ImportPipelines_Delete (removed)
Description :  Deletes an import pipeline from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importPipelines/{importPipelineName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
importPipelineName:
{
Description: The name of the import pipeline. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Azure Container Registry REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ContainerRegistry/operations
{
api-version:
{
Description: The client API version. ,
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 ,
}
Registries_CheckNameAvailability (removed)
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 ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/checkNameAvailability
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
registryNameCheckRequest:
{
Description: The object containing information for the availability request. ,
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 ,
}
,
}

⚐ Response (200)

{
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 ,
}
PipelineRuns_List (removed)
Description :  Lists all the pipeline runs for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of pipeline runs. Since this list may be incomplete, the nextLink field should be used to request the next list of pipeline runs. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of pipeline runs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Get (removed)
Description :  Gets the detailed information for a given pipeline run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Create (removed)
Description :  Creates a pipeline run for a container registry with the specified parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
pipelineRunCreateParameters:
{
Description: The parameters for creating a pipeline run. ,
Required: True ,
}
{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a pipeline run. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of a pipeline run. ,
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 ,
request:
{
Description: The request parameters for a pipeline run. ,
Required: False ,
}
{
pipelineResourceId:
{
Description: The resource ID of the pipeline to run. ,
Required: False ,
}
string ,
artifacts:
{
Description: List of source artifacts to be transferred by the pipeline. 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: False ,
}
[
string ,
]
,
source:
{
Description: The source properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the source. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the source. ,
Required: False ,
}
string ,
}
,
target:
{
Description: The target properties of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of the target. ,
Enum:
{
AzureStorageBlob: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the target. ,
Required: False ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response of a pipeline run. ,
Required: False ,
}
{
status:
{
Description: The current status of the pipeline run. ,
Required: False ,
}
string ,
importedArtifacts:
{
Description: The artifacts imported in the pipeline run. ,
Required: False ,
}
[
string ,
]
,
progress:
{
Description: The current progress of the copy operation. ,
Required: False ,
}
{
percentage:
{
Description: The percentage complete of the copy operation. ,
Required: False ,
}
string ,
}
,
startTime:
{
Description: The time the pipeline run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the pipeline run finished. ,
Format: date-time ,
Required: False ,
}
string ,
source:
{
Description: The source of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of source for the import pipeline. ,
Enum:
{
AzureStorageBlobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
uri:
{
Description: The source uri of the import pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the source storage SAS token. ,
Required: True ,
}
string ,
}
,
target:
{
Description: The target of the pipeline run. ,
Required: False ,
}
{
type:
{
Description: The type of target for the export pipeline. ,
Required: False ,
}
string ,
uri:
{
Description: The target uri of the export pipeline. When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: They key vault secret uri to obtain the target storage SAS token. ,
Required: True ,
}
string ,
}
,
catalogDigest:
{
Description: The digest of the tar used to transfer the artifacts. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger that caused the pipeline run. ,
Required: False ,
}
{
sourceTrigger:
{
Description: The source trigger that caused the pipeline run. ,
Required: False ,
}
{
timestamp:
{
Description: The timestamp when the source update happened. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
pipelineRunErrorMessage:
{
Description: The detailed error message for the pipeline run in the case of failure. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the pipeline run should be forced to recreate even if the pipeline run configuration has not changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PipelineRuns_Delete (removed)
Description :  Deletes a pipeline run from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/pipelineRuns/{pipelineRunName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
pipelineRunName:
{
Description: The name of the pipeline run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  List all private endpoint connections in a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
PrivateEndpointConnections_Get (removed)
Description :  Get the specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Update the state of specified private endpoint connection associated with the container registry.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Registries_List (removed)
Description :  Lists all the container registries under the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerRegistry/registries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
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 ,
}
[
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container registries. ,
Required: False ,
}
string ,
}
Registries_ListByResourceGroup (removed)
Description :  Lists all the container registries under the specified resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
[
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of container registries. ,
Required: False ,
}
string ,
}
Registries_Get (removed)
Description :  Gets the properties of the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_Create (removed)
Description :  Creates a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_Delete (removed)
Description :  Deletes a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Registries_Update (removed)
Description :  Updates a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
anonymousPullEnabled:
{
Description: Enables registry-wide pull from unauthenticated clients. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}

⚐ Response (201)

{
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 ,
}
,
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 ,
virtualNetworkRules:
{
Description: The virtual network rules. ,
Required: False ,
}
[
{
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
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 ,
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 ,
}
,
}
Registries_ListUsages (removed)
Description :  Gets the quota usages for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Registries_ListPrivateLinkResources (removed)
Description :  Lists the private link resources for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
[
{
type:
{
Description: The resource type is private link resource. ,
Required: False ,
}
string ,
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: A resource that supports private link capabilities. ,
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 ,
}
Registries_GetPrivateLinkResource (removed)
Description :  Gets a private link resource by a specified group name for a container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/privateLinkResources/{groupName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
groupName:
{
Description: The name of the private link resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: The resource type is private link resource. ,
Required: False ,
}
string ,
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: A resource that supports private link capabilities. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ListCredentials (removed)
Description :  Lists the login credentials for the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Registries_RegenerateCredential (removed)
Description :  Regenerates one of the login credentials for the specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
]
,
}
Replications_List (removed)
Description :  Lists all the replications for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Replications_Get (removed)
Description :  Gets the properties of the specified replication.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
Replications_Create (removed)
Description :  Creates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Replications_Update (removed)
Description :  Updates a replication for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/replications/{replicationName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Get (removed)
Description :  Gets the properties of the specified scope map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Create (removed)
Description :  Creates a scope map for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Delete (removed)
Description :  Deletes a scope map from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
ScopeMaps_Update (removed)
Description :  Updates a scope map with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scopeMaps/{scopeMapName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_List (removed)
Description :  Lists all the tokens for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of tokens. Since this list may be incomplete, the nextLink field should be used to request the next list of tokens. ,
Required: False ,
}
[
{
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 ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next list of tokens. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Get (removed)
Description :  Gets the properties of the specified token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Create (removed)
Description :  Creates a token for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Delete (removed)
Description :  Deletes a token from a container registry.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tokens_Update (removed)
Description :  Updates a token with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tokens/{tokenName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{
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: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_GenerateCredentials (removed)
Description :  Generate keys for a token of a specified container registry.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Webhooks_List (removed)
Description :  Lists all the webhooks for the specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_Get (removed)
Description :  Gets the properties of the specified webhook.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
,
}
Webhooks_Create (removed)
Description :  Creates a webhook for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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. ,
Required: True ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
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)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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)

{}

⚐ Response (204)

{}
Webhooks_Update (removed)
Description :  Updates a webhook with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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. ,
Required: False ,
}
string ,
customHeaders:
{
Description: Custom headers that will be added to the webhook notifications. ,
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)

{
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 ,
}
,
}
Webhooks_Ping (removed)
Description :  Triggers a ping event to be sent to the webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/ping
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_ListEvents (removed)
Description :  Lists recent events for the specified webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/listEvents
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}
Webhooks_GetCallbackConfig (removed)
Description :  Gets the configuration of service URI and custom headers for the webhook.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/webhooks/{webhookName}/getCallbackConfig
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
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 ,
}