ExtensionManagementRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Extension |
속성
| RESOURCE_AREA_ID |
메서드
생성자 세부 정보
ExtensionManagementRestClient(IVssRestClientOptions)
new ExtensionManagementRestClient(options: IVssRestClientOptions)매개 변수
- options
- IVssRestClientOptions
속성 세부 정보
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string속성 값
string
메서드 세부 정보
createDocumentByName(any, string, string, string, string, string)
function createDocumentByName(doc: any, publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any>매개 변수
- doc
-
any
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
반환
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>매개 변수
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
- documentId
-
string
반환
Promise<void>
deleteRequest(string, string)
function deleteRequest(publisherName: string, extensionName: string): Promise<void>매개 변수
- publisherName
-
string
- extensionName
-
string
반환
Promise<void>
getAcquisitionOptions(string, boolean, boolean, boolean, boolean, boolean, boolean)
이 API는 구입/요청과 같은 가능한 사용자 작업을 가져오기 위해 취득/설치 페이지에서 호출됩니다.
function getAcquisitionOptions(itemId: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean, isAccountOwner?: boolean, isLinked?: boolean, isConnectedServer?: boolean, isBuyOperationValid?: boolean): Promise<AcquisitionOptions>매개 변수
- itemId
-
string
확장의 정규화된 이름(<publisher_id>.<>extension_id)
- testCommerce
-
boolean
Azure 플랜을 공개하지 않고 유료 미리 보기 확장을 테스트하는 매개 변수
- isFreeOrTrialInstall
-
boolean
매개 변수는 설치 또는 평가판 워크플로를 나타냅니다(레거시 설치 흐름에 필요).
- isAccountOwner
-
boolean
매개 변수는 사용자가 계정의 소유자인지 PCA인지를 나타냅니다.
- isLinked
-
boolean
매개 변수는 계정이 구독과 연결되어 있는지 여부를 나타냅니다.
- isConnectedServer
-
boolean
매개 변수는 구매 작업을 평가해야 하는지 여부를 나타냅니다.
- isBuyOperationValid
-
boolean
반환
Promise<AcquisitionOptions>
getAuditLog(string, string)
function getAuditLog(publisherName: string, extensionName: string): Promise<ExtensionAuditLog>매개 변수
- publisherName
-
string
- extensionName
-
string
반환
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>매개 변수
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
- documentId
-
string
반환
Promise<any>
getDocumentsByName(string, string, string, string, string)
function getDocumentsByName(publisherName: string, extensionName: string, scopeType: string, scopeValue: string, collectionName: string): Promise<any[]>매개 변수
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
반환
Promise<any[]>
getInstalledExtensionByName(string, string, string[])
게시자 및 확장 이름으로 설치된 확장을 가져옵니다.
function getInstalledExtensionByName(publisherName: string, extensionName: string, assetTypes?: string[]): Promise<InstalledExtension>매개 변수
- publisherName
-
string
게시자의 이름입니다. 예: "fabrikam".
- extensionName
-
string
확장의 이름입니다. 예: "ops-tools".
- assetTypes
-
string[]
파일 배열에 반환되는 파일을 결정합니다. 모든 파일을 반환하려면 와일드카드 '*'를 제공하거나 콜론으로 구분된 목록을 제공하여 특정 자산 형식의 파일을 검색합니다.
반환
Promise<InstalledExtension>
getInstalledExtensions(boolean, boolean, string[], boolean)
계정/프로젝트 컬렉션에 설치된 확장을 나열합니다.
function getInstalledExtensions(includeDisabledExtensions?: boolean, includeErrors?: boolean, assetTypes?: string[], includeInstallationIssues?: boolean): Promise<InstalledExtension[]>매개 변수
- includeDisabledExtensions
-
boolean
true(기본값)인 경우 결과에 비활성화된 확장을 포함합니다.
- includeErrors
-
boolean
true이면 설치된 확장을 오류와 함께 포함합니다.
- assetTypes
-
string[]
파일 배열에 반환되는 파일을 결정합니다. 모든 파일을 반환하려면 와일드카드 '*'를 제공하거나 콜론으로 구분된 목록을 제공하여 특정 자산 형식의 파일을 검색합니다.
- includeInstallationIssues
-
boolean
반환
Promise<InstalledExtension[]>
getPolicies(string)
function getPolicies(userId: string): Promise<UserExtensionPolicy>매개 변수
- userId
-
string
반환
Promise<UserExtensionPolicy>
getRequests()
getStates(boolean, boolean, boolean, boolean)
설치된 모든 확장에 대한 상태 및 버전 정보를 나열합니다.
function getStates(includeDisabled?: boolean, includeErrors?: boolean, includeInstallationIssues?: boolean, forceRefresh?: boolean): Promise<ExtensionState[]>매개 변수
- includeDisabled
-
boolean
true(기본값)인 경우 결과에 비활성화된 확장을 포함합니다.
- includeErrors
-
boolean
true이면 설치된 확장을 결과에 오류 상태로 포함합니다.
- includeInstallationIssues
-
boolean
- forceRefresh
-
boolean
반환
Promise<ExtensionState[]>
getToken()
function getToken(): Promise<string>반환
Promise<string>
installExtensionByName(string, string, string)
계정/프로젝트 컬렉션에 지정된 확장을 설치합니다.
function installExtensionByName(publisherName: string, extensionName: string, version?: string): Promise<InstalledExtension>매개 변수
- publisherName
-
string
게시자의 이름입니다. 예: "fabrikam".
- extensionName
-
string
확장의 이름입니다. 예: "ops-tools".
- version
-
string
반환
Promise<InstalledExtension>
queryCollectionsByName(ExtensionDataCollectionQuery, string, string)
지정된 확장에 대해 하나 이상의 데이터 컬렉션을 쿼리합니다. 참고: 권한 부여에 사용되는 토큰은 지정된 확장을 대신하여 발급되어야 합니다.
function queryCollectionsByName(collectionQuery: ExtensionDataCollectionQuery, publisherName: string, extensionName: string): Promise<ExtensionDataCollection[]>매개 변수
- collectionQuery
- ExtensionDataCollectionQuery
- publisherName
-
string
게시자의 이름입니다. 예: "fabrikam".
- extensionName
-
string
확장의 이름입니다. 예: "ops-tools".
반환
Promise<ExtensionDataCollection[]>
queryExtensions(InstalledExtensionQuery)
function queryExtensions(query: InstalledExtensionQuery): Promise<InstalledExtension[]>매개 변수
- query
- InstalledExtensionQuery
반환
Promise<InstalledExtension[]>
registerAuthorization(string, string, string)
function registerAuthorization(publisherName: string, extensionName: string, registrationId: string): Promise<ExtensionAuthorization>매개 변수
- publisherName
-
string
- extensionName
-
string
- registrationId
-
string
반환
Promise<ExtensionAuthorization>
requestAcquisition(ExtensionAcquisitionRequest)
function requestAcquisition(acquisitionRequest: ExtensionAcquisitionRequest): Promise<ExtensionAcquisitionRequest>매개 변수
- acquisitionRequest
- ExtensionAcquisitionRequest
반환
Promise<ExtensionAcquisitionRequest>
requestExtension(string, string, string)
function requestExtension(publisherName: string, extensionName: string, requestMessage: string): Promise<RequestedExtension>매개 변수
- publisherName
-
string
- extensionName
-
string
- requestMessage
-
string
반환
Promise<RequestedExtension>
resolveAllRequests(string, string, string, ExtensionRequestState)
function resolveAllRequests(rejectMessage: string, publisherName: string, extensionName: string, state: ExtensionRequestState): Promise<number>매개 변수
- rejectMessage
-
string
- publisherName
-
string
- extensionName
-
string
- state
- ExtensionRequestState
반환
Promise<number>
resolveRequest(string, string, string, string, ExtensionRequestState)
function resolveRequest(rejectMessage: string, publisherName: string, extensionName: string, requesterId: string, state: ExtensionRequestState): Promise<number>매개 변수
- rejectMessage
-
string
- publisherName
-
string
- extensionName
-
string
- requesterId
-
string
- state
- ExtensionRequestState
반환
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>매개 변수
- doc
-
any
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
반환
Promise<any>
uninstallExtensionByName(string, string, string, string)
계정/프로젝트 컬렉션에서 지정된 확장을 제거합니다.
function uninstallExtensionByName(publisherName: string, extensionName: string, reason?: string, reasonCode?: string): Promise<void>매개 변수
- publisherName
-
string
게시자의 이름입니다. 예: "fabrikam".
- extensionName
-
string
확장의 이름입니다. 예: "ops-tools".
- reason
-
string
- reasonCode
-
string
반환
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>매개 변수
- doc
-
any
- publisherName
-
string
- extensionName
-
string
- scopeType
-
string
- scopeValue
-
string
- collectionName
-
string
반환
Promise<any>
updateInstalledExtension(InstalledExtension)
설치된 확장을 업데이트합니다. 일반적으로 이 API는 확장을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다.
function updateInstalledExtension(extension: InstalledExtension): Promise<InstalledExtension>매개 변수
- extension
- InstalledExtension
반환
Promise<InstalledExtension>