Dela via

ExtensionManagementRestClient class

Paket:
azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST-API:er

Extends
RestClientBase

Konstruktorer

ExtensionManagementRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

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)

Det här API:et anropas av förvärvs-/installationssidan för att hämta möjliga användaråtgärder som köp/begäran
getAuditLog(string, string)
getDocumentByName(string, string, string, string, string, string)
getDocumentsByName(string, string, string, string, string)
getInstalledExtensionByName(string, string, string[])

Hämta ett installerat tillägg efter dess utgivare och tilläggsnamn.
getInstalledExtensions(boolean, boolean, string[], boolean)

Visa en lista över installerade tillägg i konto-/projektsamlingen.
getPolicies(string)
getRequests()
getStates(boolean, boolean, boolean, boolean)

Visa en lista över tillstånds- och versionsinformation för alla installerade tillägg.
getToken()
installExtensionByName(string, string, string)

Installera det angivna tillägget i konto-/projektsamlingen.
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Fråga efter en eller flera datainsamlingar för det angivna tillägget. Den token som används för auktorisering måste ha utfärdats för det angivna tilläggets räkning.
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)

Avinstallera det angivna tillägget från konto-/projektsamlingen.
updateDocumentByName(any, string, string, string, string, string)
updateInstalledExtension(InstalledExtension)

Uppdatera ett installerat tillägg. Vanligtvis används det här API:et för att aktivera eller inaktivera ett tillägg.

Konstruktorinformation

ExtensionManagementRestClient(IVssRestClientOptions) 

new ExtensionManagementRestClient(options: IVssRestClientOptions)

Parametrar

options
IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

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

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

Parametrar

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Returer

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>

Parametrar

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Returer

Promise<void>

deleteRequest(string, string) 

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

Parametrar

publisherName

string

extensionName

string

Returer

Promise<void>

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

Det här API:et anropas av förvärvs-/installationssidan för att hämta möjliga användaråtgärder som köp/begäran

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

Parametrar

itemId

string

Fullständigt kvalificerat namn på tillägget (<publisher_id>.<extension_id>)

testCommerce

boolean

Parameter för att testa tillägget för betald förhandsversion utan att göra Azure-planer offentliga

isFreeOrTrialInstall

boolean

Parametern representerar arbetsflödet för installation eller utvärderingsversion (krävs för äldre installationsflöden)

isAccountOwner

boolean

Parametern representerar om användaren är ägare eller PCA för ett konto

isLinked

boolean

Parametern representerar om kontot är länkat till en prenumeration

isConnectedServer

boolean

Parametern representerar om köpåtgärden ska utvärderas

isBuyOperationValid

boolean

Returer

Promise<AcquisitionOptions>

getAuditLog(string, string) 

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

Parametrar

publisherName

string

extensionName

string

Returer

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>

Parametrar

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

documentId

string

Returer

Promise<any>

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

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

Parametrar

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Returer

Promise<any[]>

getInstalledExtensionByName(string, string, string[])

Hämta ett installerat tillägg efter dess utgivare och tilläggsnamn.

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

Parametrar

publisherName

string

Utgivarens namn. Exempel: "fabrikam".

extensionName

string

Namnet på tillägget. Exempel: "ops-tools".

assetTypes

string[]

Avgör vilka filer som returneras i matrisen files. Ange jokertecknet "*" för att returnera alla filer, eller en kolonavgränsad lista för att hämta filer med specifika tillgångstyper.

Returer

Promise<InstalledExtension>

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

Visa en lista över installerade tillägg i konto-/projektsamlingen.

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

Parametrar

includeDisabledExtensions

boolean

Om värdet är true (standard) inkluderar du inaktiverade tillägg i resultatet.

includeErrors

boolean

Om det är sant inkluderar du installerade tillägg med fel.

assetTypes

string[]

Avgör vilka filer som returneras i matrisen files. Ange jokertecknet "*" för att returnera alla filer, eller en kolonavgränsad lista för att hämta filer med specifika tillgångstyper.

includeInstallationIssues

boolean

Returer

Promise<InstalledExtension[]>

getPolicies(string) 

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

Parametrar

userId

string

Returer

Promise<UserExtensionPolicy>

getRequests() 

function getRequests(): Promise<RequestedExtension[]>

Returer

Promise<RequestedExtension[]>

getStates(boolean, boolean, boolean, boolean)

Visa en lista över tillstånds- och versionsinformation för alla installerade tillägg.

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

Parametrar

includeDisabled

boolean

Om värdet är true (standard) inkluderar du inaktiverade tillägg i resultatet.

includeErrors

boolean

Om det är sant inkluderar du installerade tillägg i ett feltillstånd i resultatet.

includeInstallationIssues

boolean

forceRefresh

boolean

Returer

Promise<ExtensionState[]>

getToken() 

function getToken(): Promise<string>

Returer

Promise<string>

installExtensionByName(string, string, string)

Installera det angivna tillägget i konto-/projektsamlingen.

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

Parametrar

publisherName

string

Utgivarens namn. Exempel: "fabrikam".

extensionName

string

Namnet på tillägget. Exempel: "ops-tools".

version

string

Returer

Promise<InstalledExtension>

queryCollectionsByName(ExtensionDataCollectionQuery, string, string)

Fråga efter en eller flera datainsamlingar för det angivna tillägget. Den token som används för auktorisering måste ha utfärdats för det angivna tilläggets räkning.

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

Parametrar

collectionQuery
ExtensionDataCollectionQuery
publisherName

string

Utgivarens namn. Exempel: "fabrikam".

extensionName

string

Namnet på tillägget. Exempel: "ops-tools".

Returer

Promise<ExtensionDataCollection[]>

queryExtensions(InstalledExtensionQuery) 

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

Parametrar

query
InstalledExtensionQuery

Returer

Promise<InstalledExtension[]>

registerAuthorization(string, string, string) 

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

Parametrar

publisherName

string

extensionName

string

registrationId

string

Returer

Promise<ExtensionAuthorization>

requestAcquisition(ExtensionAcquisitionRequest) 

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

Parametrar

acquisitionRequest
ExtensionAcquisitionRequest

Returer

Promise<ExtensionAcquisitionRequest>

requestExtension(string, string, string) 

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

Parametrar

publisherName

string

extensionName

string

requestMessage

string

Returer

Promise<RequestedExtension>

resolveAllRequests(string, string, string, ExtensionRequestState) 

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

Parametrar

rejectMessage

string

publisherName

string

extensionName

string

state
ExtensionRequestState

Returer

Promise<number>

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

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

Parametrar

rejectMessage

string

publisherName

string

extensionName

string

requesterId

string

state
ExtensionRequestState

Returer

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>

Parametrar

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Returer

Promise<any>

uninstallExtensionByName(string, string, string, string)

Avinstallera det angivna tillägget från konto-/projektsamlingen.

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

Parametrar

publisherName

string

Utgivarens namn. Exempel: "fabrikam".

extensionName

string

Namnet på tillägget. Exempel: "ops-tools".

reason

string

reasonCode

string

Returer

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>

Parametrar

doc

any

publisherName

string

extensionName

string

scopeType

string

scopeValue

string

collectionName

string

Returer

Promise<any>

updateInstalledExtension(InstalledExtension)

Uppdatera ett installerat tillägg. Vanligtvis används det här API:et för att aktivera eller inaktivera ett tillägg.

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

Parametrar

extension
InstalledExtension

Returer

Promise<InstalledExtension>