containerregistry.azure.com/v1api20210901

Package v1api20210901 contains API Schema definitions for the containerregistry v1api20210901 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-09-01"

EncryptionProperty

(Appears on:Registry_Spec)

Field	Description
`keyVaultProperties` KeyVaultProperties	KeyVaultProperties: Key vault properties.
`status` EncryptionProperty_Status	Status: Indicates whether or not the encryption is enabled for container registry.

EncryptionProperty_STATUS

(Appears on:Registry_STATUS)

Field	Description
`keyVaultProperties` KeyVaultProperties_STATUS	KeyVaultProperties: Key vault properties.
`status` EncryptionProperty_Status_STATUS	Status: Indicates whether or not the encryption is enabled for container registry.

EncryptionProperty_Status (`string` alias)

(Appears on:EncryptionProperty)

Value	Description
"disabled"
"enabled"

EncryptionProperty_Status_STATUS (`string` alias)

(Appears on:EncryptionProperty_STATUS)

Value	Description
"disabled"
"enabled"

ExportPolicy

(Appears on:Policies)

The export policy for a container registry.

Field	Description
`status` ExportPolicy_Status	Status: The value that indicates whether the policy is enabled or not.

ExportPolicy_STATUS

(Appears on:Policies_STATUS)

The export policy for a container registry.

Field	Description
`status` ExportPolicy_Status_STATUS	Status: The value that indicates whether the policy is enabled or not.

ExportPolicy_Status (`string` alias)

(Appears on:ExportPolicy)

Value	Description
"disabled"
"enabled"

ExportPolicy_Status_STATUS (`string` alias)

(Appears on:ExportPolicy_STATUS)

Value	Description
"disabled"
"enabled"

IPRule

(Appears on:NetworkRuleSet)

IP rule with specific IP or IP range in CIDR format.

Field	Description
`action` IPRule_Action	Action: The action of IP ACL rule.
`value` string	Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

IPRule_Action (`string` alias)

(Appears on:IPRule)

Value	Description
"Allow"

IPRule_Action_STATUS (`string` alias)

(Appears on:IPRule_STATUS)

Value	Description
"Allow"

IPRule_STATUS

(Appears on:NetworkRuleSet_STATUS)

IP rule with specific IP or IP range in CIDR format.

Field	Description
`action` IPRule_Action_STATUS	Action: The action of IP ACL rule.
`value` string	Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

IdentityProperties

(Appears on:Registry_Spec)

