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. |
| get |
URL de base pour obtenir tous les pools d’agents disponibles + pool d’agents actuellement sélectionnés Il s’agit d’une opération en lecture seule qui ne nécessite pas les permissions de gestion. |
| 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 |
Estimez les pushers qui seraient ajoutés à l'utilisation du client si Advanced Security était 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 |
Obtenez le statut actuel de la sécurité avancée 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 |
Mises à jour Valeur du registre du pool d’agents pour le pool d’agents sélectionné Ceci utilise automatiquement le client http sous-jacent pour les pools d’agents afin de valider que l’utilisateur dispose des autorisations d’utiliser ce pool |
| update |
Mettre à jour l’état de La sécurité avancée pour l’organisation |
| update |
Mettre à jour le statut 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
Retours
Promise<void>
getAdvancedSecurityAgentPoolSelection()
URL de base pour obtenir tous les pools d’agents disponibles + pool d’agents actuellement sélectionnés Il s’agit d’une opération en lecture seule qui ne nécessite pas les permissions de gestion.
function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>Retours
Promise<AgentPoolDetails>
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[]>
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 du Project ou nom du project
- repository
-
string
Nom ou ID du référentiel
- plan
- Plan
Plan à interroger.
Retours
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.
Retours
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
Estimez les pushers qui seraient ajoutés à l'utilisation du client si Advanced Security était activé pour ce projet.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>Paramètres
- project
-
string
ID du Project ou nom du project
- plan
- Plan
Retours
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>Paramètres
- plan
- Plan
Retours
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
Retours
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
Retours
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
Obtenez le statut actuel de la sécurité avancée pour un projet
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>Paramètres
- project
-
string
ID du Project ou nom du project
- includeAllProperties
-
boolean
Quand la valeur est true, déterminez également si les envois sont bloqués s’ils contiennent des secrets
Retours
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 du Project ou nom du project
- 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>
updateAdvancedSecurityAgentPoolSelection(string)
Mises à jour Valeur du registre du pool d’agents pour le pool d’agents sélectionné Ceci utilise automatiquement le client http sous-jacent pour les pools d’agents afin de valider que l’utilisateur dispose des autorisations d’utiliser ce pool
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>Paramètres
- agentPoolName
-
string
Retours
Promise<AgentPoolDetails>
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
Retours
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Mettre à jour le statut de Advanced Security pour le projet
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>Paramètres
- projectEnablementSettings
- ProjectEnablementSettings
Le nouveau statut
- project
-
string
ID du Project ou nom du project
Retours
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 du Project ou nom du project
- repository
-
string
Nom ou ID du référentiel
Retours
Promise<void>