Registries - Update
Updates a container registry with the specified parameters.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}?api-version=2023-01-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
registry
|
path | True |
string |
The name of the container registry. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Type | Description |
---|---|---|
identity |
The identity of the container registry. |
|
properties.adminUserEnabled |
boolean |
The value that indicates whether the admin user is enabled. |
properties.anonymousPullEnabled |
boolean |
Enables registry-wide pull from unauthenticated clients. |
properties.dataEndpointEnabled |
boolean |
Enable a single data endpoint per region for serving data. |
properties.encryption |
The encryption settings of container registry. |
|
properties.networkRuleBypassOptions |
Whether to allow trusted Azure services to access a network restricted registry. |
|
properties.networkRuleSet |
The network rule set for a container registry. |
|
properties.policies |
The policies for a container registry. |
|
properties.publicNetworkAccess |
Whether or not public network access is allowed for the container registry. |
|
sku |
The SKU of the container registry. |
|
tags |
object |
The tags for the container registry. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request was successful; the request was well-formed and received properly. |
|
201 Created |
The request was successful; the operation will complete asynchronously. Headers Azure-AsyncOperation: string |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
RegistryUpdate
Sample request
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry?api-version=2023-01-01-preview
{
"tags": {
"key": "value"
},
"sku": {
"name": "Standard"
},
"properties": {
"adminUserEnabled": true
}
}
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
"name": "myRegistry",
"type": "Microsoft.ContainerRegistry/registries",
"location": "westus",
"tags": {
"key": "value"
},
"sku": {
"name": "Standard",
"tier": "Standard"
},
"properties": {
"loginServer": "myRegistry.azurecr-test.io",
"creationDate": "2021-06-15T21:38:26.1537861Z",
"provisioningState": "Succeeded",
"adminUserEnabled": true,
"networkRuleSet": {
"defaultAction": "Allow",
"ipRules": []
},
"policies": {
"quarantinePolicy": {
"status": "disabled"
},
"trustPolicy": {
"type": "Notary",
"status": "disabled"
},
"retentionPolicy": {
"days": 7,
"lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
"status": "disabled"
},
"exportPolicy": {
"status": "enabled"
}
},
"encryption": {
"status": "disabled"
},
"status": null,
"dataEndpointEnabled": false,
"dataEndpointHostNames": [],
"privateEndpointConnections": [],
"publicNetworkAccess": "Enabled",
"networkRuleBypassOptions": "AzureServices",
"zoneRedundancy": "Disabled",
"anonymousPullEnabled": false
}
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/operationStatuses/registries-00000000-0000-0000-0000-000000000000?api-version=2023-01-01-preview
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry",
"name": "myRegistry",
"type": "Microsoft.ContainerRegistry/registries",
"location": "westus",
"tags": {
"key": "value"
},
"sku": {
"name": "Standard",
"tier": "Standard"
},
"properties": {
"loginServer": "myRegistry.azurecr-test.io",
"creationDate": "2021-06-15T21:38:26.1537861Z",
"provisioningState": "Updating",
"adminUserEnabled": true,
"networkRuleSet": {
"defaultAction": "Allow",
"ipRules": []
},
"policies": {
"quarantinePolicy": {
"status": "disabled"
},
"trustPolicy": {
"type": "Notary",
"status": "disabled"
},
"retentionPolicy": {
"days": 7,
"lastUpdatedTime": "2021-06-15T21:40:12.8506835+00:00",
"status": "disabled"
},
"exportPolicy": {
"status": "enabled"
}
},
"encryption": {
"status": "disabled"
},
"status": null,
"dataEndpointEnabled": false,
"dataEndpointHostNames": [],
"privateEndpointConnections": [],
"publicNetworkAccess": "Enabled",
"networkRuleBypassOptions": "AzureServices",
"zoneRedundancy": "Disabled",
"anonymousPullEnabled": false
}
}
Definitions
Name | Description |
---|---|
Action |
The action of IP ACL rule. |
Actions |
A message indicating if changes on the service provider require any updates on the consumer. |
Azure |
The policy for using ARM audience token for a container registry. |
Azure |
The value that indicates whether the policy is enabled or not. |
Connection |
The private link service connection status. |
created |
The type of identity that created the resource. |
Default |
The default action of allow or deny when no other rules match. |
Encryption |
|
Encryption |
Indicates whether or not the encryption is enabled for container registry. |
Export |
The export policy for a container registry. |
Export |
The value that indicates whether the policy is enabled or not. |
Identity |
Managed identity for the resource. |
IPRule |
IP rule with specific IP or IP range in CIDR format. |
Key |
|
last |
The type of identity that last modified the resource. |
Network |
Whether to allow trusted Azure services to access a network restricted registry. |
Network |
The network rule set for a container registry. |
Policies |
The policies for a container registry. |
Policy |
The value that indicates whether the policy is enabled or not. |
Private |
The Private Endpoint resource. |
Private |
An object that represents a private endpoint connection for a container registry. |
Private |
The state of a private link service connection. |
Provisioning |
Provisioning state of the resource. |
Public |
Whether or not public network access is allowed for the container registry. |
Quarantine |
The quarantine policy for a container registry. |
Registry |
An object that represents a container registry. |
Registry |
The parameters for updating a container registry. |
Resource |
The identity type. |
Retention |
The retention policy for a container registry. |
Sku |
The SKU of a container registry. |
Sku |
The SKU name of the container registry. Required for registry creation. |
Sku |
The SKU tier based on the SKU name. |
Soft |
The soft delete policy for a container registry |
Status |
The status of an Azure resource at the time the operation was called. |
System |
Metadata pertaining to creation and last modification of the resource. |
Trust |
The content trust policy for a container registry. |
Trust |
The type of trust policy. |
User |
|
Zone |
Whether or not zone redundancy is enabled for this container registry |
Action
The action of IP ACL rule.
Name | Type | Description |
---|---|---|
Allow |
string |
ActionsRequired
A message indicating if changes on the service provider require any updates on the consumer.
Name | Type | Description |
---|---|---|
None |
string |
|
Recreate |
string |
AzureADAuthenticationAsArmPolicy
The policy for using ARM audience token for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
status | enabled |
The value that indicates whether the policy is enabled or not. |
AzureADAuthenticationAsArmPolicyStatus
The value that indicates whether the policy is enabled or not.
Name | Type | Description |
---|---|---|
disabled |
string |
|
enabled |
string |
ConnectionStatus
The private link service connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DefaultAction
The default action of allow or deny when no other rules match.
Name | Type | Description |
---|---|---|
Allow |
string |
|
Deny |
string |
EncryptionProperty
Name | Type | Description |
---|---|---|
keyVaultProperties |
Key vault properties. |
|
status |
Indicates whether or not the encryption is enabled for container registry. |
EncryptionStatus
Indicates whether or not the encryption is enabled for container registry.
Name | Type | Description |
---|---|---|
disabled |
string |
|
enabled |
string |
ExportPolicy
The export policy for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
status | enabled |
The value that indicates whether the policy is enabled or not. |
ExportPolicyStatus
The value that indicates whether the policy is enabled or not.
Name | Type | Description |
---|---|---|
disabled |
string |
|
enabled |
string |
IdentityProperties
Managed identity for the resource.
Name | Type | Description |
---|---|---|
principalId |
string |
The principal ID of resource identity. |
tenantId |
string |
The tenant ID of resource. |
type |
The identity type. |
|
userAssignedIdentities |
<string,
User |
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}'. |
IPRule
IP rule with specific IP or IP range in CIDR format.
Name | Type | Default value | Description |
---|---|---|---|
action | Allow |
The action of IP ACL rule. |
|
value |
string |
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
KeyVaultProperties
Name | Type | Description |
---|---|---|
identity |
string |
The client id of the identity which will be used to access key vault. |
keyIdentifier |
string |
Key vault uri to access the encryption key. |
keyRotationEnabled |
boolean |
Auto key rotation status for a CMK enabled registry. |
lastKeyRotationTimestamp |
string |
Timestamp of the last successful key rotation. |
versionedKeyIdentifier |
string |
The fully qualified key identifier that includes the version of the key that is actually used for encryption. |
lastModifiedByType
The type of identity that last modified the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
NetworkRuleBypassOptions
Whether to allow trusted Azure services to access a network restricted registry.
Name | Type | Description |
---|---|---|
AzureServices |
string |
|
None |
string |
NetworkRuleSet
The network rule set for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
defaultAction | Allow |
The default action of allow or deny when no other rules match. |
|
ipRules |
IPRule[] |
The IP ACL rules. |
Policies
The policies for a container registry.
Name | Type | Description |
---|---|---|
azureADAuthenticationAsArmPolicy |
The policy for using ARM audience token for a container registry. |
|
exportPolicy |
The export policy for a container registry. |
|
quarantinePolicy |
The quarantine policy for a container registry. |
|
retentionPolicy |
The retention policy for a container registry. |
|
softDeletePolicy |
The soft delete policy for a container registry. |
|
trustPolicy |
The content trust policy for a container registry. |
PolicyStatus
The value that indicates whether the policy is enabled or not.
Name | Type | Description |
---|---|---|
disabled |
string |
|
enabled |
string |
PrivateEndpoint
The Private Endpoint resource.
Name | Type | Description |
---|---|---|
id |
string |
This is private endpoint resource created with Microsoft.Network resource provider. |
PrivateEndpointConnection
An object that represents a private endpoint connection for a container registry.
Name | Type | Description |
---|---|---|
id |
string |
The resource ID. |
name |
string |
The name of the resource. |
properties.privateEndpoint |
The resource of private endpoint. |
|
properties.privateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
|
properties.provisioningState |
The provisioning state of private endpoint connection resource. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
type |
string |
The type of the resource. |
PrivateLinkServiceConnectionState
The state of a private link service connection.
Name | Type | Description |
---|---|---|
actionsRequired |
A message indicating if changes on the service provider require any updates on the consumer. |
|
description |
string |
The description for connection status. For example if connection is rejected it can indicate reason for rejection. |
status |
The private link service connection status. |
ProvisioningState
Provisioning state of the resource.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PublicNetworkAccess
Whether or not public network access is allowed for the container registry.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
QuarantinePolicy
The quarantine policy for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
status | disabled |
The value that indicates whether the policy is enabled or not. |
Registry
An object that represents a container registry.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
The resource ID. |
|
identity |
The identity of the container registry. |
||
location |
string |
The location of the resource. This cannot be changed after the resource is created. |
|
name |
string |
The name of the resource. |
|
properties.adminUserEnabled |
boolean |
False |
The value that indicates whether the admin user is enabled. |
properties.anonymousPullEnabled |
boolean |
False |
Enables registry-wide pull from unauthenticated clients. |
properties.creationDate |
string |
The creation date of the container registry in ISO8601 format. |
|
properties.dataEndpointEnabled |
boolean |
Enable a single data endpoint per region for serving data. |
|
properties.dataEndpointHostNames |
string[] |
List of host names that will serve data when dataEndpointEnabled is true. |
|
properties.encryption |
The encryption settings of container registry. |
||
properties.loginServer |
string |
The URL that can be used to log into the container registry. |
|
properties.networkRuleBypassOptions | AzureServices |
Whether to allow trusted Azure services to access a network restricted registry. |
|
properties.networkRuleSet |
The network rule set for a container registry. |
||
properties.policies |
The policies for a container registry. |
||
properties.privateEndpointConnections |
List of private endpoint connections for a container registry. |
||
properties.provisioningState |
The provisioning state of the container registry at the time the operation was called. |
||
properties.publicNetworkAccess | Enabled |
Whether or not public network access is allowed for the container registry. |
|
properties.status |
The status of the container registry at the time the operation was called. |
||
properties.zoneRedundancy | Disabled |
Whether or not zone redundancy is enabled for this container registry |
|
sku |
The SKU of the container registry. |
||
systemData |
Metadata pertaining to creation and last modification of the resource. |
||
tags |
object |
The tags of the resource. |
|
type |
string |
The type of the resource. |
RegistryUpdateParameters
The parameters for updating a container registry.
Name | Type | Default value | Description |
---|---|---|---|
identity |
The identity of the container registry. |
||
properties.adminUserEnabled |
boolean |
The value that indicates whether the admin user is enabled. |
|
properties.anonymousPullEnabled |
boolean |
Enables registry-wide pull from unauthenticated clients. |
|
properties.dataEndpointEnabled |
boolean |
Enable a single data endpoint per region for serving data. |
|
properties.encryption |
The encryption settings of container registry. |
||
properties.networkRuleBypassOptions | AzureServices |
Whether to allow trusted Azure services to access a network restricted registry. |
|
properties.networkRuleSet |
The network rule set for a container registry. |
||
properties.policies |
The policies for a container registry. |
||
properties.publicNetworkAccess |
Whether or not public network access is allowed for the container registry. |
||
sku |
The SKU of the container registry. |
||
tags |
object |
The tags for the container registry. |
ResourceIdentityType
The identity type.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
RetentionPolicy
The retention policy for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
days |
integer |
7 |
The number of days to retain an untagged manifest after which it gets purged. |
lastUpdatedTime |
string |
The timestamp when the policy was last updated. |
|
status | disabled |
The value that indicates whether the policy is enabled or not. |
Sku
The SKU of a container registry.
Name | Type | Description |
---|---|---|
name |
The SKU name of the container registry. Required for registry creation. |
|
tier |
The SKU tier based on the SKU name. |
SkuName
The SKU name of the container registry. Required for registry creation.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Classic |
string |
|
Premium |
string |
|
Standard |
string |
SkuTier
The SKU tier based on the SKU name.
Name | Type | Description |
---|---|---|
Basic |
string |
|
Classic |
string |
|
Premium |
string |
|
Standard |
string |
SoftDeletePolicy
The soft delete policy for a container registry
Name | Type | Default value | Description |
---|---|---|---|
lastUpdatedTime |
string |
The timestamp when the policy was last updated. |
|
retentionDays |
integer |
7 |
The number of days after which a soft-deleted item is permanently deleted. |
status | disabled |
The value that indicates whether the policy is enabled or not. |
Status
The status of an Azure resource at the time the operation was called.
Name | Type | Description |
---|---|---|
displayStatus |
string |
The short label for the status. |
message |
string |
The detailed message for the status, including alerts and error messages. |
timestamp |
string |
The timestamp when the status was changed to the current value. |
SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource modification (UTC). |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
TrustPolicy
The content trust policy for a container registry.
Name | Type | Default value | Description |
---|---|---|---|
status | disabled |
The value that indicates whether the policy is enabled or not. |
|
type | Notary |
The type of trust policy. |
TrustPolicyType
The type of trust policy.
Name | Type | Description |
---|---|---|
Notary |
string |
UserIdentityProperties
Name | Type | Description |
---|---|---|
clientId |
string |
The client id of user assigned identity. |
principalId |
string |
The principal id of user assigned identity. |
ZoneRedundancy
Whether or not zone redundancy is enabled for this container registry
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |