Partager via


Accounts - List

Obtenez la liste des comptes avec les détails. Un compte représente une entreprise ou une collection d’utilisateurs.

GET https:///accounts?api-version=2024-02-29-preview
GET https:///accounts?api-version=2024-02-29-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}&filter={filter}&countRecords={countRecords}

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
query True

string

Version de l’API à utiliser pour cette opération.

countRecords
query

boolean

Indique s’il faut retourner le nombre total d’enregistrements disponibles pour cette demande.

filter
query

string

Filtrer la liste des résultats à l’aide de l’expression donnée

maxpagesize
query

integer

int32

Nombre maximal d’éléments de résultat par page.

skip
query

integer

int32

Nombre d’éléments de résultat à ignorer.

top
query

integer

int32

Nombre d’éléments de résultat à retourner.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string

uuid

Identificateur de chaîne opaque, globalement unique et généré par le client pour la demande.

Réponses

Nom Type Description
200 OK

PagedAccountResource

La demande a réussi.

En-têtes

  • x-ms-client-request-id: string
  • x-ms-record-count: integer
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: application
URL du jeton: https://login.microsoftonline.com/common/oauth2/v2.0/token

Étendues

Nom Description
https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default

Exemples

Get list of Accounts.

Exemple de requête

GET https:///accounts?api-version=2024-02-29-preview&countRecords=True

Exemple de réponse

x-ms-record-count: 1
{
  "value": [
    {
      "name": "contoso",
      "correlationId": "c7aa0070-3956-11eb-8d59-4d9d2e7a4a8d",
      "serviceDetails": {
        "teamsTenantId": "a7f4bd5c-cc01-40f4-8baa-2b6bdb272b8a",
        "teamsOperatorConnect": {
          "enabled": true,
          "syncEnabled": true,
          "numberCount": 100
        }
      },
      "serviceProvisioningStatus": "synced",
      "serviceProvisioningErrors": []
    }
  ]
}

Définitions

Nom Description
AccountResource

Un compte représente un groupe de nombres, généralement associé à une entreprise.

AccountServiceDetails

Détails des services principaux associés à ce compte.

Azure.Core.Foundations.Error

Objet error.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

AzureOperatorCallProtectionAccountDetails

Détails du compte spécifiques à Azure Operator Call Protection.

PagedAccountResource

Collection paginée d’éléments AccountResource

ServiceProvisioningStatus

États d’approvisionnement d’un objet sur n’importe quel service back-end pertinent.

TeamsDirectRoutingAccountConfig

Configuration spécifique au routage direct Teams.

TeamsDirectRoutingAccountDetails

Détails du compte spécifiques au routage direct Teams sur ce compte.

TeamsDirectRoutingSubdomainProvisioningStatus

Valeurs possibles pour l’état d’approvisionnement DNS des domaines de routage direct Teams

TeamsDirectRoutingSubdomainTokens

Valeur DNS TXT pour la région, telle que fournie par l’administrateur d’entreprise à partir de son centre Administration Microsoft 365. Peut contenir uniquement des lettres, des chiffres, des traits de soulignement et des tirets. Peut avoir jusqu’à 100 caractères.

TeamsOperatorConnectAccountDetails

Détails du compte spécifiques à l’opérateur Teams Se connecter sur ce compte.

TeamsPhoneMobileAccountDetails

Détails du compte spécifiques à Téléphonie Teams Mobile.

ZoomPhoneCloudPeeringAccountDetails

Détails du compte spécifiques à Zoom Phone Cloud Peering.

AccountResource

Un compte représente un groupe de nombres, généralement associé à une entreprise.

Nom Type Description
correlationId

string

Identificateur défini par l’utilisateur utilisé pour la corrélation avec les systèmes externes.

name

string

Nom du compte.

serviceDetails

AccountServiceDetails

Détails du compte.

serviceProvisioningErrors

Azure.Core.Foundations.Error[]

Toutes les erreurs relatives à l’approvisionnement de cette ressource.

serviceProvisioningStatus

ServiceProvisioningStatus

Status de l’action d’approvisionnement associée à cette ressource.

AccountServiceDetails

Détails des services principaux associés à ce compte.

Nom Type Description
azureOperatorCallProtection

AzureOperatorCallProtectionAccountDetails

Détails du service Azure Operator Call Protection sur ce compte.

teamsDirectRouting

TeamsDirectRoutingAccountDetails

Détails du service de routage direct Teams sur ce compte.

teamsOperatorConnect

TeamsOperatorConnectAccountDetails

Détails du service Teams Operator Connect sur ce compte.

teamsPhoneMobile

TeamsPhoneMobileAccountDetails

Détails du service mobile Téléphonie Teams sur ce compte.

teamsTenantId

string

ID de locataire Microsoft Teams du compte. Cela ne peut être mis à jour que si aucun opérateur connect ou Téléphonie Teams numéros mobiles n’est configuré dans ce compte.

zoomPhoneCloudPeering

ZoomPhoneCloudPeeringAccountDetails

Détails du service Zoom Phone Cloud Peering sur ce compte.

Azure.Core.Foundations.Error

Objet error.

Nom Type Description
code

string

