ExtensionManagementRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

ExtensionManagementRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createDocumentByName(any, string, string, string, string, string)
deleteDocumentByName(string, string, string, string, string, string)
deleteRequest(string, string)
getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)	Esta API es llamada por la página de adquisición/instalación para obtener posibles acciones del usuario como Comprar/Solicitar
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])	Obtenga una extensión instalada por su editor y nombre de extensión.
getInstalledExtensions(boolean, boolean, string[], boolean)	Enumere las extensiones instaladas en la colección de cuentas o proyectos.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)	Enumere la información de estado y versión de todas las extensiones instaladas.
getToken()
installExtensionByName(string, string, string)	Instale la extensión especificada en la colección de cuentas o proyectos.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)	Consulte una o varias colecciones de datos para la extensión especificada. Nota: el token utilizado para la autorización debe haberse emitido en nombre de la extensión especificada.
queryExtensions(InstalledExtensionQuery)
registerAuthorization(string, string, string)
requestAcquisition(ExtensionAcquisitionRequest)
requestExtension(string, string, string)
resolveAllRequests(string, string, string, ExtensionRequestState)
resolveRequest(string, string, string, string, ExtensionRequestState)
setDocumentByName(any, string, string, string, string, string)
uninstallExtensionByName(string, string, string, string)	Desinstale la extensión especificada de la colección de cuentas o proyectos.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)	Actualizar una extensión instalada. Normalmente, esta API se usa para habilitar o deshabilitar una extensión.

Detalles del constructor

ExtensionManagementRestClient(IVssRestClientOptions)

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createDocumentByName(any, string, string, string, string, string)

function createDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parámetros

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Devoluciones

Promise<any>

deleteDocumentByName(string, string, string, string, string, string)

function deleteDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<void>

Parámetros

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Devoluciones

Promise<void>

deleteRequest(string, string)

function deleteRequest(publisherName: string, extensionName: string): Promise<void>

Parámetros

publisherName

string

extensionName

string

Devoluciones

Promise<void>

getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)

Esta API es llamada por la página de adquisición/instalación para obtener posibles acciones del usuario como Comprar/Solicitar

function getAcquisitionOptions(itemId: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean, isAccountOwner?: boolean, isLinked?: boolean, isConnectedServer?: boolean, isBuyOperationValid?: boolean): Promise<AcquisitionOptions>

Parámetros

itemId

string

Nombre completo de la extensión (<publisher_id>.<extension_id>)

testCommerce

boolean

Parámetro para probar la extensión de versión preliminar de pago sin hacer públicos los planes de Azure

isFreeOrTrialInstall

boolean

El parámetro representa el flujo de trabajo de instalación o prueba (necesario para los flujos de instalación heredados)

isAccountOwner

boolean

El parámetro representa si el usuario es propietario o PCA de una cuenta

isLinked

boolean

El parámetro representa si la cuenta está vinculada a una suscripción

isConnectedServer

boolean

El parámetro representa si se debe evaluar la operación Buy

isBuyOperationValid

boolean

Devoluciones

Promise<AcquisitionOptions>

getAuditLog(string, string)

function getAuditLog(publisherName: string, extensionName: string): Promise<ExtensionAuditLog>

Parámetros

publisherName

string

extensionName

string

Devoluciones

Promise<ExtensionAuditLog>

getDocumentByName(string, string, string, string, string, string)

function getDocumentByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string, documentId: string): Promise<any>

Parámetros

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Devoluciones

Promise<any>

getDocumentsByName(string, string, string, string, string)

function getDocumentsByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any[]>

Parámetros

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Devoluciones

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Obtenga una extensión instalada por su editor y nombre de extensión.

function getInstalledExtensionByName(publisherName: string, extensionName: string, assetTypes?: string[]): Promise<InstalledExtension>

Parámetros

publisherName

string

Nombre del editor. Ejemplo: "fabrikam".

extensionName

string

Nombre de la extensión. Ejemplo: "ops-tools".

assetTypes

string[]

Determina qué archivos se devuelven en la matriz de archivos. Proporcione el comodín '*' para devolver todos los archivos, o una lista separada por dos puntos para recuperar archivos con tipos de activos específicos.

Devoluciones

Promise<InstalledExtension>

getInstalledExtensions(boolean, boolean, string[], boolean)

Enumere las extensiones instaladas en la colección de cuentas o proyectos.

function getInstalledExtensions(includeDisabledExtensions?: boolean, includeErrors?: boolean, assetTypes?: string[], includeInstallationIssues?: boolean): Promise<InstalledExtension[]>

Parámetros

includeDisabledExtensions

boolean

Si es true (el valor predeterminado), incluya extensiones deshabilitadas en los resultados.