Managed identity for the resource.

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` IdentityProperties_Type	Type: The identity type.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: 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}’.

IdentityProperties_STATUS

(Appears on:Registry_STATUS)

Managed identity for the resource.

Field	Description
`principalId` string	PrincipalId: The principal ID of resource identity.
`tenantId` string	TenantId: The tenant ID of resource.
`type` IdentityProperties_Type_STATUS	Type: The identity type.
`userAssignedIdentities` map[string]./api/containerregistry/v1api20210901.UserIdentityProperties_STATUS	UserAssignedIdentities: 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}’.

IdentityProperties_Type (`string` alias)

(Appears on:IdentityProperties)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

IdentityProperties_Type_STATUS (`string` alias)

(Appears on:IdentityProperties_STATUS)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

KeyVaultProperties

(Appears on:EncryptionProperty)

Field	Description
`identity` string	Identity: The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: Key vault uri to access the encryption key.

KeyVaultProperties_STATUS

(Appears on:EncryptionProperty_STATUS)

Field	Description
`identity` string	Identity: The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: Key vault uri to access the encryption key.
`keyRotationEnabled` bool	KeyRotationEnabled: Auto key rotation status for a CMK enabled registry.
`lastKeyRotationTimestamp` string	LastKeyRotationTimestamp: Timestamp of the last successful key rotation.
`versionedKeyIdentifier` string	VersionedKeyIdentifier: The fully qualified key identifier that includes the version of the key that is actually used for encryption.

NetworkRuleSet

(Appears on:Registry_Spec)

The network rule set for a container registry.

Field	Description
`defaultAction` NetworkRuleSet_DefaultAction	DefaultAction: The default action of allow or deny when no other rules match.
`ipRules` []IPRule	IpRules: The IP ACL rules.

NetworkRuleSet_DefaultAction (`string` alias)

(Appears on:NetworkRuleSet)

Value	Description
"Allow"
"Deny"

NetworkRuleSet_DefaultAction_STATUS (`string` alias)

(Appears on:NetworkRuleSet_STATUS)

Value	Description
"Allow"
"Deny"

NetworkRuleSet_STATUS

(Appears on:Registry_STATUS)

The network rule set for a container registry.

Field	Description
`defaultAction` NetworkRuleSet_DefaultAction_STATUS	DefaultAction: The default action of allow or deny when no other rules match.
`ipRules` []IPRule_STATUS	IpRules: The IP ACL rules.

Policies

(Appears on:Registry_Spec)

The policies for a container registry.

Field	Description
`exportPolicy` ExportPolicy	ExportPolicy: The export policy for a container registry.
`quarantinePolicy` QuarantinePolicy	QuarantinePolicy: The quarantine policy for a container registry.
`retentionPolicy` RetentionPolicy	RetentionPolicy: The retention policy for a container registry.
`trustPolicy` TrustPolicy	TrustPolicy: The content trust policy for a container registry.

Policies_STATUS

(Appears on:Registry_STATUS)

The policies for a container registry.

Field	Description
`exportPolicy` ExportPolicy_STATUS	ExportPolicy: The export policy for a container registry.
`quarantinePolicy` QuarantinePolicy_STATUS	QuarantinePolicy: The quarantine policy for a container registry.
`retentionPolicy` RetentionPolicy_STATUS	RetentionPolicy: The retention policy for a container registry.
`trustPolicy` TrustPolicy_STATUS	TrustPolicy: The content trust policy for a container registry.

PrivateEndpointConnection_STATUS

(Appears on:Registry_STATUS)

An object that represents a private endpoint connection for a container registry.

Field	Description
`id` string	Id: The resource ID.

QuarantinePolicy

(Appears on:Policies)

The quarantine policy for a container registry.

Field	Description
`status` QuarantinePolicy_Status	Status: The value that indicates whether the policy is enabled or not.

QuarantinePolicy_STATUS

(Appears on:Policies_STATUS)

The quarantine policy for a container registry.

Field	Description
`status` QuarantinePolicy_Status_STATUS	Status: The value that indicates whether the policy is enabled or not.

QuarantinePolicy_Status (`string` alias)

(Appears on:QuarantinePolicy)

Value	Description
"disabled"
"enabled"

QuarantinePolicy_Status_STATUS (`string` alias)

(Appears on:QuarantinePolicy_STATUS)

Value	Description
"disabled"
"enabled"

Registry

Generator information: - Generated from: /containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2021-09-01/containerregistry.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Registry_Spec

`adminUserEnabled` bool	AdminUserEnabled: The value that indicates whether the admin user is enabled.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`dataEndpointEnabled` bool	DataEndpointEnabled: Enable a single data endpoint per region for serving data.
`encryption` EncryptionProperty	Encryption: The encryption settings of container registry.
`identity` IdentityProperties	Identity: The identity of the container registry.
`location` string	Location: The location of the resource. This cannot be changed after the resource is created.
`networkRuleBypassOptions` RegistryProperties_NetworkRuleBypassOptions	NetworkRuleBypassOptions: Whether to allow trusted Azure services to access a network restricted registry.
`networkRuleSet` NetworkRuleSet	NetworkRuleSet: The network rule set for a container registry.
`operatorSpec` RegistryOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`policies` Policies	Policies: The policies for a container registry.
`publicNetworkAccess` RegistryProperties_PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for the container registry.
`sku` Sku	Sku: The SKU of the container registry.
`tags` map[string]string	Tags: The tags of the resource.
`zoneRedundancy` RegistryProperties_ZoneRedundancy	ZoneRedundancy: Whether or not zone redundancy is enabled for this container registry

status
Registry_STATUS

RegistryOperatorSpec

(Appears on:Registry_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

RegistryProperties_NetworkRuleBypassOptions (`string` alias)

(Appears on:Registry_Spec)

Value	Description
"AzureServices"
"None"

RegistryProperties_NetworkRuleBypassOptions_STATUS (`string` alias)

(Appears on:Registry_STATUS)

Value	Description
"AzureServices"
"None"

RegistryProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:Registry_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"

RegistryProperties_PublicNetworkAccess (`string` alias)

(Appears on:Registry_Spec)

Value	Description
"Disabled"
"Enabled"

RegistryProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Registry_STATUS)

Value	Description
"Disabled"
"Enabled"

RegistryProperties_ZoneRedundancy (`string` alias)

(Appears on:Registry_Spec)

Value	Description
"Disabled"
"Enabled"

RegistryProperties_ZoneRedundancy_STATUS (`string` alias)

(Appears on:Registry_STATUS)

Value	Description
"Disabled"
"Enabled"

Registry_STATUS

(Appears on:Registry)

An object that represents a container registry.

Field	Description
`adminUserEnabled` bool	AdminUserEnabled: The value that indicates whether the admin user is enabled.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`creationDate` string	CreationDate: The creation date of the container registry in ISO8601 format.
`dataEndpointEnabled` bool	DataEndpointEnabled: Enable a single data endpoint per region for serving data.
`dataEndpointHostNames` []string	DataEndpointHostNames: List of host names that will serve data when dataEndpointEnabled is true.
`encryption` EncryptionProperty_STATUS	Encryption: The encryption settings of container registry.
`id` string	Id: The resource ID.
`identity` IdentityProperties_STATUS	Identity: The identity of the container registry.
`location` string	Location: The location of the resource. This cannot be changed after the resource is created.
`loginServer` string	LoginServer: The URL that can be used to log into the container registry.
`name` string	Name: The name of the resource.
`networkRuleBypassOptions` RegistryProperties_NetworkRuleBypassOptions_STATUS	NetworkRuleBypassOptions: Whether to allow trusted Azure services to access a network restricted registry.
`networkRuleSet` NetworkRuleSet_STATUS	NetworkRuleSet: The network rule set for a container registry.
`policies` Policies_STATUS	Policies: The policies for a container registry.
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: List of private endpoint connections for a container registry.
`provisioningState` RegistryProperties_ProvisioningState_STATUS	ProvisioningState: The provisioning state of the container registry at the time the operation was called.
`publicNetworkAccess` RegistryProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Whether or not public network access is allowed for the container registry.
`sku` Sku_STATUS	Sku: The SKU of the container registry.
`status` Status_STATUS	Status: The status of the container registry at the time the operation was called.
`systemData` SystemData_STATUS	SystemData: Metadata pertaining to creation and last modification of the resource.
`tags` map[string]string	Tags: The tags of the resource.
`type` string	Type: The type of the resource.
`zoneRedundancy` RegistryProperties_ZoneRedundancy_STATUS	ZoneRedundancy: Whether or not zone redundancy is enabled for this container registry

Registry_Spec

(Appears on:Registry)

Field	Description
`adminUserEnabled` bool	AdminUserEnabled: The value that indicates whether the admin user is enabled.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`dataEndpointEnabled` bool	DataEndpointEnabled: Enable a single data endpoint per region for serving data.
`encryption` EncryptionProperty	Encryption: The encryption settings of container registry.
`identity` IdentityProperties	Identity: The identity of the container registry.
`location` string	Location: The location of the resource. This cannot be changed after the resource is created.
`networkRuleBypassOptions` RegistryProperties_NetworkRuleBypassOptions	NetworkRuleBypassOptions: Whether to allow trusted Azure services to access a network restricted registry.
`networkRuleSet` NetworkRuleSet	NetworkRuleSet: The network rule set for a container registry.
`operatorSpec` RegistryOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`policies` Policies	Policies: The policies for a container registry.
`publicNetworkAccess` RegistryProperties_PublicNetworkAccess	PublicNetworkAccess: Whether or not public network access is allowed for the container registry.
`sku` Sku	Sku: The SKU of the container registry.
`tags` map[string]string	Tags: The tags of the resource.
`zoneRedundancy` RegistryProperties_ZoneRedundancy	ZoneRedundancy: Whether or not zone redundancy is enabled for this container registry

RetentionPolicy

(Appears on:Policies)

The retention policy for a container registry.

Field	Description
`days` int	Days: The number of days to retain an untagged manifest after which it gets purged.
`status` RetentionPolicy_Status	Status: The value that indicates whether the policy is enabled or not.

RetentionPolicy_STATUS

(Appears on:Policies_STATUS)

The retention policy for a container registry.

Field	Description
`days` int	Days: The number of days to retain an untagged manifest after which it gets purged.
`lastUpdatedTime` string	LastUpdatedTime: The timestamp when the policy was last updated.
`status` RetentionPolicy_Status_STATUS	Status: The value that indicates whether the policy is enabled or not.

RetentionPolicy_Status (`string` alias)

(Appears on:RetentionPolicy)

Value	Description
"disabled"
"enabled"

RetentionPolicy_Status_STATUS (`string` alias)

(Appears on:RetentionPolicy_STATUS)

Value	Description
"disabled"
"enabled"

Sku

(Appears on:Registry_Spec)

The SKU of a container registry.

Field	Description
`name` Sku_Name	Name: The SKU name of the container registry. Required for registry creation.

Sku_Name (`string` alias)

(Appears on:Sku)

Value	Description
"Basic"
"Classic"
"Premium"
"Standard"

Sku_Name_STATUS (`string` alias)

(Appears on:Sku_STATUS)

Value	Description
"Basic"
"Classic"
"Premium"
"Standard"

Sku_STATUS

(Appears on:Registry_STATUS)

The SKU of a container registry.

Field	Description
`name` Sku_Name_STATUS	Name: The SKU name of the container registry. Required for registry creation.
`tier` Sku_Tier_STATUS	Tier: The SKU tier based on the SKU name.

Sku_Tier_STATUS (`string` alias)

(Appears on:Sku_STATUS)

Value	Description
"Basic"
"Classic"
"Premium"
"Standard"

Status_STATUS

(Appears on:Registry_STATUS)

The status of an Azure resource at the time the operation was called.

Field	Description
`displayStatus` string	DisplayStatus: The short label for the status.
`message` string	Message: The detailed message for the status, including alerts and error messages.
`timestamp` string	Timestamp: The timestamp when the status was changed to the current value.

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:Registry_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource modification (UTC).
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

TrustPolicy

(Appears on:Policies)

The content trust policy for a container registry.

Field	Description
`status` TrustPolicy_Status	Status: The value that indicates whether the policy is enabled or not.
`type` TrustPolicy_Type	Type: The type of trust policy.

TrustPolicy_STATUS

(Appears on:Policies_STATUS)

The content trust policy for a container registry.

Field	Description
`status` TrustPolicy_Status_STATUS	Status: The value that indicates whether the policy is enabled or not.
`type` TrustPolicy_Type_STATUS	Type: The type of trust policy.

TrustPolicy_Status (`string` alias)

(Appears on:TrustPolicy)

Value	Description
"disabled"
"enabled"

TrustPolicy_Status_STATUS (`string` alias)

(Appears on:TrustPolicy_STATUS)

Value	Description
"disabled"
"enabled"

TrustPolicy_Type (`string` alias)

(Appears on:TrustPolicy)

Value	Description
"Notary"

TrustPolicy_Type_STATUS (`string` alias)

(Appears on:TrustPolicy_STATUS)

Value	Description
"Notary"

UserAssignedIdentityDetails

(Appears on:IdentityProperties)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserIdentityProperties_STATUS

(Appears on:IdentityProperties_STATUS)

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

containerregistry.azure.com/v1api20210901