Share via

RegistriesOperations interface

Package:
@azure/arm-containerregistry

Interface representing a Registries operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginGenerateCredentials
beginGenerateCredentialsAndWait
beginImportImage
beginImportImageAndWait
beginUpdate
beginUpdateAndWait
checkNameAvailability

Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.
create

Creates a container registry with the specified parameters.
delete
generateCredentials

Generate keys for a token of a specified container registry.
get

Gets the properties of the specified container registry.
getPrivateLinkResource

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

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

Lists all the container registries under the specified subscription.
listByResourceGroup

Lists all the container registries under the specified resource group.
listCredentials

Lists the login credentials for the specified container registry.
listPrivateLinkResources

Lists the private link resources for a container registry.
listUsages

Gets the quota usages for the specified container registry.
regenerateCredential

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

Updates a container registry with the specified parameters.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Registry>, Registry>>

Property Value

(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Registry>, Registry>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => Promise<Registry>

Property Value

(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => Promise<Registry>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => Promise<void>

beginGenerateCredentials

Warning

This API is now deprecated.

use generateCredentials instead

beginGenerateCredentials: (resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>

Property Value

(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>

beginGenerateCredentialsAndWait

Warning

This API is now deprecated.

use generateCredentials instead

beginGenerateCredentialsAndWait: (resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => Promise<GenerateCredentialsResult>

Property Value

(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => Promise<GenerateCredentialsResult>

beginImportImage

Warning

This API is now deprecated.

use importImage instead

beginImportImage: (resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginImportImageAndWait

Warning

This API is now deprecated.

use importImage instead

beginImportImageAndWait: (resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Registry>, Registry>>

Property Value

(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Registry>, Registry>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => Promise<Registry>

Property Value

(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => Promise<Registry>

checkNameAvailability

Checks whether the container registry name is available for use. The name must contain only alphanumeric characters, be globally unique, and between 5 and 50 characters in length.

checkNameAvailability: (registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams) => Promise<RegistryNameStatus>

Property Value

(registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams) => Promise<RegistryNameStatus>

create

Creates a container registry with the specified parameters.

create: (resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => PollerLike<OperationState<Registry>, Registry>

Property Value

(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams) => PollerLike<OperationState<Registry>, Registry>

delete 

delete: (resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

generateCredentials

Generate keys for a token of a specified container registry.

generateCredentials: (resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => PollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>

Property Value

(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams) => PollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>

get

Gets the properties of the specified container registry.

get: (resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams) => Promise<Registry>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams) => Promise<Registry>

getPrivateLinkResource

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

getPrivateLinkResource: (resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams) => Promise<PrivateLinkResource>

Property Value

(resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams) => Promise<PrivateLinkResource>

importImage

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

importImage: (resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams) => PollerLike<OperationState<void>, void>

list

Lists all the container registries under the specified subscription.

list: (options?: RegistriesListOptionalParams) => PagedAsyncIterableIterator<Registry, Registry[], PageSettings>

Property Value

(options?: RegistriesListOptionalParams) => PagedAsyncIterableIterator<Registry, Registry[], PageSettings>

listByResourceGroup

Lists all the container registries under the specified resource group.

listByResourceGroup: (resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Registry, Registry[], PageSettings>

Property Value

(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Registry, Registry[], PageSettings>

listCredentials

Lists the login credentials for the specified container registry.

listCredentials: (resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams) => Promise<RegistryListCredentialsResult>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams) => Promise<RegistryListCredentialsResult>

listPrivateLinkResources

Lists the private link resources for a container registry.

listPrivateLinkResources: (resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

listUsages

Gets the quota usages for the specified container registry.

listUsages: (resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams) => Promise<RegistryUsageListResult>

Property Value

(resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams) => Promise<RegistryUsageListResult>

regenerateCredential

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

regenerateCredential: (resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams) => Promise<RegistryListCredentialsResult>

Property Value

(resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams) => Promise<RegistryListCredentialsResult>

update

Updates a container registry with the specified parameters.

update: (resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => PollerLike<OperationState<Registry>, Registry>

Property Value

(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams) => PollerLike<OperationState<Registry>, Registry>