includeErrors

boolean

Si es true, incluya las extensiones instaladas con errores.

assetTypes

string[]

Determina qué archivos se devuelven en la matriz de archivos. Proporcione el comodín '*' para devolver todos los archivos, o una lista separada por dos puntos para recuperar archivos con tipos de activos específicos.

includeInstallationIssues

boolean

Devoluciones

Promise<InstalledExtension[]>

getPolicies(string)

function getPolicies(userId: string): Promise<UserExtensionPolicy>

Parámetros

userId

string

Devoluciones

Promise<UserExtensionPolicy>

getRequests()

function getRequests(): Promise<RequestedExtension[]>

Devoluciones

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Enumere la información de estado y versión de todas las extensiones instaladas.

function getStates(includeDisabled?: boolean, includeErrors?: boolean, includeInstallationIssues?: boolean, forceRefresh?: boolean): Promise<ExtensionState[]>

Parámetros

includeDisabled

boolean

Si es true (el valor predeterminado), incluya extensiones deshabilitadas en los resultados.

includeErrors

boolean

Si es true, incluya las extensiones instaladas en un estado de error en los resultados.

includeInstallationIssues

boolean

forceRefresh

boolean

Devoluciones

Promise<ExtensionState[]>

getToken()

function getToken(): Promise<string>

Devoluciones

Promise<string>

installExtensionByName(string, string, string)

Instale la extensión especificada en la colección de cuentas o proyectos.

function installExtensionByName(publisherName: string, extensionName: string, version?: string): Promise<InstalledExtension>

Parámetros

publisherName

string

Nombre del editor. Ejemplo: "fabrikam".

extensionName

string

Nombre de la extensión. Ejemplo: "ops-tools".

version

string

Devoluciones

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Consulte una o varias colecciones de datos para la extensión especificada. Nota: el token utilizado para la autorización debe haberse emitido en nombre de la extensión especificada.

function queryCollectionsByName(collectionQuery: ExtensionDataCollectionQuery, publisherName: string, extensionName: string): Promise<ExtensionDataCollection[]>

Parámetros

collectionQuery

ExtensionDataCollectionQuery

publisherName

string

Nombre del editor. Ejemplo: "fabrikam".

extensionName

string

Nombre de la extensión. Ejemplo: "ops-tools".

Devoluciones

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery)

function queryExtensions(query: InstalledExtensionQuery): Promise<InstalledExtension[]>

Parámetros

query

InstalledExtensionQuery

Devoluciones

Promise<InstalledExtension[]>

registerAuthorization(string, string, string)

function registerAuthorization(publisherName: string, extensionName: string, registrationId: string): Promise<ExtensionAuthorization>

Parámetros

publisherName

string

extensionName

string

registrationId

string

Devoluciones

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest)

function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>

Parámetros

acquisitionRequest

ExtensionAcquisitionRequest

Devoluciones

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string)

function requestExtension(publisherName: string, extensionName: string, requestMessage: string): Promise<RequestedExtension>

Parámetros

publisherName

string

extensionName

string

requestMessage

string

Devoluciones

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState)

function resolveAllRequests(rejectMessage: string, publisherName: string, extensionName: string, state: ExtensionRequestState): Promise<number>

Parámetros

rejectMessage

string

publisherName

string

extensionName

string

state

ExtensionRequestState

Devoluciones

Promise<number>

resolveRequest(string, string, string, string, ExtensionRequestState)

function resolveRequest(rejectMessage: string, publisherName: string, extensionName: string, requesterId: string, state: ExtensionRequestState): Promise<number>

Parámetros

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state

ExtensionRequestState

Devoluciones

Promise<number>

setDocumentByName(any, string, string, string, string, string)

function setDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parámetros

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Devoluciones

Promise<any>

uninstallExtensionByName(string, string, string, string)

Desinstale la extensión especificada de la colección de cuentas o proyectos.

function uninstallExtensionByName(publisherName: string, extensionName: string, reason?: string, reasonCode?: string): Promise<void>

Parámetros

publisherName

string

Nombre del editor. Ejemplo: "fabrikam".

extensionName

string

Nombre de la extensión. Ejemplo: "ops-tools".

reason

string

reasonCode

string

Devoluciones

Promise<void>

updateDocumentByName(any, string, string, string, string, string)

function updateDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>

Parámetros

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Devoluciones

Promise<any>

updateInstalledExtension(InstalledExtension)

Actualizar una extensión instalada. Normalmente, esta API se usa para habilitar o deshabilitar una extensión.

function updateInstalledExtension(extension: InstalledExtension): Promise<InstalledExtension>

Parámetros

extension

InstalledExtension

Devoluciones

Promise<InstalledExtension>