Package version:

Interface Registries

Interface representing a Registries.

interface Registries {
    beginCreate(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>;
    beginCreateAndWait(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<Registry>;
    beginDelete(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<void>;
    beginGenerateCredentials(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>;
    beginGenerateCredentialsAndWait(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<GenerateCredentialsResult>;
    beginImportImage(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginImportImageAndWait(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<void>;
    beginUpdate(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>;
    beginUpdateAndWait(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<Registry>;
    checkNameAvailability(registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams): Promise<RegistryNameStatus>;
    get(resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams): Promise<Registry>;
    getBuildSourceUploadUrl(resourceGroupName: string, registryName: string, options?: RegistriesGetBuildSourceUploadUrlOptionalParams): Promise<SourceUploadDefinition>;
    getPrivateLinkResource(resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams): Promise<PrivateLinkResource>;
    list(options?: RegistriesListOptionalParams): PagedAsyncIterableIterator<Registry>;
    listByResourceGroup(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Registry>;
    listCredentials(resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams): Promise<RegistryListCredentialsResult>;
    listPrivateLinkResources(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
    listUsages(resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams): Promise<RegistryUsageListResult>;
    regenerateCredential(resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams): Promise<RegistryListCredentialsResult>;
    scheduleRun(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<Run>;
}

Methods

beginCreate

beginCreate(resourceGroupName, registryName, registry, options?): Promise<SimplePollerLike<OperationState<Registry>, Registry>>
Creates a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- registry: Registry
  The parameters for creating a container registry.
- Optionaloptions: RegistriesCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Registry>, Registry>>
- Defined in operationsInterfaces/registries.ts:133

beginCreateAndWait

beginCreateAndWait(resourceGroupName, registryName, registry, options?): Promise<Registry>
Creates a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- registry: Registry
  The parameters for creating a container registry.
- Optionaloptions: RegistriesCreateOptionalParams
  The options parameters.
Returns Promise<Registry>
- Defined in operationsInterfaces/registries.ts:151

beginDelete

beginDelete(resourceGroupName, registryName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/registries.ts:163

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, registryName, options?): Promise<void>
Deletes a container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/registries.ts:174

beginGenerateCredentials

beginGenerateCredentials(resourceGroupName, registryName, generateCredentialsParameters, options?): Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
Generate keys for a token of a specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- generateCredentialsParameters: GenerateCredentialsParameters
  The parameters for generating credentials.
- Optionaloptions: RegistriesGenerateCredentialsOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
- Defined in operationsInterfaces/registries.ts:266

beginGenerateCredentialsAndWait

beginGenerateCredentialsAndWait(resourceGroupName, registryName, generateCredentialsParameters, options?): Promise<GenerateCredentialsResult>
Generate keys for a token of a specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- generateCredentialsParameters: GenerateCredentialsParameters
  The parameters for generating credentials.
- Optionaloptions: RegistriesGenerateCredentialsOptionalParams
  The options parameters.
Returns Promise<GenerateCredentialsResult>
- Defined in operationsInterfaces/registries.ts:284

beginImportImage

beginImportImage(resourceGroupName, registryName, parameters, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Copies an image to this container registry from the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- parameters: ImportImageParameters
  The parameters specifying the image to copy and the source container registry.
- Optionaloptions: RegistriesImportImageOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/registries.ts:86

beginImportImageAndWait

beginImportImageAndWait(resourceGroupName, registryName, parameters, options?): Promise<void>
Copies an image to this container registry from the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- parameters: ImportImageParameters
  The parameters specifying the image to copy and the source container registry.
- Optionaloptions: RegistriesImportImageOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/registries.ts:99

beginUpdate

beginUpdate(resourceGroupName, registryName, registryUpdateParameters, options?): Promise<SimplePollerLike<OperationState<Registry>, Registry>>
Updates a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- registryUpdateParameters: RegistryUpdateParameters
  The parameters for updating a container registry.
- Optionaloptions: RegistriesUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Registry>, Registry>>
- Defined in operationsInterfaces/registries.ts:186

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, registryName, registryUpdateParameters, options?): Promise<Registry>
Updates a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- registryUpdateParameters: RegistryUpdateParameters
  The parameters for updating a container registry.
- Optionaloptions: RegistriesUpdateOptionalParams
  The options parameters.
Returns Promise<Registry>
- Defined in operationsInterfaces/registries.ts:204

checkNameAvailability

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

get

get(resourceGroupName, registryName, options?): Promise<Registry>
Gets the properties of the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesGetOptionalParams
  The options parameters.
Returns Promise<Registry>
- Defined in operationsInterfaces/registries.ts:121

getBuildSourceUploadUrl

getBuildSourceUploadUrl(resourceGroupName, registryName, options?): 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.
- Optionaloptions: RegistriesGetBuildSourceUploadUrlOptionalParams
  The options parameters.
Returns Promise<SourceUploadDefinition>
- Defined in operationsInterfaces/registries.ts:309

getPrivateLinkResource

getPrivateLinkResource(resourceGroupName, registryName, groupName, options?): 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. The name is case insensitive.
- registryName: string
  The name of the container registry.
- groupName: string
  The name of the private link resource.
- Optionaloptions: RegistriesGetPrivateLinkResourceOptionalParams
  The options parameters.
Returns Promise<PrivateLinkResource>
- Defined in operationsInterfaces/registries.ts:228

list

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

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<Registry>
Lists all the container registries under the specified resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optionaloptions: RegistriesListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Registry>
- Defined in operationsInterfaces/registries.ts:64

listCredentials

listCredentials(resourceGroupName, registryName, options?): Promise<RegistryListCredentialsResult>
Lists the login credentials for the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesListCredentialsOptionalParams
  The options parameters.
Returns Promise<RegistryListCredentialsResult>
- Defined in operationsInterfaces/registries.ts:240

listPrivateLinkResources

listPrivateLinkResources(resourceGroupName, registryName, options?): PagedAsyncIterableIterator<PrivateLinkResource>
Lists the private link resources for a container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesListPrivateLinkResourcesOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<PrivateLinkResource>
- Defined in operationsInterfaces/registries.ts:74

listUsages

listUsages(resourceGroupName, registryName, options?): Promise<RegistryUsageListResult>
Gets the quota usages for the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- Optionaloptions: RegistriesListUsagesOptionalParams
  The options parameters.
Returns Promise<RegistryUsageListResult>
- Defined in operationsInterfaces/registries.ts:216

regenerateCredential

regenerateCredential(resourceGroupName, registryName, regenerateCredentialParameters, options?): Promise<RegistryListCredentialsResult>
Regenerates one of the login credentials for the specified container registry.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- regenerateCredentialParameters: RegenerateCredentialParameters
  Specifies name of the password which should be regenerated -- password or password2.
- Optionaloptions: RegistriesRegenerateCredentialOptionalParams
  The options parameters.
Returns Promise<RegistryListCredentialsResult>
- Defined in operationsInterfaces/registries.ts:253

scheduleRun

scheduleRun(resourceGroupName, registryName, runRequest, options?): 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.
- Optionaloptions: RegistriesScheduleRunOptionalParams
  The options parameters.
Returns Promise<Run>
- Defined in operationsInterfaces/registries.ts:297

Interface Registries

Index

Methods

Methods

beginCreate

Parameters

Returns Promise<SimplePollerLike<OperationState<Registry>, Registry>>

beginCreateAndWait

Parameters

Returns Promise<Registry>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

Returns Promise<void>

beginGenerateCredentials

Parameters

Returns Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>

beginGenerateCredentialsAndWait

Parameters

Returns Promise<GenerateCredentialsResult>

beginImportImage

Parameters

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginImportImageAndWait

Parameters

Returns Promise<void>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<Registry>, Registry>>

beginUpdateAndWait

Parameters

Returns Promise<Registry>

checkNameAvailability

Parameters

Returns Promise<RegistryNameStatus>

get

Parameters

Returns Promise<Registry>

getBuildSourceUploadUrl

Parameters

Returns Promise<SourceUploadDefinition>

getPrivateLinkResource

Parameters

Returns Promise<PrivateLinkResource>

list

Parameters

Returns PagedAsyncIterableIterator<Registry>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<Registry>

listCredentials

Parameters

Returns Promise<RegistryListCredentialsResult>

listPrivateLinkResources

Parameters

Returns PagedAsyncIterableIterator<PrivateLinkResource>

listUsages

Parameters

Returns Promise<RegistryUsageListResult>

regenerateCredential

Parameters

Returns Promise<RegistryListCredentialsResult>

scheduleRun

Parameters

Returns Promise<Run>

Settings