REST Resource: projects.locations.licenseConfigs

Ressource : LicenseConfig

Informations sur les licences des utilisateurs.

Représentation JSON
{
  "name": string,
  "licenseCount": string,
  "subscriptionTier": enum (SubscriptionTier),
  "state": enum (State),
  "autoRenew": boolean,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "subscriptionTerm": enum (SubscriptionTerm),
  "freeTrial": boolean,
  "alertPolicyResourceConfig": {
    object (AlertPolicyResourceConfig)
  },
  "geminiBundle": boolean,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  },
  "lastUserUpdateTime": string,
  "billingAccountLicenseConfig": string
}
Champs
name

string

Immuable. Identifiant. Nom complet de la ressource de configuration de licence. Format : projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}

licenseCount

string (int64 format)

Obligatoire. Nombre de licences achetées.

subscriptionTier

enum (SubscriptionTier)

Obligatoire. Informations sur le niveau d'abonnement pour la configuration de la licence.

state

enum (State)

Uniquement en sortie. État de la configuration de la licence.

autoRenew

boolean

Facultatif. Indique si la configuration de la licence doit être renouvelée automatiquement lorsqu'elle arrive à échéance.

startDate

object (Date)

Obligatoire. Date de début.

endDate

object (Date)

Facultatif. Date de fin prévue.

subscriptionTerm

enum (SubscriptionTerm)

Obligatoire. Période d'abonnement.

freeTrial

boolean

Facultatif. Indique si la configuration de licence concerne un essai sans frais.

alertPolicyResourceConfig

object (AlertPolicyResourceConfig)

Facultatif. Configuration de la règle d'alerte pour cette configuration de licence.

geminiBundle

boolean

Uniquement en sortie. Indique si la configuration de licence concerne le bundle Gemini.

earlyTerminated

boolean

Uniquement en sortie. Indique si l'abonnement a été résilié avant la date d'expiration. Il est généralement arrêté par le pipeline une fois l'abonnement résilié dans subsv3.

earlyTerminationDate

object (Date)

Uniquement en sortie. Date à laquelle l'abonnement est résilié avant la date d'expiration.

lastUserUpdateTime

string (Timestamp format)

Facultatif. Code temporel de la dernière mise à jour initiée par l'utilisateur (modification du nombre de sièges ou de la durée de l'abonnement). Contrairement à updateTime, ce champ n'est marqué que lorsqu'un client met explicitement à jour la licence (par exemple, via l'interface utilisateur). Il n'est pas modifié par les écritures système (pipeline d'abonnement, propagation BALC, etc.).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

billingAccountLicenseConfig

string

Uniquement en sortie. Nom du BillingAccountLicenseConfig à partir duquel ce LicenseConfig est attribué, si ce champ est défini.

État

Énumération de l'état de la configuration de la licence.

Enums
STATE_UNSPECIFIED Valeur par défaut. La configuration de licence n'existe pas.
ACTIVE La configuration de la licence est effective et utilisée.
EXPIRED La configuration de la licence a expiré.
NOT_STARTED La configuration de la licence n'a pas encore commencé et sa date de début est dans le futur.
WITHDRAWN Cela se produit lorsqu'une configuration de sous-licence a renvoyé tous ses sièges à la configuration BillingAccountLicenseConfig à laquelle elle appartient. Semblable à EXPIRED.
DEACTIVATING La configuration de la licence est en période de grâce. Son abonnement a pris fin, soit par résiliation anticipée, soit à sa date d'expiration, mais le client conserve l'accès pendant une durée limitée. Il passe à l'état EXPIRED (EXPIRÉ) à la fin du délai de grâce.

AlertPolicyResourceConfig

Configuration des alertes au niveau des ressources. Utilisé dans : * UserLicense * EngineUserData L'AlertPolicyConfig dans le connecteur de données est utilisé de la même manière. Il n'existe pas de moyen simple de migrer.

Représentation JSON
{
  "alertPolicy": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ],
  "contactDetails": [
    {
      object (ContactDetails)
    }
  ],
  "languageCode": string,
  "regionCode": string
}
Champs
alertPolicy

string

Immuable. Nom complet de la ressource AlertPolicy.

alertEnrollments[]

object (AlertEnrollment)

Facultatif. État d'inscription de chaque alerte.

contactDetails[]

object (ContactDetails)

Facultatif. Coordonnées de contact pour chaque règle d'alerte.

languageCode

string

Facultatif. Code de langue utilisé pour les notifications

regionCode

string

Facultatif. Code de région de l'utilisateur qui s'est abonné à la règle d'alerte.

AlertEnrollment

État de l'inscription à l'alerte.

Représentation JSON
{
  "alertId": string,
  "enrollState": enum (EnrollState),
  "notificationParams": {
    string: string,
    ...
  }
}
Champs
alertId

string

Immuable. ID d'une alerte.

enrollState

enum (EnrollState)

Obligatoire. État d'inscription d'un client.

notificationParams

map (key: string, value: string)

Facultatif. Paramètres utilisés pour instancier une notification. Utilisé pour les notifications déclenchées lors de l'enregistrement. Elles ne sont pas stockées. * E-mails de bienvenue Gemini Business * E-mails d'invitation des utilisateurs Gemini Business

EnrollState

Énumération de l'état de l'inscription pour l'alerte.

Enums
ENROLL_STATE_UNSPECIFIED Valeur par défaut. Utilisé pour les clients qui n'ont pas répondu à la règle d'alerte.
ENROLLED Le client est inscrit à ce règlement.
DECLINED Le client a refusé ce règlement.

ContactDetails

Coordonnées stockées au niveau de la ressource. Si les coordonnées au niveau du projet et de la ressource sont renseignées, les coordonnées au niveau de la ressource remplaceront celles au niveau du projet.

Représentation JSON
{
  "emailAddress": string
}
Champs
emailAddress

string

Facultatif. Adresse e-mail du contact.

Méthodes

create

Crée un LicenseConfig. Cette méthode ne doit être utilisée que pour créer des licences NotebookLM ou des licences d'essai sans frais Gemini Enterprise.

get

Récupère un LicenseConfig.

list

Liste tous les LicenseConfig associés au projet.

patch

Met à jour le LicenseConfig.