Share via

Registry interface

Package:
@azure/arm-containerregistry

An object that represents a container registry.

Extends
TrackedResource

Properties

adminUserEnabled

The value that indicates whether the admin user is enabled.
anonymousPullEnabled

Enables registry-wide pull from unauthenticated clients.
autoGeneratedDomainNameLabelScope

Determines the domain name label reuse scope.
creationDate

The creation date of the container registry in ISO8601 format.
dataEndpointEnabled

Enable a single data endpoint per region for serving data.
dataEndpointHostNames

List of host names that will serve data when dataEndpointEnabled is true.
encryption

The encryption settings of container registry.
endpointProtocol

The connectivity protocol for the registry, such as IPv4 or dual stack (IPv4 and IPv6).
identity

The identity of the container registry.
loginServer

The URL that can be used to log into the container registry.
metadataSearch

Determines whether registry artifacts are indexed for metadata search.
networkRuleBypassAllowedForTasks

Whether or not Tasks allowed to bypass the network rules for this container registry.
networkRuleBypassOptions

Whether to allow trusted Azure services to access a network restricted registry.
networkRuleSet

The network rule set for a container registry.
policies

The policies for a container registry.
privateEndpointConnections

List of private endpoint connections for a container registry.
provisioningState

The provisioning state of the container registry at the time the operation was called.
publicNetworkAccess

Whether or not public network access is allowed for the container registry.
regionalEndpointHostNames

List of host names that will serve registry when RegionalEndpoints is enabled.
regionalEndpoints

Enable per-region endpoints for accessing registry.
roleAssignmentMode

Determines registry role assignment mode.
sku

The SKU of the container registry.
status

The status of the container registry at the time the operation was called.
zoneRedundancy

Whether or not zone redundancy is enabled for this container registry

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the private link resource.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

adminUserEnabled

The value that indicates whether the admin user is enabled.

adminUserEnabled?: boolean

Property Value

boolean

anonymousPullEnabled

Enables registry-wide pull from unauthenticated clients.

anonymousPullEnabled?: boolean

Property Value

boolean

autoGeneratedDomainNameLabelScope

Determines the domain name label reuse scope.

autoGeneratedDomainNameLabelScope?: string

Property Value

string

creationDate

The creation date of the container registry in ISO8601 format.

creationDate?: Date

Property Value

Date

dataEndpointEnabled

Enable a single data endpoint per region for serving data.

dataEndpointEnabled?: boolean

Property Value

boolean

dataEndpointHostNames

List of host names that will serve data when dataEndpointEnabled is true.

dataEndpointHostNames?: string[]

Property Value

string[]

encryption

The encryption settings of container registry.

encryption?: EncryptionProperty

Property Value

EncryptionProperty

endpointProtocol

The connectivity protocol for the registry, such as IPv4 or dual stack (IPv4 and IPv6).

endpointProtocol?: string

Property Value

string

identity

The identity of the container registry.

identity?: IdentityProperties

Property Value

IdentityProperties

loginServer

The URL that can be used to log into the container registry.

loginServer?: string

Property Value

string

metadataSearch

Determines whether registry artifacts are indexed for metadata search.

metadataSearch?: string

Property Value

string

networkRuleBypassAllowedForTasks

Whether or not Tasks allowed to bypass the network rules for this container registry.

networkRuleBypassAllowedForTasks?: boolean

Property Value

boolean

networkRuleBypassOptions

Whether to allow trusted Azure services to access a network restricted registry.

networkRuleBypassOptions?: string

Property Value

string

networkRuleSet

The network rule set for a container registry.

networkRuleSet?: NetworkRuleSet

Property Value

NetworkRuleSet

policies

The policies for a container registry.

policies?: Policies

Property Value

Policies

privateEndpointConnections

List of private endpoint connections for a container registry.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The provisioning state of the container registry at the time the operation was called.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether or not public network access is allowed for the container registry.

publicNetworkAccess?: string

Property Value

string

regionalEndpointHostNames

List of host names that will serve registry when RegionalEndpoints is enabled.

regionalEndpointHostNames?: string[]

Property Value

string[]

regionalEndpoints

Enable per-region endpoints for accessing registry.

regionalEndpoints?: string

Property Value

string

roleAssignmentMode

Determines registry role assignment mode.

roleAssignmentMode?: string

Property Value

string

sku

The SKU of the container registry.

sku: Sku

Property Value

Sku

status

The status of the container registry at the time the operation was called.

status?: Status

Property Value

Status

zoneRedundancy

Whether or not zone redundancy is enabled for this container registry

zoneRedundancy?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the private link resource.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type