Registries interface
Interface representing a Registries.
Methods
Method Details
beginCreate(string, string, Registry, RegistriesCreateOptionalParams)
Creates a container registry with the specified parameters.
function beginCreate(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>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.
- options
- RegistriesCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Registry>, Registry>>
beginCreateAndWait(string, string, Registry, RegistriesCreateOptionalParams)
Creates a container registry with the specified parameters.
function beginCreateAndWait(resourceGroupName: string, registryName: string, registry: Registry, options?: RegistriesCreateOptionalParams): Promise<Registry>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.
- options
- RegistriesCreateOptionalParams
The options parameters.
Returns
Promise<Registry>
beginDelete(string, string, RegistriesDeleteOptionalParams)
Deletes a container registry.
function beginDelete(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- options
- RegistriesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RegistriesDeleteOptionalParams)
Deletes a container registry.
function beginDeleteAndWait(resourceGroupName: string, registryName: string, options?: RegistriesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- options
- RegistriesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginGenerateCredentials(string, string, GenerateCredentialsParameters, RegistriesGenerateCredentialsOptionalParams)
Generate keys for a token of a specified container registry.
function beginGenerateCredentials(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<GenerateCredentialsResult>, GenerateCredentialsResult>>
beginGenerateCredentialsAndWait(string, string, GenerateCredentialsParameters, RegistriesGenerateCredentialsOptionalParams)
Generate keys for a token of a specified container registry.
function beginGenerateCredentialsAndWait(resourceGroupName: string, registryName: string, generateCredentialsParameters: GenerateCredentialsParameters, options?: RegistriesGenerateCredentialsOptionalParams): Promise<GenerateCredentialsResult>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.
The options parameters.
Returns
Promise<GenerateCredentialsResult>
beginImportImage(string, string, ImportImageParameters, RegistriesImportImageOptionalParams)
Copies an image to this container registry from the specified container registry.
function beginImportImage(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportImageAndWait(string, string, ImportImageParameters, RegistriesImportImageOptionalParams)
Copies an image to this container registry from the specified container registry.
function beginImportImageAndWait(resourceGroupName: string, registryName: string, parameters: ImportImageParameters, options?: RegistriesImportImageOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
beginScheduleRun(string, string, RunRequestUnion, RegistriesScheduleRunOptionalParams)
Schedules a new run based on the request parameters and add it to the run queue.
function beginScheduleRun(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<SimplePollerLike<OperationState<Run>, Run>>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.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Run>, Run>>
beginScheduleRunAndWait(string, string, RunRequestUnion, RegistriesScheduleRunOptionalParams)
Schedules a new run based on the request parameters and add it to the run queue.
function beginScheduleRunAndWait(resourceGroupName: string, registryName: string, runRequest: RunRequestUnion, options?: RegistriesScheduleRunOptionalParams): Promise<Run>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.
The options parameters.
Returns
Promise<Run>
beginUpdate(string, string, RegistryUpdateParameters, RegistriesUpdateOptionalParams)
Updates a container registry with the specified parameters.
function beginUpdate(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Registry>, Registry>>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.
- options
- RegistriesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Registry>, Registry>>
beginUpdateAndWait(string, string, RegistryUpdateParameters, RegistriesUpdateOptionalParams)
Updates a container registry with the specified parameters.
function beginUpdateAndWait(resourceGroupName: string, registryName: string, registryUpdateParameters: RegistryUpdateParameters, options?: RegistriesUpdateOptionalParams): Promise<Registry>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.
- options
- RegistriesUpdateOptionalParams
The options parameters.
Returns
Promise<Registry>
checkNameAvailability(RegistryNameCheckRequest, RegistriesCheckNameAvailabilityOptionalParams)
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.
function checkNameAvailability(registryNameCheckRequest: RegistryNameCheckRequest, options?: RegistriesCheckNameAvailabilityOptionalParams): Promise<RegistryNameStatus>Parameters
- registryNameCheckRequest
- RegistryNameCheckRequest
The object containing information for the availability request.
The options parameters.
Returns
Promise<RegistryNameStatus>
get(string, string, RegistriesGetOptionalParams)
Gets the properties of the specified container registry.
function get(resourceGroupName: string, registryName: string, options?: RegistriesGetOptionalParams): Promise<Registry>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
- options
- RegistriesGetOptionalParams
The options parameters.
Returns
Promise<Registry>
getBuildSourceUploadUrl(string, string, RegistriesGetBuildSourceUploadUrlOptionalParams)
Get the upload location for the user to be able to upload the source.
function getBuildSourceUploadUrl(resourceGroupName: string, registryName: string, options?: RegistriesGetBuildSourceUploadUrlOptionalParams): Promise<SourceUploadDefinition>Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
The options parameters.
Returns
Promise<SourceUploadDefinition>
getPrivateLinkResource(string, string, string, RegistriesGetPrivateLinkResourceOptionalParams)
Gets a private link resource by a specified group name for a container registry.
function getPrivateLinkResource(resourceGroupName: string, registryName: string, groupName: string, options?: RegistriesGetPrivateLinkResourceOptionalParams): Promise<PrivateLinkResource>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.
The options parameters.
Returns
Promise<PrivateLinkResource>
list(RegistriesListOptionalParams)
Lists all the container registries under the specified subscription.
function list(options?: RegistriesListOptionalParams): PagedAsyncIterableIterator<Registry, Registry[], PageSettings>Parameters
- options
- RegistriesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, RegistriesListByResourceGroupOptionalParams)
Lists all the container registries under the specified resource group.
function listByResourceGroup(resourceGroupName: string, options?: RegistriesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Registry, Registry[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listCredentials(string, string, RegistriesListCredentialsOptionalParams)
Lists the login credentials for the specified container registry.
function listCredentials(resourceGroupName: string, registryName: string, options?: RegistriesListCredentialsOptionalParams): Promise<RegistryListCredentialsResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
The options parameters.
Returns
Promise<RegistryListCredentialsResult>
listPrivateLinkResources(string, string, RegistriesListPrivateLinkResourcesOptionalParams)
Lists the private link resources for a container registry.
function listPrivateLinkResources(resourceGroupName: string, registryName: string, options?: RegistriesListPrivateLinkResourcesOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
The options parameters.
Returns
listUsages(string, string, RegistriesListUsagesOptionalParams)
Gets the quota usages for the specified container registry.
function listUsages(resourceGroupName: string, registryName: string, options?: RegistriesListUsagesOptionalParams): Promise<RegistryUsageListResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- registryName
-
string
The name of the container registry.
The options parameters.
Returns
Promise<RegistryUsageListResult>
regenerateCredential(string, string, RegenerateCredentialParameters, RegistriesRegenerateCredentialOptionalParams)
Regenerates one of the login credentials for the specified container registry.
function regenerateCredential(resourceGroupName: string, registryName: string, regenerateCredentialParameters: RegenerateCredentialParameters, options?: RegistriesRegenerateCredentialOptionalParams): Promise<RegistryListCredentialsResult>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.
The options parameters.
Returns
Promise<RegistryListCredentialsResult>