Class ExtensionManagementApi

constructor

• new ExtensionManagementApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): ExtensionManagementApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns ExtensionManagementApi

Static ReadonlyRESOURCE_AREA_ID

createDocumentByName

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

  Parameters

  • doc: any
  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string

  Returns Promise<any>

deleteDocumentByName

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

  Parameters

  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string
  • documentId: string

  Returns Promise<void>

deleteRequest

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

  Parameters

  • publisherName: string
  • extensionName: string

  Returns Promise<void>

getAcquisitionOptions

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

  This API is called by acquisition/install page to get possible user actions like Buy/Request

  Parameters

  • itemId: string

    Fully qualified name of extension (<publisher_id>.<extension_id>)
  • OptionaltestCommerce: boolean

    Parameter to test paid preview extension without making azure plans public
  • OptionalisFreeOrTrialInstall: boolean

    Parameter represents install or trial workflow (required for legacy install flows)
  • OptionalisAccountOwner: boolean

    Parameter represents whether user is owner or PCA of an account
  • OptionalisLinked: boolean

    Parameter represents whether account is linked with a subscription
  • OptionalisConnectedServer: boolean

    Parameter represents whether Buy operation should be evaluated
  • OptionalisBuyOperationValid: boolean

  Returns Promise<AcquisitionOptions>

getAuditLog

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

  Parameters

  • publisherName: string
  • extensionName: string

  Returns Promise<ExtensionAuditLog>

getDocumentByName

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

  Parameters

  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string
  • documentId: string

  Returns Promise<any>

getDocumentsByName

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

  Parameters

  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string

  Returns Promise<any[]>

getInstalledExtensionByName

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

  Get an installed extension by its publisher and extension name.

  Parameters

  • publisherName: string

    Name of the publisher. Example: "fabrikam".
  • extensionName: string

    Name of the extension. Example: "ops-tools".
  • OptionalassetTypes: string[]

    Determines which files are returned in the files array. Provide the wildcard '*' to return all files, or a colon separated list to retrieve files with specific asset types.

  Returns Promise<InstalledExtension>

getInstalledExtensions

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

  List the installed extensions in the account / project collection.

  Parameters

  • OptionalincludeDisabledExtensions: boolean

    If true (the default), include disabled extensions in the results.
  • OptionalincludeErrors: boolean

    If true, include installed extensions with errors.
  • OptionalassetTypes: string[]

    Determines which files are returned in the files array. Provide the wildcard '*' to return all files, or a colon separated list to retrieve files with specific asset types.
  • OptionalincludeInstallationIssues: boolean

  Returns Promise<InstalledExtension[]>

getPolicies

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

  Parameters

  • userId: string

  Returns Promise<UserExtensionPolicy>

getRequests

• getRequests(): Promise<RequestedExtension[]>

  Returns Promise<RequestedExtension[]>

getStates

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

  List state and version information for all installed extensions.

  Parameters

  • OptionalincludeDisabled: boolean

    If true (the default), include disabled extensions in the results.
  • OptionalincludeErrors: boolean

    If true, include installed extensions in an error state in the results.
  • OptionalincludeInstallationIssues: boolean
  • OptionalforceRefresh: boolean

  Returns Promise<ExtensionState[]>

getToken

• getToken(): Promise<string>

  Returns Promise<string>

installExtensionByName

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

  Install the specified extension into the account / project collection.

  Parameters

  • publisherName: string

    Name of the publisher. Example: "fabrikam".
  • extensionName: string

    Name of the extension. Example: "ops-tools".
  • Optionalversion: string

  Returns Promise<InstalledExtension>

queryCollectionsByName

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

  Query for one or more data collections for the specified extension. Note: the token used for authorization must have been issued on behalf of the specified extension.

  Parameters

  • collectionQuery: ExtensionDataCollectionQuery
  • publisherName: string

    Name of the publisher. Example: "fabrikam".
  • extensionName: string

    Name of the extension. Example: "ops-tools".

  Returns Promise<ExtensionDataCollection[]>

queryExtensions

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

  Parameters

  • query: InstalledExtensionQuery

  Returns Promise<InstalledExtension[]>

registerAuthorization

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

  Parameters

  • publisherName: string
  • extensionName: string
  • registrationId: string

  Returns Promise<ExtensionAuthorization>

requestAcquisition

• requestAcquisition(
      acquisitionRequest: ExtensionAcquisitionRequest,
  ): Promise<ExtensionAcquisitionRequest>

  Parameters

  • acquisitionRequest: ExtensionAcquisitionRequest

  Returns Promise<ExtensionAcquisitionRequest>

requestExtension

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

  Parameters

  • publisherName: string
  • extensionName: string
  • requestMessage: string

  Returns Promise<RequestedExtension>

resolveAllRequests

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

  Parameters

  • rejectMessage: string
  • publisherName: string
  • extensionName: string
  • state: ExtensionRequestState

  Returns Promise<number>

resolveRequest

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

  Parameters

  • rejectMessage: string
  • publisherName: string
  • extensionName: string
  • requesterId: string
  • state: ExtensionRequestState

  Returns Promise<number>

setDocumentByName

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

  Parameters

  • doc: any
  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string

  Returns Promise<any>

uninstallExtensionByName

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

  Uninstall the specified extension from the account / project collection.

  Parameters

  • publisherName: string

    Name of the publisher. Example: "fabrikam".
  • extensionName: string

    Name of the extension. Example: "ops-tools".
  • Optionalreason: string
  • OptionalreasonCode: string

  Returns Promise<void>

updateDocumentByName

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

  Parameters

  • doc: any
  • publisherName: string
  • extensionName: string
  • scopeType: string
  • scopeValue: string
  • collectionName: string

  Returns Promise<any>

updateInstalledExtension

• updateInstalledExtension(
      extension: InstalledExtension,
  ): Promise<InstalledExtension>

  Update an installed extension. Typically this API is used to enable or disable an extension.

  Parameters

  • extension: InstalledExtension

  Returns Promise<InstalledExtension>