Package version:

Interface Archives

Interface representing a Archives.

interface Archives {
    beginCreate(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, archiveCreateParameters: Archive, options?: ArchivesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Archive>, Archive>>;
    beginCreateAndWait(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, archiveCreateParameters: Archive, options?: ArchivesCreateOptionalParams): Promise<Archive>;
    beginDelete(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, options?: ArchivesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ArchivesDeleteHeaders>, ArchivesDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, options?: ArchivesDeleteOptionalParams): Promise<ArchivesDeleteHeaders>;
    get(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, options?: ArchivesGetOptionalParams): Promise<Archive>;
    list(resourceGroupName: string, registryName: string, packageType: string, options?: ArchivesListOptionalParams): PagedAsyncIterableIterator<Archive>;
    update(resourceGroupName: string, registryName: string, packageType: string, archiveName: string, archiveUpdateParameters: ArchiveUpdateParameters, options?: ArchivesUpdateOptionalParams): Promise<Archive>;
}

Methods

beginCreate(resourceGroupName, registryName, packageType, archiveName, archiveCreateParameters, options?): Promise<SimplePollerLike<OperationState<Archive>, Archive>>
Creates a archive for 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.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- archiveCreateParameters: Archive
  The parameters for creating a archive.
- Optionaloptions: ArchivesCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Archive>, Archive>>
- Defined in operationsInterfaces/archives.ts:65

beginCreateAndWait(resourceGroupName, registryName, packageType, archiveName, archiveCreateParameters, options?): Promise<Archive>
Creates a archive for 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.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- archiveCreateParameters: Archive
  The parameters for creating a archive.
- Optionaloptions: ArchivesCreateOptionalParams
  The options parameters.
Returns Promise<Archive>
- Defined in operationsInterfaces/archives.ts:87

beginDelete(resourceGroupName, registryName, packageType, archiveName, options?): Promise<SimplePollerLike<OperationState<ArchivesDeleteHeaders>, ArchivesDeleteHeaders>>
Deletes a archive from 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.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- Optionaloptions: ArchivesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ArchivesDeleteHeaders>, ArchivesDeleteHeaders>>
- Defined in operationsInterfaces/archives.ts:103

beginDeleteAndWait(resourceGroupName, registryName, packageType, archiveName, options?): Promise<ArchivesDeleteHeaders>
Deletes a archive from 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.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- Optionaloptions: ArchivesDeleteOptionalParams
  The options parameters.
Returns Promise<ArchivesDeleteHeaders>
- Defined in operationsInterfaces/archives.ts:123

get(resourceGroupName, registryName, packageType, archiveName, options?): Promise<Archive>
Gets the properties of the archive.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- Optionaloptions: ArchivesGetOptionalParams
  The options parameters.
Returns Promise<Archive>
- Defined in operationsInterfaces/archives.ts:49

list(resourceGroupName, registryName, packageType, options?): PagedAsyncIterableIterator<Archive>
Lists all archives for the specified container registry and package type.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- registryName: string
  The name of the container registry.
- packageType: string
  The type of the package resource.
- Optionaloptions: ArchivesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<Archive>
- Defined in operationsInterfaces/archives.ts:35

update(resourceGroupName, registryName, packageType, archiveName, archiveUpdateParameters, options?): Promise<Archive>
Updates a archive for 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.
- packageType: string
  The type of the package resource.
- archiveName: string
  The name of the archive resource.
- archiveUpdateParameters: ArchiveUpdateParameters
  The parameters for updating a archive.
- Optionaloptions: ArchivesUpdateOptionalParams
  The options parameters.
Returns Promise<Archive>
- Defined in operationsInterfaces/archives.ts:139