Metagegevens voor de omgeving ophalen

Note

Community-belangengroepen zijn nu verplaatst van Yammer naar Microsoft Viva Engage. Als u wilt deelnemen aan een Viva Engage-community en deel wilt nemen aan de meest recente discussies, vult u het formulier Toegang aanvragen tot Finance and Operations Viva Engage Community in en kiest u de community waaraan u wilt deelnemen.

U kunt omgevingsmetagegevens ophalen via Microsoft Dynamics Lifecycle Services (LCS) via de LCS Environment-API. Deze API retourneert een gepagineerde lijst die standaard alle omgevingen in het project bevat. De optionele queryreeksparameters kunnen worden gebruikt om het antwoord te filteren.

Permissions

API application

Een van de volgende machtigingen is vereist om deze API aan te roepen. Zie databaseverplaatsings-API - Verificatie voor meer informatie over machtigingen en hoe u deze kunt selecteren.

Permission type	Machtigingen (van laagste naar hoogste bevoegdheidsniveau)
Gedelegeerd (werk- of schoolaccount)	user_impersonation

LCS

In LCS moet de gebruiker die in de API OAuth-verificatie wordt gebruikt, als projecteigenaar of omgevingsbeheerder aan het project worden toegevoegd. De gebruiker moet de uitnodiging voor het project accepteren.

HTTP request

Gebruik het volgende GET-eindpunt om metagegevens van de omgeving op te halen.

Metagegevens ophalen voor alle omgevingen in een project

GET /environmentinfo/v1/detail/project/{projectId}/?page=1

Metagegevens voor één omgeving ophalen op basis van id

GET /environmentinfo/v1/detail/project/{projectId}/?environmentId={environmentId}

Metagegevens voor één omgeving ophalen op naam

GET /environmentinfo/v1/detail/project/{projectId}/?environmentName={environmentName}

Request headers

Gebruik de volgende headerwaarden in de HTTP-aanvraagheader.

Header	Value
Authorization	Bearer {token} (vereist)
'x-ms-version'	'2017-09-15' (required)
Content-Type	application/json

Request body

Geef geen aanvraagtekst op voor deze methode.

Response

HTTP

Het antwoord is altijd een '200 OK'-antwoord, tenzij u niet correct bent geverifieerd. Zorg ervoor dat u de eigenschap IsSuccess gebruikt om het slagen of mislukken van de actie te evalueren.

Pagination

Het resultaat bevat een Booleaanse eigenschap ResultHasMorePages die aangeeft of er een andere pagina met resultaten beschikbaar is. De parameter ?page= querytekenreeks kan worden gebruikt om een specifieke pagina op te halen.

Data

Voor elke omgeving zijn de volgende eigenschappen beschikbaar. Als er geen waarde beschikbaar is voor een eigenschap, wordt null geretourneerd.

Property	Description
EnvironmentId	De id van de LCS-omgeving.
EnvironmentName	De naam van de omgeving.
ProjectId	De id van het LCS-project dat de omgeving bevat.
EnvironmentInfrastructure	Het infrastructuurtype van de omgeving (bijvoorbeeld SelfService of MicrosoftManaged).
EnvironmentType	Het omgevingstype (bijvoorbeeld Productie of Sandbox).
EnvironmentGroup	De omgevingsgroep (bijvoorbeeld Primair of DiasterRecovery).
EnvironmentProduct	Het product dat wordt uitgevoerd in de omgeving.
EnvironmentEndpointBaseUrl	De basis-URL van de omgeving.
DeploymentState	De status van de meest recente omgevingsbewerking.
TopologyDisplayName	De producttopologie die in de omgeving wordt geïmplementeerd.
CurrentApplicationBuildVersion	Een tekenreeks van de toepassingsversie.
CurrentApplicationReleaseName	Een tekenreeks van de naam van de toepassingsrelease.
CurrentPlatformReleaseName	Een tekenreeks van de platformversie.
CurrentPlatformVersion	Een tekenreeks van de naam van de platformrelease.
DeployedOnUTC	Een UTC-datum/tijd-waarde (Coordinated Universal Time) die aangeeft wanneer de omgeving is geïmplementeerd.
CloudStorageLocation	De primaire Azure locatie van de omgeving.
DisasterRecoveryLocation	De secundaire Azure locatie van de omgeving.
DeploymentStatusDisplay	De huidige status van de omgeving.
CanStart	Een Booleaanse waarde die aangeeft of de omgeving kan worden gestart.
CanStop	Een Booleaanse waarde die aangeeft of de omgeving kan worden gestopt.

Example response

Geslaagde reactie voor een aanvraag op projectniveau

{
    "ResultPageCurrent": 1,
    "ResultHasMorePages": true,
    "Data": [
        {
            "EnvironmentId": "d15ed3a8c2c14054840b946c93915da9",
            "EnvironmentName": "ProdEnvironment1",
            "ProjectId": 112233,
            "EnvironmentInfrastructure": "MicrosoftManaged",
            "EnvironmentType": "Production",
            "EnvironmentGroup": "Primary",
            "EnvironmentProduct": "finance and operations",
            "EnvironmentEndpointBaseUrl": "<example>",
            "DeploymentState": "Finished",
            "TopologyDisplayName": "finance and operations - High Availability (10.0.20 with Platform update 44)",
            "CurrentApplicationBuildVersion": "10.0.886.48",
            "CurrentApplicationReleaseName": "10.0.20",
            "CurrentPlatformReleaseName": "Update44",
            "CurrentPlatformVersion": "7.0.6060.45",
            "DeployedOnUTC": "8/5/2021 11:00 PM",
            "CloudStorageLocation": "Central India",
            "DisasterRecoveryLocation": "South India",
            "DeploymentStatusDisplay": "Deployed",
            "CanStart": false,
            "CanStop": false,
            "DatabaseDailyBackupsEnabled": true,
            "DatabaseBackupLocation": "Central India"
        },
        {
            "EnvironmentId": "60b557b2-fefb-4690-859e-f83caf98c17e",
            "EnvironmentName": "SandboxEnvironment1",
            "ProjectId": 112233,
            "EnvironmentInfrastructure": "MicrosoftManaged",
            "EnvironmentType": "Sandbox",
            "EnvironmentGroup": "Primary",
            "EnvironmentProduct": "finance and operations",
            "EnvironmentEndpointBaseUrl": "<example>",
            "DeploymentState": "Finished",
            "TopologyDisplayName": "finance and operations - Sandbox (10.0.20 with Platform update 44)",
            "CurrentApplicationBuildVersion": "10.0.960.24",
            "CurrentApplicationReleaseName": "10.0.21",
            "CurrentPlatformReleaseName": "Update45",
            "CurrentPlatformVersion": "7.0.6129.19",
            "DeployedOnUTC": "8/5/2021 12:42 PM",
            "CloudStorageLocation": "East US",
            "DisasterRecoveryLocation": "West US",
            "DeploymentStatusDisplay": "Failed",
            "CanStart": false,
            "CanStop": true,
            "DatabaseDailyBackupsEnabled": true,
            "DatabaseBackupLocation": "East US"
        }
    ],
    "IsSuccess": true,
    "OperationActivityId": "216ea45d-113d-445a-a393-f67041f7aafe",
    "ErrorMessage": null,
    "VersionEOL": "9999-12-31T23:59:59.9999999"
}

Rate limits

Voor een betere taakverdeling van aanvragen gelden er frequentielimieten voor deze API:

6 aanroepen voor elk project per minuut