Microsoft.ContainerRegistry registries/connectedRegistries 2020-11-01-preview
Bicep resource definition
The registries/connectedRegistries resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/connectedRegistries resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ContainerRegistry/registries/connectedRegistries@2020-11-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientTokenIds: [
'string'
]
logging: {
auditLogStatus: 'string'
logLevel: 'string'
}
loginServer: {}
mode: 'string'
parent: {
id: 'string'
syncProperties: {
messageTtl: 'string'
schedule: 'string'
syncWindow: 'string'
tokenId: 'string'
}
}
}
}
Property values
registries/connectedRegistries
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: registries |
| properties | The properties of the connected registry. | ConnectedRegistryProperties |
ConnectedRegistryProperties
| Name | Description | Value |
|---|---|---|
| clientTokenIds | The list of the ACR token resource IDs used to authenticate clients to the connected registry. | string[] |
| logging | The logging properties of the connected registry. | LoggingProperties |
| loginServer | The login server properties of the connected registry. | LoginServerProperties |
| mode | The mode of the connected registry resource that indicates the permissions of the registry. | 'Mirror' 'Registry' (required) |
| parent | The parent of the connected registry. | ParentProperties (required) |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| auditLogStatus | Indicates whether audit logs are enabled on the connected registry. | 'Disabled' 'Enabled' |
| logLevel | The verbosity of logs persisted on the connected registry. | 'Debug' 'Error' 'Information' 'None' 'Warning' |
LoginServerProperties
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ParentProperties
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the parent to which the connected registry will be associated. | string |
| syncProperties | The sync properties of the connected registry with its parent. | SyncProperties (required) |
SyncProperties
| Name | Description | Value |
|---|---|---|
| messageTtl | 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. | string (required) |
| schedule | The cron expression indicating the schedule that the connected registry will sync with its parent. | string |
| syncWindow | 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. | string |
| tokenId | The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. | string (required) |
ARM template resource definition
The registries/connectedRegistries resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/connectedRegistries resource, add the following JSON to your template.
{
"type": "Microsoft.ContainerRegistry/registries/connectedRegistries",
"apiVersion": "2020-11-01-preview",
"name": "string",
"properties": {
"clientTokenIds": [ "string" ],
"logging": {
"auditLogStatus": "string",
"logLevel": "string"
},
"loginServer": {},
"mode": "string",
"parent": {
"id": "string",
"syncProperties": {
"messageTtl": "string",
"schedule": "string",
"syncWindow": "string",
"tokenId": "string"
}
}
}
}
Property values
registries/connectedRegistries
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ContainerRegistry/registries/connectedRegistries' |
| apiVersion | The resource api version | '2020-11-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | The properties of the connected registry. | ConnectedRegistryProperties |
ConnectedRegistryProperties
| Name | Description | Value |
|---|---|---|
| clientTokenIds | The list of the ACR token resource IDs used to authenticate clients to the connected registry. | string[] |
| logging | The logging properties of the connected registry. | LoggingProperties |
| loginServer | The login server properties of the connected registry. | LoginServerProperties |
| mode | The mode of the connected registry resource that indicates the permissions of the registry. | 'Mirror' 'Registry' (required) |
| parent | The parent of the connected registry. | ParentProperties (required) |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| auditLogStatus | Indicates whether audit logs are enabled on the connected registry. | 'Disabled' 'Enabled' |
| logLevel | The verbosity of logs persisted on the connected registry. | 'Debug' 'Error' 'Information' 'None' 'Warning' |
LoginServerProperties
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ParentProperties
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the parent to which the connected registry will be associated. | string |
| syncProperties | The sync properties of the connected registry with its parent. | SyncProperties (required) |
SyncProperties
| Name | Description | Value |
|---|---|---|
| messageTtl | 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. | string (required) |
| schedule | The cron expression indicating the schedule that the connected registry will sync with its parent. | string |
| syncWindow | 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. | string |
| tokenId | The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. | string (required) |
Terraform (AzAPI provider) resource definition
The registries/connectedRegistries resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ContainerRegistry/registries/connectedRegistries resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/connectedRegistries@2020-11-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
clientTokenIds = [
"string"
]
logging = {
auditLogStatus = "string"
logLevel = "string"
}
loginServer = {}
mode = "string"
parent = {
id = "string"
syncProperties = {
messageTtl = "string"
schedule = "string"
syncWindow = "string"
tokenId = "string"
}
}
}
})
}
Property values
registries/connectedRegistries
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ContainerRegistry/registries/connectedRegistries@2020-11-01-preview" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: registries |
| properties | The properties of the connected registry. | ConnectedRegistryProperties |
ConnectedRegistryProperties
| Name | Description | Value |
|---|---|---|
| clientTokenIds | The list of the ACR token resource IDs used to authenticate clients to the connected registry. | string[] |
| logging | The logging properties of the connected registry. | LoggingProperties |
| loginServer | The login server properties of the connected registry. | LoginServerProperties |
| mode | The mode of the connected registry resource that indicates the permissions of the registry. | "Mirror" "Registry" (required) |
| parent | The parent of the connected registry. | ParentProperties (required) |
LoggingProperties
| Name | Description | Value |
|---|---|---|
| auditLogStatus | Indicates whether audit logs are enabled on the connected registry. | "Disabled" "Enabled" |
| logLevel | The verbosity of logs persisted on the connected registry. | "Debug" "Error" "Information" "None" "Warning" |
LoginServerProperties
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ParentProperties
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the parent to which the connected registry will be associated. | string |
| syncProperties | The sync properties of the connected registry with its parent. | SyncProperties (required) |
SyncProperties
| Name | Description | Value |
|---|---|---|
| messageTtl | 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. | string (required) |
| schedule | The cron expression indicating the schedule that the connected registry will sync with its parent. | string |
| syncWindow | 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. | string |
| tokenId | The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. | string (required) |