ManagementRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- S' étend
Constructeurs
| Management |
Méthode
| 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 |
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 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 |
|
| 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 un projet |
| get |
Détermine si la sécurité du code, la protection secrète et leurs fonctionnalités sont activées pour le référentiel. |
| 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 |
Mettez à jour l’état d’activation de la sécurité du code et de la protection secrète, ainsi que leurs fonctionnalités respectives, pour un référentiel donné. |
Détails du constructeur
ManagementRestClient(IVssRestClientOptions)
Détails de la méthode
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
Retourne
Promise<void>
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
Retourne
Promise<BillableCommitterDetails[]>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
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 getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>Paramètres
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
- plan
- Plan
Plan à interroger.
Retourne
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
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(plan?: Plan): Promise<MeterUsageEstimate>Paramètres
- plan
- Plan
Plan à interroger.
Retourne
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
Estimer les pushers qui seraient ajoutés à l’utilisation du client si Advanced Security a été activé pour ce projet.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>Paramètres
- project
-
string
ID de projet ou nom du projet
- plan
- Plan
Retourne
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>Paramètres
- plan
- Plan
Retourne
Promise<MeterUsageForPlan>
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
Retourne
Promise<MeterUsageForPlan>
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
Retourne
Promise<OrgEnablementSettings>
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
Retourne
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
Détermine si la sécurité du code, la protection secrète et leurs fonctionnalités sont activées pour le 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
Retourne
Promise<RepoEnablementSettings>
updateOrgEnablementStatus2(OrgEnablementSettings)
Mettre à jour l’état de La sécurité avancée pour l’organisation
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>Paramètres
- orgEnablementSettings
- OrgEnablementSettings
Le nouveau statut
Retourne
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Mettre à jour l’état de Advanced Security pour le projet
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>Paramètres
- projectEnablementSettings
- ProjectEnablementSettings
Le nouveau statut
- project
-
string
ID de projet ou nom du projet
Retourne
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
Mettez à jour l’état d’activation de la sécurité du code et de la protection secrète, ainsi que leurs fonctionnalités respectives, pour un référentiel donné.
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>Paramètres
- repoEnablementSettings
- RepoEnablementSettings
Nouveau statut
- project
-
string
ID de projet ou nom du projet
- repository
-
string
Nom ou ID du référentiel
Retourne
Promise<void>