Obtenir un enregistrement le l’activité de l’Espace partenaires

Article
09/11/2024

S’applique à : Espace partenaires | Espace partenaires de Microsoft Cloud for US Government

Cet article explique comment récupérer un enregistrement des opérations effectuées par un utilisateur ou une application partenaire sur une période donnée.

Utilisez cette API pour récupérer les enregistrements d’audit des 30 jours précédents à partir de la date actuelle, ou pour une plage de dates spécifiée en incluant la date de début et/ou la date de fin. Notez toutefois que, pour des raisons de performances, la disponibilité des données du journal d’activité est limitée aux 90 jours précédents. Les demandes avec une date de début supérieure à 90 jours avant la date actuelle recevront une exception de demande incorrecte (code d’erreur : 400) et un message approprié.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.

C#

Pour récupérer un enregistrement des opérations de l’Espace partenaires, commencez par établir la plage de dates des enregistrements que vous souhaitez récupérer. L’exemple de code suivant utilise uniquement une date de début, mais vous pouvez également inclure une date de fin. Pour plus d’informations, consultez la méthode Query. Ensuite, créez les variables dont vous avez besoin pour le type de filtre que vous souhaitez appliquer et attribuez les valeurs appropriées. Par exemple, pour filtrer par sous-chaîne nom de société, créez une variable pour contenir la sous-chaîne. Pour filtrer par ID client, créez une variable pour contenir l’ID.

Dans l’exemple suivant, l’exemple de code est fourni pour filtrer par une sous-chaîne de nom de société, un ID client ou un type de ressource. Choisissez un et commentez les autres. Dans chaque cas, vous instanciez d’abord un objet SimpleFieldFilter à l’aide de son constructeur par défaut pour créer le filtre. Vous devez passer une chaîne qui contient le champ à rechercher et l’opérateur approprié à appliquer, comme indiqué. Vous devez également fournir la chaîne à filtrer.

Ensuite, utilisez la propriété AuditRecords pour obtenir une interface pour auditer les opérations d’enregistrement, puis appelez la méthode Query ou QueryAsync pour exécuter le filtre et obtenir la collection d’AuditRecord qui représentent la première page du résultat. Transmettez la méthode la date de début, une date de fin facultative non utilisée dans l’exemple ici, et un objet IQuery qui représente une requête sur une entité. L’objet IQuery est créé en passant le filtre créé ci-dessus à la méthode BuildSimpleQuery de QueryFactory.

Une fois que vous avez la page initiale des éléments, utilisez la méthode Enumerators.AuditRecords.Create pour créer un énumérateur que vous pouvez utiliser pour itérer dans les pages restantes.

// IAggregatePartner partnerOperations;

var startDate = new DateTime(DateTime.Now.Year, DateTime.Now.Month, 01);

// First perform the query, then get the enumerator. Choose one of the following and comment out the other two.

// To retrieve audit records by company name substring (for example "bri" matches "Fabrikam, Inc.").
var searchSubstring="bri";
var filter = new SimpleFieldFilter(AuditRecordSearchField.CompanyName.ToString(), FieldFilterOperation.Substring, searchSubstring);
var auditRecordsPage = partnerOperations.AuditRecords.Query(startDate.Date, query: QueryFactory.Instance.BuildSimpleQuery(filter));

// To retrieve audit records by customer ID.
var customerId="0c39d6d5-c70d-4c55-bc02-f620844f3fd1";
var filter = new SimpleFieldFilter(AuditRecordSearchField.CustomerId.ToString(), FieldFilterOperation.Equals, customerId);
var auditRecordsPage = partnerOperations.AuditRecords.Query(startDate.Date, query: QueryFactory.Instance.BuildSimpleQuery(filter));

// To retrieve audit records by resource type.
int resourceTypeInt = 3; // Subscription Resource.
string searchField = Enum.GetName(typeof(ResourceType), resourceTypeInt);
var filter = new SimpleFieldFilter(AuditRecordSearchField.ResourceType.ToString(), FieldFilterOperation.Equals, searchField);
var auditRecordsPage = partnerOperations.AuditRecords.Query(startDate.Date, query: QueryFactory.Instance.BuildSimpleQuery(filter));

var auditRecordEnumerator = partnerOperations.Enumerators.AuditRecords.Create(auditRecordsPage);

int pageNumber = 1;
while (auditRecordEnumerator.HasValue)
{
    // Work with the current page.
    foreach (var c in auditRecordEnumerator.Current.Items)
    {
        // Display some info, such as operation type, operation date, and operation status.
        Console.WriteLine(string.Format("{0} {1} {2}.", c.OperationType, c.OperationDate, c.OperationStatus));
    }

    // Get the next page of audit records.
    auditRecordEnumerator.Next();
}

