ContainerRegistryResource Class

Definition

Provides backward-compatible task-related operations on a container registry resource.

public class ContainerRegistryResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerRegistry.ContainerRegistryData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerRegistry.ContainerRegistryData>
type ContainerRegistryResource = class
    inherit ArmResource
    interface IJsonModel<ContainerRegistryData>
    interface IPersistableModel<ContainerRegistryData>
Public Class ContainerRegistryResource
Inherits ArmResource
Implements IJsonModel(Of ContainerRegistryData), IPersistableModel(Of ContainerRegistryData)
Inheritance
ContainerRegistryResource
Implements

Constructors

Name Description
ContainerRegistryResource()

Initializes a new instance of ContainerRegistryResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Deletes a container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Delete.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
DeleteAsync(WaitUntil, CancellationToken)

Deletes a container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Delete.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GenerateCredentials(WaitUntil, ContainerRegistryGenerateCredentialsContent, CancellationToken)

Generate keys for a token of a specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials.
  • Operation Id. : Registries_GenerateCredentials.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GenerateCredentialsAsync(WaitUntil, ContainerRegistryGenerateCredentialsContent, CancellationToken)

Generate keys for a token of a specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/generateCredentials.
  • Operation Id. : Registries_GenerateCredentials.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
Get(CancellationToken)

Gets the properties of the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Get.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GetAsync(CancellationToken)

Gets the properties of the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Get.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetConnectedRegistries()

Gets a collection of ConnectedRegistries in the ContainerRegistryResource.

GetConnectedRegistry(String, CancellationToken)

Gets the properties of the connected registry.

GetConnectedRegistryAsync(String, CancellationToken)

Gets the properties of the connected registry.

GetContainerRegistryArchive(String, String, CancellationToken)

Gets the properties of the archive.

GetContainerRegistryArchiveAsync(String, String, CancellationToken)

Gets the properties of the archive.

GetContainerRegistryArchives(String)

Gets a collection of ContainerRegistryArchives in the ContainerRegistryResource.

GetContainerRegistryCacheRule(String, CancellationToken)

Gets the properties of the specified cache rule resource.

GetContainerRegistryCacheRuleAsync(String, CancellationToken)

Gets the properties of the specified cache rule resource.

GetContainerRegistryCacheRules()

Gets a collection of ContainerRegistryCacheRules in the ContainerRegistryResource.

GetContainerRegistryCredentialSet(String, CancellationToken)

Gets the properties of the specified credential set resource.

GetContainerRegistryCredentialSetAsync(String, CancellationToken)

Gets the properties of the specified credential set resource.

GetContainerRegistryCredentialSets()

Gets a collection of ContainerRegistryCredentialSets in the ContainerRegistryResource.

GetContainerRegistryExportPipeline(String, CancellationToken)

Gets the properties of the export pipeline.

GetContainerRegistryExportPipelineAsync(String, CancellationToken)

Gets the properties of the export pipeline.

GetContainerRegistryExportPipelines()

Gets a collection of ContainerRegistryExportPipelines in the ContainerRegistryResource.

GetContainerRegistryImportPipeline(String, CancellationToken)

Gets the properties of the import pipeline.

GetContainerRegistryImportPipelineAsync(String, CancellationToken)

Gets the properties of the import pipeline.

GetContainerRegistryImportPipelines()

Gets a collection of ContainerRegistryImportPipelines in the ContainerRegistryResource.

GetContainerRegistryPipelineRun(String, CancellationToken)

Gets the detailed information for a given pipeline run.

GetContainerRegistryPipelineRunAsync(String, CancellationToken)

Gets the detailed information for a given pipeline run.

GetContainerRegistryPipelineRuns()

Gets a collection of ContainerRegistryPipelineRuns in the ContainerRegistryResource.

GetContainerRegistryPrivateEndpointConnection(String, CancellationToken)

