ManagementRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des api REST VSS

Extends

RestClientBase

Constructeurs

ManagementRestClient(IVssRestClientOptions)

Méthodes

createBillingSnapshot(MeterUsage)	Lors du calcul de facturation multi-organisation dans l’unité d’échelle principale (EUS21), cette API est utilisée pour créer des instantané de facturation pour une organisation spécifique. L’unité d’échelle principale appelle cette API pour chaque organisation dans différentes unités d’échelle pour créer des instantané de facturation. Les données seront stockées dans la base de données de partition spécifique à l’organisation -> facturation instantané table. Cela est nécessaire, car les clients récupèrent les données de facturation de leur base de données de partition spécifique à l’organisation.
deleteBillingInfo(string)	Supprimez les informations de facturation d’un organization.
deleteMeterUsageHistory(string)	Supprimez l’historique d’utilisation des compteurs de l’unité de service principale pour une organization.
getBillableCommitterDetails(Date)	Obtenez tous les détails des commiteurs facturables, y compris ceux qui ne sont pas mis en correspondance avec un VSID.
getBillingInfo(string)	Obtenez les informations de facturation d’un organization.
getEstimatedOrgBillablePushers()	Estimez les commiters qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour cette organization.
getEstimatedProjectBillablePushers(string)	Estimez le nombre de commiters qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour ce projet.
getEstimatedRepoBillableCommitters(string, string)	Estimez les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour ce dépôt.
getLastMeterUsage()
getMeterUsage(Date)	Obtenez les commiteurs utilisés lors du calcul des informations de facturation.
getOrgEnablementStatus(boolean)	Obtenir la status actuelle de la sécurité avancée pour le organization
getProjectEnablementStatus(string, boolean)	Obtenir les status actuelles de la sécurité avancée pour un projet
getRepoEnablementStatus(string, string, boolean)	Déterminer si la sécurité avancée est activée pour un dépôt
saveBillingInfo(BillingInfo, string)	Enregistrez les informations de facturation d’un organization.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Mettre à jour le status de la sécurité avancée pour le organization
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Mettre à jour le status de la sécurité avancée pour le projet
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Mettre à jour l’activation d’Advanced Security pour un dépôt

Détails du constructeur

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la méthode

createBillingSnapshot(MeterUsage)

Lors du calcul de facturation multi-organisation dans l’unité d’échelle principale (EUS21), cette API est utilisée pour créer des instantané de facturation pour une organisation spécifique. L’unité d’échelle principale appelle cette API pour chaque organisation dans différentes unités d’échelle pour créer des instantané de facturation. Les données seront stockées dans la base de données de partition spécifique à l’organisation -> facturation instantané table. Cela est nécessaire, car les clients récupèrent les données de facturation de leur base de données de partition spécifique à l’organisation.

function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

Paramètres

meterUsage

MeterUsage

Retours

Promise<void>

deleteBillingInfo(string)

Supprimez les informations de facturation d’un organization.

function deleteBillingInfo(organizationId: string): Promise<void>

Paramètres

organizationId

string

Retours

Promise<void>

deleteMeterUsageHistory(string)

Supprimez l’historique d’utilisation des compteurs de l’unité de service principale pour une organization.

function deleteMeterUsageHistory(organizationId: string): Promise<void>

Paramètres

organizationId

string

Retours

Promise<void>

getBillableCommitterDetails(Date)

Obtenez tous les détails des commiteurs facturables, y compris ceux qui ne sont pas mis en correspondance avec un VSID.

function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>

Paramètres

billingDate

Date

Date d’interrogation, ou si elle n’est pas fournie, aujourd’hui

Retours

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Obtenez les informations de facturation d’un organization.

function getBillingInfo(organizationId: string): Promise<BillingInfo>

Paramètres

organizationId

string

ID d’organisation pour lequel obtenir des informations de facturation.

Retours

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Estimez les commiters qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour cette organization.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Retours

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Estimez le nombre de commiters qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour ce projet.

function getEstimatedProjectBillablePushers(project: string): Promise<string[]>

Paramètres

project

string

ID de projet ou nom du projet

Retours

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Estimez les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security était activé pour ce dépôt.

function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du dépôt

Retours

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Retours

Promise<MeterUsage>

getMeterUsage(Date)

Obtenez les commiteurs utilisés lors du calcul des informations de facturation.

function getMeterUsage(billingDate?: Date): Promise<MeterUsage>

Paramètres

billingDate

Date

Date d’interrogation, ou si elle n’est pas fournie, aujourd’hui

Retours

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Obtenir la status actuelle de la sécurité avancée pour le organization

function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Paramètres

includeAllProperties

boolean

Quand la valeur est true, déterminez également si les envois sont bloqués s’ils contiennent des secrets

Retours

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Obtenir les status actuelles de la sécurité avancée pour un projet

function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Paramètres

project

string

ID de projet ou nom du projet

includeAllProperties

boolean

Quand la valeur est true, déterminez également si les envois sont bloqués s’ils contiennent des secrets

Retours

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Déterminer si la sécurité avancée est activée pour un dépôt

function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>

Paramètres

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du dépôt

includeAllProperties

boolean

Lorsque la valeur est true, détermine également si les envois sont bloqués lorsque des secrets sont détectés

Retours

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Enregistrez les informations de facturation d’un organization.

function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>

Paramètres

billingInfo

BillingInfo

organizationId

string

Retours

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Mettre à jour le status de la sécurité avancée pour le organization

function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>

Paramètres

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

La nouvelle status

Retours

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Mettre à jour le status de la sécurité avancée pour le projet

function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>

Paramètres

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

La nouvelle status

project

string

ID de projet ou nom du projet

Retours

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Mettre à jour l’activation d’Advanced Security pour un dépôt

function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>

Paramètres

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nouvelles status

project

string

ID de projet ou nom du projet

repository

string

Nom ou ID du dépôt

Retours

Promise<void>