ManagementRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- Extends
Constructeurs
| Management |
Méthodes
| create |
Lors du calcul de la facturation multi-organisation en unité d’échelle primaire (EUS21), cette API est utilisée pour créer un instantané de facturation pour une organisation spécifique. L’unité d’échelle primaire appellera cette API pour chaque organisation dans différentes unités de scsle afin de créer un instantané de facturation. Les données seront stockées dans la table d’instantané de facturation de> la partition spécifique à l’organisation. Cela est nécessaire car les clients récupèrent les données de facturation à partir de la base de données de partition spécifique à leur organisation. |
| create |
Lors du calcul de la facturation multi-organisation en unité d’échelle primaire (EUS21), cette API est utilisée pour créer un instantané de facturation pour une organisation spécifique. L’unité d’échelle primaire appellera cette API pour chaque organisation dans différentes unités de scsle afin de créer un instantané de facturation. Les données seront stockées dans la table d’instantané de facturation de> la partition spécifique à l’organisation. Cela est nécessaire car les clients récupèrent les données de facturation à partir de la base de données de partition spécifique à leur organisation. |
| get |
Obtenez tous les détails des committers facturables, y compris ceux qui ne correspondent pas à un VSID. |
| get |
Obtenez tous les détails des committers facturables, y compris ceux qui ne correspondent pas à un VSID. |
| get |
Estimez le nombre de poussoirs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation. |
| get |
Estimez le nombre de poussoirs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation. |
| get |
Estimer les pushers qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet. |
| get |
Estimer les pushers qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet. |
| get |
Estimez le nombre de validateurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation. |
| get |
Estimez le nombre de validateurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation. |
| get |
Estimer le nombre de commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet. |
| get |
Estimer le nombre de commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet. |
| get |
Estimer les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce référentiel. |
| get |
Estimer les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce référentiel. |
| get |
Estimez le nombre de pousseurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour ce référentiel. |
| get |
Estimez le nombre de pousseurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour ce référentiel. |
| get |
|
| get |
|
| get |
Obtenez les commiteurs utilisés lors du calcul des informations de facturation. |
| get |
Obtenez les commiteurs utilisés lors du calcul des informations de facturation. |
| get |
Obtenir l’état actuel de Advanced Security pour l’organisation |
| get |
Obtenir l’état actuel de Advanced Security pour l’organisation |
| get |
Obtenir l’état actuel de Advanced Security pour un projet |
| get |
Obtenir l’état actuel de Advanced Security pour un projet |
| get |
Déterminer si Advanced Security est activé pour un référentiel |
| get |
Déterminer si Advanced Security est activé pour un référentiel |
| update |
Mettre à jour l’état de La sécurité avancée pour l’organisation |
| update |
Mettre à jour l’état de La sécurité avancée pour l’organisation |
| update |
Mettre à jour l’état de Advanced Security pour le projet |
| update |
Mettre à jour l’état de Advanced Security pour le projet |
| update |
Mettre à jour l’activation de Advanced Security pour un référentiel |
| update |
Mettre à jour l’activation de Advanced Security pour un référentiel |
Détails du constructeur
ManagementRestClient(IVssRestClientOptions)
Détails de la méthode
createBillingSnapshot(MeterUsage)
Lors du calcul de la facturation multi-organisation en unité d’échelle primaire (EUS21), cette API est utilisée pour créer un instantané de facturation pour une organisation spécifique. L’unité d’échelle primaire appellera cette API pour chaque organisation dans différentes unités de scsle afin de créer un instantané de facturation. Les données seront stockées dans la table d’instantané de facturation de> la partition spécifique à l’organisation. Cela est nécessaire car les clients récupèrent les données de facturation à partir de la base de données de partition spécifique à leur organisation.
function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>Paramètres
- meterUsage
- MeterUsage
Retours
Promise<void>
createBillingSnapshot2(MeterUsageForPlan, Plan)
Lors du calcul de la facturation multi-organisation en unité d’échelle primaire (EUS21), cette API est utilisée pour créer un instantané de facturation pour une organisation spécifique. L’unité d’échelle primaire appellera cette API pour chaque organisation dans différentes unités de scsle afin de créer un instantané de facturation. Les données seront stockées dans la table d’instantané de facturation de> la partition spécifique à l’organisation. Cela est nécessaire car les clients récupèrent les données de facturation à partir de la base de données de partition spécifique à leur organisation.
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>Paramètres
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Retours
Promise<void>
getBillableCommitterDetails(Date)
Obtenez tous les détails des committers facturables, y compris ceux qui ne correspondent pas à un VSID.
function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>Paramètres
- billingDate
-
Date
Date à interroger, ou si elle n’est pas fournie, aujourd’hui
Retours
Promise<BillableCommitterDetails[]>
getBillableCommitterDetails2(Plan, Date)
Obtenez tous les détails des committers facturables, y compris ceux qui ne correspondent pas à un VSID.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>Paramètres
- plan
- Plan
Plan à interroger. Plans pris en charge : CodeSecurity et SecretProtection. Ce paramètre est obligatoire.
- billingDate
-
Date
Date à interroger, ou si elle n’est pas fournie, aujourd’hui
Retours
Promise<BillableCommitterDetails[]>
getEstimatedBillablePushersDetailsForOrg()
Estimez le nombre de poussoirs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation.
function getEstimatedBillablePushersDetailsForOrg(): Promise<BilledCommitter[]>Retours
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForOrg2()
Estimez le nombre de poussoirs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation.
function getEstimatedBillablePushersDetailsForOrg2(): Promise<MeterUsageEstimate>Retours
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject(string)
Estimer les pushers qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet.
function getEstimatedBillablePushersDetailsForProject(project: string): Promise<BilledCommitter[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForProject2(string)
Estimer les pushers qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet.
function getEstimatedBillablePushersDetailsForProject2(project: string): Promise<MeterUsageEstimate>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<MeterUsageEstimate>
getEstimatedOrgBillablePushers()
Estimez le nombre de validateurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation.
function getEstimatedOrgBillablePushers(): Promise<string[]>Retours
Promise<string[]>
getEstimatedOrgBillablePushers2()
Estimez le nombre de validateurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour cette organisation.
function getEstimatedOrgBillablePushers2(): Promise<string[]>Retours
Promise<string[]>
getEstimatedProjectBillablePushers(string)
Estimer le nombre de commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet.
function getEstimatedProjectBillablePushers(project: string): Promise<string[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<string[]>
getEstimatedProjectBillablePushers2(string)
Estimer le nombre de commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet.
function getEstimatedProjectBillablePushers2(project: string): Promise<string[]>Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<string[]>
getEstimatedRepoBillableCommitters(string, string)
Estimer les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce référentiel.
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 référentiel
Retours
Promise<string[]>
getEstimatedRepoBillableCommitters2(string, string)
Estimer les commiteurs qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce référentiel.
function getEstimatedRepoBillableCommitters2(project: string, repository: string): Promise<string[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
Retours
Promise<string[]>
getEstimatedRepoBillableCommittersDetails2(string, string)
Estimez le nombre de pousseurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour ce référentiel.
function getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<MeterUsageEstimate>Paramètres
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Retours
Promise<MeterUsageEstimate>
getEstimatedRepoBillablePushersDetails(string, string)
Estimez le nombre de pousseurs qui seraient ajoutés à l’utilisation du client si la sécurité avancée était activée pour ce référentiel.
function getEstimatedRepoBillablePushersDetails(project: string, repository: string): Promise<BilledCommitter[]>Paramètres
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Retours
Promise<BilledCommitter[]>
getLastMeterUsage()
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>Paramètres
- plan
- Plan
Retours
Promise<MeterUsageForPlan>
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 à interroger, ou si elle n’est pas fournie, aujourd’hui
Retours
Promise<MeterUsage>
getMeterUsage2(Plan, Date)
Obtenez les commiteurs utilisés lors du calcul des informations de facturation.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>Paramètres
- plan
- Plan
Plan à interroger. Plans pris en charge : CodeSecurity et SecretProtection. Ce paramètre est obligatoire.
- billingDate
-
Date
Date à interroger, ou si elle n’est pas fournie, aujourd’hui
Retours
Promise<MeterUsageForPlan>
getOrgEnablementStatus(boolean)
Obtenir l’état actuel de Advanced Security pour l’organisation
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>
getOrgEnablementStatus2(boolean)
Obtenir l’état actuel de Advanced Security pour l’organisation
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>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<OrgEnablementSettings>
getProjectEnablementStatus(string, boolean)
Obtenir l’état actuel de Advanced Security 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>
getProjectEnablementStatus2(string, boolean)
Obtenir l’état actuel de Advanced Security pour un projet
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>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<ProjectEnablementSettings>
getRepoEnablementStatus(string, string, boolean)
Déterminer si Advanced Security est activé pour un référentiel
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 référentiel
- includeAllProperties
-
boolean
Lorsque la valeur est true, détermine également si les push sont bloqués lorsque des secrets sont détectés
Retours
Promise<AdvSecEnablementStatus>
getRepoEnablementStatus2(string, string, boolean)
Déterminer si Advanced Security est activé pour un référentiel
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>Paramètres
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
- includeAllProperties
-
boolean
Lorsque la valeur est true, détermine également si les push sont bloqués lorsque des secrets sont détectés
Retours
Promise<RepoEnablementSettings>
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)
Mettre à jour l’état de La sécurité avancée pour l’organisation
function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
Le nouveau statut
Retours
Promise<void>
updateOrgEnablementStatus2(OrgEnablementSettings)
Mettre à jour l’état de La sécurité avancée pour l’organisation
function updateOrgEnablementStatus2(savedAdvSecEnablementStatus: OrgEnablementSettings): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- OrgEnablementSettings
Le nouveau statut
Retours
Promise<void>
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)
Mettre à jour l’état de Advanced Security pour le projet
function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
Le nouveau statut
- project
-
string
ID de projet ou nom du projet
Retours
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Mettre à jour l’état de Advanced Security pour le projet
function updateProjectEnablementStatus2(savedAdvSecEnablementStatus: ProjectEnablementSettings, project: string): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- ProjectEnablementSettings
Le nouveau statut
- project
-
string
ID de projet ou nom du projet
Retours
Promise<void>
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)
Mettre à jour l’activation de Advanced Security pour un référentiel
function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- AdvSecEnablementStatusUpdate
Nouveau statut
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
Retours
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
Mettre à jour l’activation de Advanced Security pour un référentiel
function updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>Paramètres
- savedAdvSecEnablementStatus
- RepoEnablementSettings
Nouveau statut
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
Retours
Promise<void>