Compartilhar via

ExtensionManagementRestClient class

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

Classe base que deve ser usada (derivada de) para fazer solicitações para 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)

Essa API é chamada pela página de aquisição/instalação para obter possíveis ações do usuário, como Comprar/Solicitar
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 por seu editor e nome de extensão.
getInstalledExtensions(boolean, boolean, string[], boolean)

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

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

Instale a extensão especificada na coleção account/project.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Consulte uma ou mais coleções de dados para a extensão especificada. Observação: o token usado para autorização deve 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 coleção account/project.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)

Atualizar uma extensão instalada. Normalmente, essa API é usada para habilitar ou desabilitar uma extensão.

Detalhes do construtor

ExtensionManagementRestClient(IVssRestClientOptions) 

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parâmetros

options
IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Valor da propriedade

string

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

Retornos

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

Retornos

Promise<void>

deleteRequest(string, string) 

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

Parâmetros

publisherName

string

extensionName

string

Retornos

Promise<void>

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

Essa API é chamada pela página de aquisição/instalação para obter possíveis ações do usuário, 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

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

testCommerce

boolean

Parâmetro para testar a extensão de 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 herdados)

isAccountOwner

boolean

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

isLinked

boolean

O parâmetro representa se a conta está vinculada a uma assinatura

isConnectedServer

boolean

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

isBuyOperationValid

boolean

Retornos

Promise<AcquisitionOptions>

getAuditLog(string, string) 

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

Parâmetros

publisherName

string

extensionName

string

Retornos

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

Retornos

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

Retornos

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Obtenha uma extensão instalada por seu editor e nome de extensão.

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

Parâmetros

publisherName

string

Nome do editor. Exemplo: "fabrikam".

extensionName

string

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

assetTypes

string[]

Determina quais arquivos são retornados na matriz de arquivos. Forneça o curinga '*' para retornar todos os arquivos ou uma lista separada por dois-pontos para recuperar arquivos com tipos de ativo específicos.

Retornos

Promise<InstalledExtension>

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

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

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

Parâmetros

includeDisabledExtensions

boolean

Se true (o padrão), inclua extensões desabilitadas nos resultados.

includeErrors

boolean

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

assetTypes

string[]

Determina quais arquivos são retornados na matriz de arquivos. Forneça o curinga '*' para retornar todos os arquivos ou uma lista separada por dois-pontos para recuperar arquivos com tipos de ativo específicos.

includeInstallationIssues

boolean

Retornos

Promise<InstalledExtension[]>

getPolicies(string) 

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

Parâmetros

userId

string

Retornos

Promise<UserExtensionPolicy>

getRequests() 

function getRequests(): Promise<RequestedExtension[]>

Retornos

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Listar 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 true (o padrão), inclua extensões desabilitadas nos resultados.

includeErrors

boolean

Se for true, inclua extensões instaladas em um estado de erro nos resultados.

includeInstallationIssues

boolean

forceRefresh

boolean

Retornos

Promise<ExtensionState[]>

getToken() 

function getToken(): Promise<string>

Retornos

Promise<string>

installExtensionByName(string, string, string)

Instale a extensão especificada na coleção account/project.

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

Parâmetros

publisherName

string

Nome do editor. Exemplo: "fabrikam".

extensionName

string

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

version

string

Retornos

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Consulte uma ou mais coleções de dados para a extensão especificada. Observação: o token usado para autorização deve 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 editor. Exemplo: "fabrikam".

extensionName

string

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

Retornos

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery) 

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

Parâmetros

query
InstalledExtensionQuery

Retornos

Promise<InstalledExtension[]>

registerAuthorization(string, string, string) 

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

Parâmetros

publisherName

string

extensionName

string

registrationId

string

Retornos

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest) 

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

Parâmetros

acquisitionRequest
ExtensionAcquisitionRequest

Retornos

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string) 

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

Parâmetros

publisherName

string

extensionName

string

requestMessage

string

Retornos

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

Retornos

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

Retornos

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

Retornos

Promise<any>

uninstallExtensionByName(string, string, string, string)

Desinstale a extensão especificada da coleção account/project.

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

Parâmetros

publisherName

string

Nome do editor. Exemplo: "fabrikam".

extensionName

string

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

reason

string

reasonCode

string

Retornos

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

Retornos

Promise<any>

updateInstalledExtension(InstalledExtension)

Atualizar uma extensão instalada. Normalmente, essa API é usada para habilitar ou desabilitar uma extensão.

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

Parâmetros

extension
InstalledExtension

Retornos

Promise<InstalledExtension>