Get the specified private endpoint connection associated with the container registry.

GetContainerRegistryPrivateEndpointConnectionAsync(String, CancellationToken)

Get the specified private endpoint connection associated with the container registry.

GetContainerRegistryPrivateEndpointConnections()

Gets a collection of ContainerRegistryPrivateEndpointConnections in the ContainerRegistryResource.

GetContainerRegistryPrivateLinkResource(String, CancellationToken)

Gets a private link resource by a specified group name for a container registry.

GetContainerRegistryPrivateLinkResourceAsync(String, CancellationToken)

Gets a private link resource by a specified group name for a container registry.

GetContainerRegistryPrivateLinkResources()

Gets a collection of ContainerRegistryPrivateLinkResources in the ContainerRegistryResource.

GetContainerRegistryReplication(String, CancellationToken)

Gets the properties of the specified replication.

GetContainerRegistryReplicationAsync(String, CancellationToken)

Gets the properties of the specified replication.

GetContainerRegistryReplications()

Gets a collection of ContainerRegistryReplications in the ContainerRegistryResource.

GetContainerRegistryToken(String, CancellationToken)

Gets the properties of the specified token.

GetContainerRegistryTokenAsync(String, CancellationToken)

Gets the properties of the specified token.

GetContainerRegistryTokens()

Gets a collection of ContainerRegistryTokens in the ContainerRegistryResource.

GetContainerRegistryWebhook(String, CancellationToken)

Gets the properties of the specified webhook.

GetContainerRegistryWebhookAsync(String, CancellationToken)

Gets the properties of the specified webhook.

GetContainerRegistryWebhooks()

Gets a collection of ContainerRegistryWebhooks in the ContainerRegistryResource.

GetCredentials(CancellationToken)

Lists the login credentials for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials.
  • Operation Id. : Registries_ListCredentials.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GetCredentialsAsync(CancellationToken)

Lists the login credentials for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listCredentials.
  • Operation Id. : Registries_ListCredentials.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetScopeMap(String, CancellationToken)

Gets the properties of the specified scope map.

GetScopeMapAsync(String, CancellationToken)

Gets the properties of the specified scope map.

GetScopeMaps()

Gets a collection of ScopeMaps in the ContainerRegistryResource.

GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetUsages(CancellationToken)

Gets the quota usages for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages.
  • Operation Id. : Registries_ListUsages.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
GetUsagesAsync(CancellationToken)

Gets the quota usages for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listUsages.
  • Operation Id. : Registries_ListUsages.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
ImportImage(WaitUntil, ContainerRegistryImportImageContent, CancellationToken)

Copies an image to this container registry from the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage.
  • Operation Id. : Registries_ImportImage.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
ImportImageAsync(WaitUntil, ContainerRegistryImportImageContent, CancellationToken)

Copies an image to this container registry from the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/importImage.
  • Operation Id. : Registries_ImportImage.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
RegenerateCredential(ContainerRegistryCredentialRegenerateContent, CancellationToken)

Regenerates one of the login credentials for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential.
  • Operation Id. : Registries_RegenerateCredential.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
RegenerateCredentialAsync(ContainerRegistryCredentialRegenerateContent, CancellationToken)

Regenerates one of the login credentials for the specified container registry.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/regenerateCredential.
  • Operation Id. : Registries_RegenerateCredential.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, ContainerRegistryPatch, CancellationToken)

Updates a container registry with the specified parameters.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Update.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.
UpdateAsync(WaitUntil, ContainerRegistryPatch, CancellationToken)

Updates a container registry with the specified parameters.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}.
  • Operation Id. : Registries_Update.
  • Default Api Version. : 2026-03-01-preview.
  • Resource. : ContainerRegistryResource.

Explicit Interface Implementations

Name Description
IJsonModel<ContainerRegistryData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ContainerRegistryData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ContainerRegistryData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ContainerRegistryData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ContainerRegistryData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to