Registries | @azure/arm-containerregistry

Interface representing a Registries.

Hierarchy

Registries

Implemented by

RegistriesImpl

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<PollerLike<PollOperationState<RegistriesCreateResponse>, RegistriesCreateResponse>>

- Defined in operationsInterfaces/registries.ts:133
Creates a container registry with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- registry: Registry
  
  The parameters for creating a container registry.
- Optional options: RegistriesCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RegistriesCreateResponse>, RegistriesCreateResponse>>

beginCreateAndWait

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

- Defined in operationsInterfaces/registries.ts:151
Creates a container registry with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- registry: Registry
  
  The parameters for creating a container registry.
- Optional options: RegistriesCreateOptionalParams
  
  The options parameters.
Returns Promise<RegistriesCreateResponse>

beginDelete

beginDelete(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/registries.ts:163
Deletes a container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/registries.ts:174
Deletes a container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginGenerateCredentials

beginGenerateCredentials(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<PollerLike<PollOperationState<RegistriesGenerateCredentialsResponse>, RegistriesGenerateCredentialsResponse>>

- Defined in operationsInterfaces/registries.ts:266
Generate keys for a token of a specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- generateCredentialsParameters: GenerateCredentialsParameters
  
  The parameters for generating credentials.
- Optional options: RegistriesGenerateCredentialsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RegistriesGenerateCredentialsResponse>, RegistriesGenerateCredentialsResponse>>

beginGenerateCredentialsAndWait

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

- Defined in operationsInterfaces/registries.ts:284
Generate keys for a token of a specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- generateCredentialsParameters: GenerateCredentialsParameters
  
  The parameters for generating credentials.
- Optional options: RegistriesGenerateCredentialsOptionalParams
  
  The options parameters.
Returns Promise<RegistriesGenerateCredentialsResponse>

beginImportImage

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

- Defined in operationsInterfaces/registries.ts:86
Copies an image to this container registry from the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- parameters: ImportImageParameters
  
  The parameters specifying the image to copy and the source container registry.
- Optional options: RegistriesImportImageOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginImportImageAndWait

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

- Defined in operationsInterfaces/registries.ts:99
Copies an image to this container registry from the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- parameters: ImportImageParameters
  
  The parameters specifying the image to copy and the source container registry.
- Optional options: RegistriesImportImageOptionalParams
  
  The options parameters.
Returns Promise<void>

beginScheduleRun

beginScheduleRun(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<PollerLike<PollOperationState<RegistriesScheduleRunResponse>, RegistriesScheduleRunResponse>>

- Defined in operationsInterfaces/registries.ts:297
Schedules a new run based on the request parameters and add it to the run queue.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- runRequest: RunRequestUnion
  
  The parameters of a run that needs to scheduled.
- Optional options: RegistriesScheduleRunOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RegistriesScheduleRunResponse>, RegistriesScheduleRunResponse>>

beginScheduleRunAndWait

beginScheduleRunAndWait(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<RegistriesScheduleRunResponse>

- Defined in operationsInterfaces/registries.ts:315
Schedules a new run based on the request parameters and add it to the run queue.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- runRequest: RunRequestUnion
  
  The parameters of a run that needs to scheduled.
- Optional options: RegistriesScheduleRunOptionalParams
  
  The options parameters.
Returns Promise<RegistriesScheduleRunResponse>

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<PollerLike<PollOperationState<RegistriesUpdateResponse>, RegistriesUpdateResponse>>

- Defined in operationsInterfaces/registries.ts:186
Updates a container registry with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- registryUpdateParameters: RegistryUpdateParameters
  
  The parameters for updating a container registry.
- Optional options: RegistriesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<RegistriesUpdateResponse>, RegistriesUpdateResponse>>

beginUpdateAndWait

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

- Defined in operationsInterfaces/registries.ts:204
Updates a container registry with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- registryUpdateParameters: RegistryUpdateParameters
  
  The parameters for updating a container registry.
- Optional options: RegistriesUpdateOptionalParams
  
  The options parameters.
Returns Promise<RegistriesUpdateResponse>

checkNameAvailability

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

- Defined in operationsInterfaces/registries.ts:111
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.

Parameters
- registryNameCheckRequest: RegistryNameCheckRequest
  
  The object containing information for the availability request.
- Optional options: RegistriesCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<RegistriesCheckNameAvailabilityResponse>

get

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

- Defined in operationsInterfaces/registries.ts:121
Gets the properties of the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesGetOptionalParams
  
  The options parameters.
Returns Promise<RegistriesGetResponse>

getBuildSourceUploadUrl

getBuildSourceUploadUrl(resourceGroupName: string, registryName: string, options?: RegistriesGetBuildSourceUploadUrlOptionalParams): Promise<RegistriesGetBuildSourceUploadUrlResponse>

- Defined in operationsInterfaces/registries.ts:327
Get the upload location for the user to be able to upload the source.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesGetBuildSourceUploadUrlOptionalParams
  
  The options parameters.
Returns Promise<RegistriesGetBuildSourceUploadUrlResponse>

getPrivateLinkResource

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

- Defined in operationsInterfaces/registries.ts:228
Gets a private link resource by a specified group name for a container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- groupName: string
  
  The name of the private link resource.
- Optional options: RegistriesGetPrivateLinkResourceOptionalParams
  
  The options parameters.
Returns Promise<RegistriesGetPrivateLinkResourceResponse>

list

list(options?: RegistriesListOptionalParams): PagedAsyncIterableIterator<Registry>

- Defined in operationsInterfaces/registries.ts:56
Lists all the container registries under the specified subscription.

Parameters
- Optional options: RegistriesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Registry>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Registry>

- Defined in operationsInterfaces/registries.ts:64
Lists all the container registries under the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- Optional options: RegistriesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Registry>

listCredentials

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

- Defined in operationsInterfaces/registries.ts:240
Lists the login credentials for the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesListCredentialsOptionalParams
  
  The options parameters.
Returns Promise<RegistriesListCredentialsResponse>

listPrivateLinkResources

listPrivateLinkResources(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>

- Defined in operationsInterfaces/registries.ts:74
Lists the private link resources for a container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesListPrivateLinkResourcesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateLinkResource>

listUsages

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

- Defined in operationsInterfaces/registries.ts:216
Gets the quota usages for the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RegistriesListUsagesOptionalParams
  
  The options parameters.
Returns Promise<RegistriesListUsagesResponse>

regenerateCredential

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

- Defined in operationsInterfaces/registries.ts:253
Regenerates one of the login credentials for the specified container registry.

Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- regenerateCredentialParameters: RegenerateCredentialParameters
  
  Specifies name of the password which should be regenerated -- password or password2.
- Optional options: RegistriesRegenerateCredentialOptionalParams
  
  The options parameters.
Returns Promise<RegistriesRegenerateCredentialResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

registry: Registry

Optional options: RegistriesCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<RegistriesCreateResponse>, RegistriesCreateResponse>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

registry: Registry

Optional options: RegistriesCreateOptionalParams

Returns Promise<RegistriesCreateResponse>

beginDelete

Parameters

resourceGroupName: string

registryName: string

Optional options: RegistriesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

Optional options: RegistriesDeleteOptionalParams

Returns Promise<void>

beginGenerateCredentials

Parameters

resourceGroupName: string

registryName: string

generateCredentialsParameters: GenerateCredentialsParameters

Optional options: RegistriesGenerateCredentialsOptionalParams

Returns Promise<PollerLike<PollOperationState<RegistriesGenerateCredentialsResponse>, RegistriesGenerateCredentialsResponse>>

beginGenerateCredentialsAndWait

Parameters

resourceGroupName: string

registryName: string

generateCredentialsParameters: GenerateCredentialsParameters

Optional options: RegistriesGenerateCredentialsOptionalParams

Returns Promise<RegistriesGenerateCredentialsResponse>

beginImportImage

Parameters

resourceGroupName: string

registryName: string

parameters: ImportImageParameters

Optional options: RegistriesImportImageOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginImportImageAndWait

Parameters

resourceGroupName: string

registryName: string

parameters: ImportImageParameters

Optional options: RegistriesImportImageOptionalParams

Returns Promise<void>

beginScheduleRun

Parameters

resourceGroupName: string

registryName: string

runRequest: RunRequestUnion

Optional options: RegistriesScheduleRunOptionalParams

Returns Promise<PollerLike<PollOperationState<RegistriesScheduleRunResponse>, RegistriesScheduleRunResponse>>

beginScheduleRunAndWait

Parameters

resourceGroupName: string

registryName: string

runRequest: RunRequestUnion

Optional options: RegistriesScheduleRunOptionalParams

Returns Promise<RegistriesScheduleRunResponse>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

registryUpdateParameters: RegistryUpdateParameters

Optional options: RegistriesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<RegistriesUpdateResponse>, RegistriesUpdateResponse>>