Exemple : Application de test de console. Projet : Dossier d’exemples du Kit de développement logiciel (SDK) de l’Espace partenaires : Audit

Demande REST

Syntaxe de la requête

Méthode	URI de demande
GET	{baseURL}/v1/auditrecords ?startDate={startDate} HTTP/1.1
GET	{baseURL}/v1/auditrecords ?startDate={startDate}&endDate={endDate} HTTP/1.1
GET	{baseURL}/v1/auditrecords ?startDate={startDate}&endDate={endDate}&filter={"Field » :"CompanyName »,"Value » :"{searchSubstring} »,"Operator » :"substring"} HTTP/1.1
GET	{baseURL}/v1/auditrecords ?startDate={startDate}&endDate={endDate}&filter={"Field » :"CustomerId »,"Value » :"{customerId} »,"Operator » :"equals"} HTTP/1.1
GET	{baseURL}/v1/auditrecords ?startDate={startDate}&endDate={endDate}&filter={"Field » :"ResourceType »,"Value » :"{resourceType} »,"Operator » :"equals"} HTTP/1.1

Paramètre d’URI

Utilisez les paramètres de requête suivants lors de la création de la requête.

Nom	Type	Requise	Description
startDate	date	Non	Date de début au format aaaa-mm-jj. Si aucun n’est fourni, le jeu de résultats est défini par défaut sur 30 jours avant la date de la demande. Ce paramètre est facultatif lorsqu’un filtre est fourni.
endDate	date	Non	Date de fin au format aaaa-mm-jj. Ce paramètre est facultatif lorsqu’un filtre est fourni. Lorsque la date de fin est omise ou définie sur null, la requête retourne la fenêtre maximale ou utilise aujourd’hui comme date de fin, selon la valeur inférieure.
filter	string	Non	Filtre à appliquer. Ce paramètre doit être une chaîne encodée. Ce paramètre est facultatif lorsque la date de début ou de fin est fournie.

Syntaxe du filtre

Vous devez composer le paramètre de filtre sous la forme d’une série de paires de virgules séparées par des virgules, clé-valeur. Chaque clé et valeur doit être placée entre des guillemets et séparée par deux points. La totalité du filtre doit être encodée.

Un exemple non codé ressemble à ceci :

?filter{"Field":"CompanyName","Value":"bri","Operator":"substring"}

Le tableau suivant décrit les paires clé-valeur requises :

Clé	Valeur
Champ	Champ à filtrer. Les valeurs prises en charge sont disponibles dans la syntaxe De requête.
Valeur	Valeur sur laquelle filtrer. Le cas de la valeur est ignoré. Les paramètres de valeur suivants sont pris en charge, comme indiqué dans la syntaxe de requête : searchSubstring - Remplacez par le nom de la société. Vous pouvez entrer une sous-chaîne pour faire correspondre une partie du nom de la société (par exemple, `bri` correspondra `Fabrikam, Inc`). Exemple : `"Value":"bri"` customerId : remplacez par une chaîne au format GUID qui représente l’identificateur du client. Exemple : `"Value":"0c39d6d5-c70d-4c55-bc02-f620844f3fd1"` resourceType : remplacez par le type de ressource pour lequel récupérer les enregistrements d’audit (par exemple, Abonnement). Les types de ressources disponibles sont définis dans ResourceType. Exemple : `"Value":"Subscription"`
Opérateur	Opérateur à appliquer. Les opérateurs pris en charge sont disponibles dans la syntaxe de requête.

En-têtes de requête

Pour plus d’informations, consultez les en-têtes REST du Centre Parter.

Corps de la demande

Aucune.

Exemple de requête

GET https://api.partnercenter.microsoft.com/v1/auditrecords?startDate=6/1/2017%2012:00:00%20AM&filter=%7B%22Field%22:%22CustomerId%22,%22Value%22:%220c39d6d5-c70d-4c55-bc02-f620844f3fd1%22,%22Operator%22:%22equals%22%7D HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 127facaa-e389-41f8-8bb7-1d1af99db893
MS-CorrelationId: de9c2ccc-40dd-4186-9660-65b9b64c3d14
X-Locale: en-US
Host: api.partnercenter.microsoft.com
Connection: Keep-Alive

Réponse REST

Si elle réussit, cette méthode retourne un ensemble d’activités qui répondent aux filtres.

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

HTTP/1.1 200 OK
Content-Length: 2859
Content-Type: application/json; charset=utf-8
MS-CorrelationId: de9c2ccc-40dd-4186-9660-65b9b64c3d14
MS-RequestId: 127facaa-e389-41f8-8bb7-1d1af99db893
MS-CV: 4xDKynq/zE2im0wj.0
MS-ServerId: 030011719
Date: Tue, 27 Jun 2017 22:19:46 GMT

{
    "totalCount": 2,
    "items": [{
            "partnerId": "3b33e682-00c3-41ee-9dd2-a548adf56438",
            "customerId": "0c39d6d5-c70d-4c55-bc02-f620844f3fd1",
            "customerName": "Relecloud",
            "userPrincipalName": "admin@domain.onmicrosoft.com",
            "resourceType": "order",
            "resourceNewValue": "{\"Id\":\"d51a052e-043c-4a2a-aa37-2bb938cef6c1\",\"ReferenceCustomerId\":\"0c39d6d5-c70d-4c55-bc02-f620844f3fd1\",\"BillingCycle\":\"none\",\"LineItems\":[{\"LineItemNumber\":0,\"OfferId\":\"C0BD2E08-11AC-4836-BDC7-3712E744922F\",\"SubscriptionId\":\"488745B5-2086-4912-802C-6ABB9F7C3638\",\"ParentSubscriptionId\":null,\"FriendlyName\":\"Office 365 Business Premium Trial\",\"Quantity\":25,\"PartnerIdOnRecord\":null,\"Links\":{\"Subscription\":{\"Uri\":\"/customers/0c39d6d5-c70d-4c55-bc02-f620844f3fd1/subscriptions/488745B5-2086-4912-802C-6ABB9F7C3638\",\"Method\":\"GET\",\"Headers\":[]}}}],\"CreationDate\":\"2017-06-15T15:56:04.077-07:00\",\"Links\":{\"Self\":{\"Uri\":\"/customers/0c39d6d5-c70d-4c55-bc02-f620844f3fd1/orders/d51a052e-043c-4a2a-aa37-2bb938cef6c1\",\"Method\":\"GET\",\"Headers\":[]}},\"Attributes\":{\"Etag\":\"eyJpZCI6ImQ1MWEwNTJlLTA0M2MtNGEyYS1hYTM3LTJiYjkzOGNlZjZjMSIsInZlcnNpb24iOjF9\",\"ObjectType\":\"Order\"}}",
            "operationType": "create_order",
            "operationDate": "2017-06-15T22:56:05.0589308Z",
            "operationStatus": "succeeded",
            "customizedData": [{
                    "key": "OrderId",
                    "value": "d51a052e-043c-4a2a-aa37-2bb938cef6c1"
                }, {
                    "key": "BillingCycle",
                    "value": "None"
                }, {
                    "key": "OfferId-0",
                    "value": "C0BD2E08-11AC-4836-BDC7-3712E744922F"
                }, {
                    "key": "SubscriptionId-0",
                    "value": "488745B5-2086-4912-802C-6ABB9F7C3638"
                }, {
                    "key": "SubscriptionName-0",
                    "value": "Office 365 Business Premium Trial"
                }, {
                    "key": "Quantity-0",
                    "value": "25"
                }, {
                    "key": "PartnerOnRecord-0",
                    "value": null
                }
            ],
            "attributes": {
                "objectType": "AuditRecord"
            }
        }, {
            "partnerId": "3b33e682-00c3-41ee-9dd2-a548adf56438",
            "customerId": "0c39d6d5-c70d-4c55-bc02-f620844f3fd1",
            "customerName": "Relecloud",
            "userPrincipalName": "admin@domain.onmicrosoft.com",
            "applicationId": "Partner Center Native App",
            "resourceType": "license",
            "resourceNewValue": "{\"LicensesToAssign\":[{\"ExcludedPlans\":null,\"SkuId\":\"efccb6f7-5641-4e0e-bd10-b4976e1bf68e\"}],\"LicensesToRemove\":null,\"LicenseWarnings\":[],\"Attributes\":{\"ObjectType\":\"LicenseUpdate\"}}",
            "operationType": "update_customer_user_licenses",
            "operationDate": "2017-06-01T20:09:07.0450483Z",
            "operationStatus": "succeeded",
            "customizedData": [{
                    "key": "CustomerUserId",
                    "value": "482e2152-4b49-48ec-b715-823365ce3d4c"
                }, {
                    "key": "AddedLicenseSkuId",
                    "value": "efccb6f7-5641-4e0e-bd10-b4976e1bf68e"
                }
            ],
            "attributes": {
                "objectType": "AuditRecord"
            }
        }
    ],
    "links": {
        "self": {
            "uri": "/auditrecords?startDate=2017-06-01&size=500&filter=%7B%22Field%22%3A%22CustomerId%22%2C%22Value%22%3A%220c39d6d5-c70d-4c55-bc02-f620844f3fd1%22%2C%22Operator%22%3A%22equals%22%7D",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
}

Partager via