Un des ensembles de codes d’erreur définis par le serveur.

details

Azure.Core.Foundations.Error[]

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

innererror

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

message

string

Représentation lisible de l’erreur.

target

string

Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom Type Description
error

Azure.Core.Foundations.Error

Objet error.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom Type Description
code

string

Un des ensembles de codes d’erreur définis par le serveur.

innererror

Azure.Core.Foundations.InnerError

Erreur interne.

AzureOperatorCallProtectionAccountDetails

Détails du compte spécifiques à Azure Operator Call Protection.

Nom Type Description
enabled

boolean

Boolean indiquant si le service est activé sur ce compte.

numberCount

integer

Nombre de numéros de téléphone associés à ce compte pour authentification de ce service principal.

PagedAccountResource

Collection paginée d’éléments AccountResource

Nom Type Description
nextLink

string

Lien vers la page d’éléments suivante

value

AccountResource[]

Éléments AccountResource sur cette page

ServiceProvisioningStatus

États d’approvisionnement d’un objet sur n’importe quel service back-end pertinent.

Nom Type Description
failed

string

L’opération d’approvisionnement d’objets a échoué avec le service principal approprié.

pending

string

L’objet est en attente d’approvisionnement.

synced

string

L’objet a été synchronisé avec le service back-end approprié.

TeamsDirectRoutingAccountConfig

Configuration spécifique au routage direct Teams.

Nom Type Description
callScreening

boolean

Active/désactive le filtrage de l’ID de l’appelant pour le compte. Le filtrage de l’ID de l’appelant est activé par défaut.

subdomain

string

Étiquette de nom de domaine spécifique à l’entreprise. Peut contenir uniquement des lettres, des chiffres, des traits de soulignement et des tirets. Peut avoir jusqu’à 10 caractères.

subdomainTokens

TeamsDirectRoutingSubdomainTokens

Valeur TXT DNS pour les régions de routage direct, telle que fournie par le client à partir de son centre de Administration Microsoft 365.

TeamsDirectRoutingAccountDetails

Détails du compte spécifiques au routage direct Teams sur ce compte.

Nom Type Description
configuration

TeamsDirectRoutingAccountConfig

Configuration du routage direct Teams sur ce compte.

enabled

boolean

Boolean indiquant si le service est activé sur ce compte.

numberCount

integer

Nombre de numéros de téléphone associés à ce compte pour authentification de ce service principal.

subdomainStatus

TeamsDirectRoutingSubdomainProvisioningStatus

Le provisionnement status des domaines.

syncEnabled

boolean

Boolean indiquant si les données sont en cours d’approvisionnement via le service back-end.

TeamsDirectRoutingSubdomainProvisioningStatus

Valeurs possibles pour l’état d’approvisionnement DNS des domaines de routage direct Teams

Nom Type Description
inconsistent

string

État d’approvisionnement DNS incohérent.

notProvisioned

string

État d’approvisionnement DNS Non approvisionné.

provisioned

string

État d’approvisionnement DNS Provisionné.

TeamsDirectRoutingSubdomainTokens

Valeur DNS TXT pour la région, telle que fournie par l’administrateur d’entreprise à partir de son centre Administration Microsoft 365. Peut contenir uniquement des lettres, des chiffres, des traits de soulignement et des tirets. Peut avoir jusqu’à 100 caractères.

Nom Type Description
region1Token

string

Valeur DNS TXT pour la première région, telle que fournie par l’administrateur d’entreprise à partir de son centre de Administration Microsoft 365. Peut contenir uniquement des lettres, des chiffres, des traits de soulignement et des tirets. Peut avoir jusqu’à 100 caractères.

region2Token

string

Valeur DNS TXT pour la deuxième région, telle que fournie par l’administrateur d’entreprise à partir de son centre de Administration Microsoft 365. Peut contenir uniquement des lettres, des chiffres, des traits de soulignement et des tirets. Peut avoir jusqu’à 100 caractères.

TeamsOperatorConnectAccountDetails

Détails du compte spécifiques à l’opérateur Teams Se connecter sur ce compte.

Nom Type Description
enabled

boolean

Boolean indiquant si le service est activé sur ce compte.

numberCount

integer

Nombre de numéros de téléphone associés à ce compte pour authentification de ce service principal.

syncEnabled

boolean

Boolean indiquant si les données sont en cours d’approvisionnement via le service back-end.

TeamsPhoneMobileAccountDetails

Détails du compte spécifiques à Téléphonie Teams Mobile.

Nom Type Description
enabled

boolean

Boolean indiquant si le service est activé sur ce compte.

numberCount

integer

Nombre de numéros de téléphone associés à ce compte pour authentification de ce service principal.

syncEnabled

boolean

Boolean indiquant si les données sont en cours d’approvisionnement via le service back-end.

ZoomPhoneCloudPeeringAccountDetails

Détails du compte spécifiques à Zoom Phone Cloud Peering.

Nom Type Description
enabled

boolean

Boolean indiquant si le service est activé sur ce compte.

numberCount

integer

Nombre de numéros de téléphone associés à ce compte pour authentification de ce service principal.

syncEnabled

boolean

Boolean indiquant si les données sont en cours d’approvisionnement via le service back-end.