Partilhar via

ExtensionManagementRestClient class

  • Referência
Pacote:
azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends
RestClientBase

Construtores

ExtensionManagementRestClient(IVssRestClientOptions)

Propriedades

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 é chamada pela página de aquisição/instalação para obter possíveis ações de utilizador, como Comprar/Pedir
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])

Obtenha uma extensão instalada pelo respetivo editor e nome da extensão.
getInstalledExtensions(boolean, boolean, string[], boolean)

Liste as extensões instaladas na conta/coleção de projetos.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)

Liste informações de estado e versão para todas as extensões instaladas.
getToken()
installExtensionByName(string, string, string)

Instale a extensão especificada na conta/coleção de projetos.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Consulte uma ou mais coleções de dados para a extensão especificada. Nota: o token utilizado para autorização tem de ter sido emitido em nome da extensão 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 a extensão especificada da conta/coleção de projetos.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)

Atualizar uma extensão instalada. Normalmente, esta API é utilizada para ativar ou desativar uma extensão.

Detalhes do Construtor

ExtensionManagementRestClient(IVssRestClientOptions) 

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parâmetros

options
IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de 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

Devoluções

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

Devoluções

Promise<void>

deleteRequest(string, string) 

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

Parâmetros

publisherName

string

extensionName

string

Devoluções

Promise<void>

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

Esta API é chamada pela página de aquisição/instalação para obter possíveis ações de utilizador, como Comprar/Pedir

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

Parâmetros

itemId

string

Nome completamente qualificado da extensão (<publisher_id>.<>extension_id)

testCommerce

boolean

Parâmetro para testar a extensão de pré-visualização paga sem tornar os planos do Azure públicos

isFreeOrTrialInstall

boolean

O parâmetro representa o fluxo de trabalho de instalação ou avaliação (necessário para fluxos de instalação legados)

isAccountOwner

boolean

O parâmetro representa se o utilizador é proprietário ou PCA de uma conta

isLinked

boolean

O parâmetro representa se a conta está ligada a uma subscrição

isConnectedServer

boolean

O parâmetro representa se a operação Comprar deve ser avaliada

isBuyOperationValid

boolean

Devoluções

Promise<AcquisitionOptions>

getAuditLog(string, string) 

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

Parâmetros

publisherName

string

extensionName

string

Devoluções

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

Devoluções

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

Devoluções

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Obtenha uma extensão instalada pelo respetivo editor e nome da extensão.

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

Parâmetros

publisherName

string

Nome do publicador. Exemplo: "fabrikam".

extensionName

string

Nome da extensão. Exemplo: "ops-tools".

assetTypes

string[]

Determina que ficheiros são devolvidos na matriz de ficheiros. Forneça o caráter universal "*" para devolver todos os ficheiros ou uma lista separada por dois pontos para obter ficheiros com tipos de recursos específicos.

Devoluções

Promise<InstalledExtension>

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

Liste as extensões instaladas na conta/coleção de projetos.

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

Parâmetros

includeDisabledExtensions

boolean

Se for verdadeiro (a predefinição), inclua extensões desativadas nos resultados.

includeErrors

boolean

Se for verdade, inclua extensões instaladas com erros.

assetTypes

string[]

Determina que ficheiros são devolvidos na matriz de ficheiros. Forneça o caráter universal "*" para devolver todos os ficheiros ou uma lista separada por dois pontos para obter ficheiros com tipos de recursos específicos.

includeInstallationIssues

boolean

Devoluções

Promise<InstalledExtension[]>

getPolicies(string) 

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

Parâmetros

userId

string

Devoluções

Promise<UserExtensionPolicy>

getRequests() 

function getRequests(): Promise<RequestedExtension[]>

Devoluções

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Liste informações de estado e versão para todas as extensões instaladas.

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

Parâmetros

includeDisabled

boolean

Se for verdadeiro (a predefinição), inclua extensões desativadas nos resultados.

includeErrors

boolean

Se for verdade, inclua extensões instaladas num estado de erro nos resultados.

includeInstallationIssues

boolean

forceRefresh

boolean

Devoluções

Promise<ExtensionState[]>

getToken() 

function getToken(): Promise<string>

Devoluções

Promise<string>

installExtensionByName(string, string, string)

Instale a extensão especificada na conta/coleção de projetos.

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

Parâmetros

publisherName

string

Nome do publicador. Exemplo: "fabrikam".

extensionName

string

Nome da extensão. Exemplo: "ops-tools".

version

string

Devoluções

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Consulte uma ou mais coleções de dados para a extensão especificada. Nota: o token utilizado para autorização tem de ter sido emitido em nome da extensão especificada.

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

Parâmetros

collectionQuery
ExtensionDataCollectionQuery
publisherName

string

Nome do publicador. Exemplo: "fabrikam".

extensionName

string

Nome da extensão. Exemplo: "ops-tools".

Devoluções

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery) 

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

Parâmetros

query
InstalledExtensionQuery

Devoluções

Promise<InstalledExtension[]>

registerAuthorization(string, string, string) 

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

Parâmetros

publisherName

string

extensionName

string

registrationId

string

Devoluções

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest) 

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

Parâmetros

acquisitionRequest
ExtensionAcquisitionRequest

Devoluções

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string) 

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

Parâmetros

publisherName

string

extensionName

string

requestMessage

string

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Promise<any>

uninstallExtensionByName(string, string, string, string)

Desinstale a extensão especificada da conta/coleção de projetos.

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

Parâmetros

publisherName

string

Nome do publicador. Exemplo: "fabrikam".

extensionName

string

Nome da extensão. Exemplo: "ops-tools".

reason

string

reasonCode

string

Devoluções

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

Devoluções

Promise<any>

updateInstalledExtension(InstalledExtension)

Atualizar uma extensão instalada. Normalmente, esta API é utilizada para ativar ou desativar uma extensão.

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

Parâmetros

extension
InstalledExtension

Devoluções

Promise<InstalledExtension>