Package version:

Interface Registries

Interface representing a Registries.

Hierarchy

Registries

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<PollerLike<PollOperationState<Registry>, Registry>>
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<Registry>, Registry>>
- Defined in operationsInterfaces/registries.ts:133

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<Registry>
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<Registry>
- Defined in operationsInterfaces/registries.ts:151

beginDelete

beginDelete(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/registries.ts:163

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/registries.ts:174

beginGenerateCredentials

beginGenerateCredentials(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<PollerLike<PollOperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
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<GenerateCredentialsResult>, GenerateCredentialsResult>>
- Defined in operationsInterfaces/registries.ts:266

beginGenerateCredentialsAndWait

beginGenerateCredentialsAndWait(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<GenerateCredentialsResult>
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<GenerateCredentialsResult>
- Defined in operationsInterfaces/registries.ts:284

beginImportImage

beginImportImage(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/registries.ts:86

beginImportImageAndWait

beginImportImageAndWait(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/registries.ts:99

beginScheduleRun

beginScheduleRun(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<PollerLike<PollOperationState<Run>, Run>>
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<Run>, Run>>
- Defined in operationsInterfaces/registries.ts:297

beginScheduleRunAndWait

beginScheduleRunAndWait(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<Run>
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<Run>
- Defined in operationsInterfaces/registries.ts:315

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<PollerLike<PollOperationState<Registry>, Registry>>
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<Registry>, Registry>>
- Defined in operationsInterfaces/registries.ts:186

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<Registry>
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<Registry>
- Defined in operationsInterfaces/registries.ts:204

checkNameAvailability

checkNameAvailability(registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams): Promise<RegistryNameStatus>
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<RegistryNameStatus>
- Defined in operationsInterfaces/registries.ts:111

get

get(resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams): Promise<Registry>
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<Registry>
- Defined in operationsInterfaces/registries.ts:121

getBuildSourceUploadUrl

getBuildSourceUploadUrl(resourceGroupName: string, registryName: string, options?: RegistriesGetBuildSourceUploadUrlOptionalParams): Promise<SourceUploadDefinition>
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<SourceUploadDefinition>
- Defined in operationsInterfaces/registries.ts:327

getPrivateLinkResource

getPrivateLinkResource(resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams): Promise<PrivateLinkResource>
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<PrivateLinkResource>
- Defined in operationsInterfaces/registries.ts:228

list

list(options?: RegistriesListOptionalParams): PagedAsyncIterableIterator<Registry>
Lists all the container registries under the specified subscription.
Parameters
- Optional options: RegistriesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Registry>
- Defined in operationsInterfaces/registries.ts:56

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Registry>
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>
- Defined in operationsInterfaces/registries.ts:64

listCredentials

listCredentials(resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams): Promise<RegistryListCredentialsResult>
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<RegistryListCredentialsResult>
- Defined in operationsInterfaces/registries.ts:240

listPrivateLinkResources

listPrivateLinkResources(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>
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>
- Defined in operationsInterfaces/registries.ts:74

listUsages

listUsages(resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams): Promise<RegistryUsageListResult>
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<RegistryUsageListResult>
- Defined in operationsInterfaces/registries.ts:216

regenerateCredential

regenerateCredential(resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams): Promise<RegistryListCredentialsResult>
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<RegistryListCredentialsResult>
- Defined in operationsInterfaces/registries.ts:253

Interface Registries

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

registry: Registry

Optional options: RegistriesCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<Registry>, Registry>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

registry: Registry

Optional options: RegistriesCreateOptionalParams

Returns Promise<Registry>

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<GenerateCredentialsResult>, GenerateCredentialsResult>>

beginGenerateCredentialsAndWait

Parameters

resourceGroupName: string

registryName: string

generateCredentialsParameters: GenerateCredentialsParameters

Optional options: RegistriesGenerateCredentialsOptionalParams

Returns Promise<GenerateCredentialsResult>

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<Run>, Run>>

beginScheduleRunAndWait

Parameters

resourceGroupName: string

registryName: string

runRequest: RunRequestUnion

Optional options: RegistriesScheduleRunOptionalParams

Returns Promise<Run>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

registryUpdateParameters: RegistryUpdateParameters

Optional options: RegistriesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Registry>, Registry>>

`Optional` options: RegistriesCreateOptionalParams

`Optional` options: RegistriesCreateOptionalParams

`Optional` options: RegistriesDeleteOptionalParams

`Optional` options: RegistriesDeleteOptionalParams

`Optional` options: RegistriesGenerateCredentialsOptionalParams

`Optional` options: RegistriesGenerateCredentialsOptionalParams

`Optional` options: RegistriesImportImageOptionalParams

`Optional` options: RegistriesImportImageOptionalParams

`Optional` options: RegistriesScheduleRunOptionalParams

`Optional` options: RegistriesScheduleRunOptionalParams

`Optional` options: RegistriesUpdateOptionalParams

`Optional` options: RegistriesUpdateOptionalParams

`Optional` options: RegistriesCheckNameAvailabilityOptionalParams

`Optional` options: RegistriesGetOptionalParams

`Optional` options: RegistriesGetBuildSourceUploadUrlOptionalParams

`Optional` options: RegistriesGetPrivateLinkResourceOptionalParams

`Optional` options: RegistriesListOptionalParams

`Optional` options: RegistriesListByResourceGroupOptionalParams

`Optional` options: RegistriesListCredentialsOptionalParams

`Optional` options: RegistriesListPrivateLinkResourcesOptionalParams

`Optional` options: RegistriesListUsagesOptionalParams

`Optional` options: RegistriesRegenerateCredentialOptionalParams