Beveiligingsnalevings-API voor Partnercentrum

Juiste rollen: Beveiligingsbeheerder | Beveiligingslezer | Beheerderagent

Van toepassing op: Partnercentrum

Met de Api voor beveiligingsnaleving in Partnercentrum kunt u de nalevingstaken van uw partnerorganisatie ophalen, evaluaties van reactietijd controleren en taakstatussen bijwerken. Het biedt ondersteuning voor automatisering voor het geïntegreerde taakmodel dat wordt gebruikt in de opnieuw ontworpen beveiligingswerkruimte, waarbij beveiligingsvereisten en waarschuwingen worden weergegeven als bruikbare taken.

In dit artikel worden het taakmodel, ondersteunde bewerkingen, JSON-resources en REST-aanvraag- en antwoordvoorbeelden beschreven. Api-eigenschapsnamen en -waarden behouden hun exacte hoofdlettergebruik, zelfs wanneer de werkruimte verschillende weergavelabels gebruikt.

Concepten in de opnieuw ontworpen ervaring

De volgende concepten verbinden de ervaring van de beveiligingswerkruimte met de API-resources in dit artikel.

Concept Betekenis in de werkruimte API-weergave
Task Een discrete, bruikbare werkeenheid met een bereik, levenscyclusstatus en, indien beschikbaar, een einddatum. Voltooiing is afhankelijk van de verificatie van de onderliggende voorwaarde, niet alleen handmatig attestation. Een nalevingstaak, geïdentificeerd door taskId.
Taakgroep Gerelateerde taken gegroepeerd op hoofdoorzaak of classificatie. De voortgang van de groep wordt afgeleid van de bijbehorende taken, in plaats van een afzonderlijk bewerkbare groepsstatus. Taakeigenschappen zoals taskGroupId, taskGroupTitleen taskGroupClassification. Met de bewerkingen in dit artikel wordt geen afzonderlijke samenvatting van de taakgroepresource of groepsvoortgang geretourneerd.
Gebeurtenis Een exemplaar van de onderliggende voorwaarde waarmee wordt vastgesteld wat aandacht nodig heeft in het bronsysteem. De status wordt beheerd op taakniveau. In deze API-verwijzing is geen afzonderlijke resource voor exemplaarresources of de status van het exemplaar aanwezig. Stel niet dat feedspecifiek details een gestandaardiseerde verzameling exemplaren biedt.
Algemene naleving De indicator Voltooid/Onvolledig van de werkruimte, met een tijdstempel 'Vanaf'. De opnieuw ontworpen ervaring maakt geen gebruik van een numerieke beveiligingsscore. In dit artikel wordt geen bewerking voor algemene naleving of numerieke score gedefinieerd. De evaluatie van de reactietijd evalueert alleen de reactietijdvereiste.
Versheid van gegevens Het tijdstip waarop de onderliggende brongegevens zijn vernieuwd, in plaats van het tijdstip waarop een gebruiker de pagina heeft geopend of een client een antwoord heeft opgehaald. lastRefreshDateTime voor taakgroepgegevens; calculatedAt en expiresAt voor een beoordeling van de reactietijd. Deze tijdstempels zijn niet uitwisselbaar.

Levenscyclus en statussen van taken

De werkruimte roept de levenscycluswaarde een status aan; de API maakt deze beschikbaar als status. Gebruik de volgende exacte, hoofdlettergevoelige tekenreeksen in API-aanvragen en -antwoorden.

Status Meaning Kan deze API deze instellen?
New De taak is gemaakt en is nog niet bevestigd of gereageerd. No.
In Progress De partner heeft het eigendom genomen en er wordt gewerkt. Dit komt overeen met de bevestigingsactie die wordt beschreven als Onderzoeken in de huidige waarschuwingservaring. Ja, afhankelijk van de onderstaande overgangsbeperkingen.
Ignore Voor een in aanmerking komende taak heeft de partner vastgesteld dat de gebeurtenis bekend en legitiem is. Als u een taak negeert, wordt de voorwaarde niet hersteld of worden de verantwoordelijkheid voor de bijbehorende gebruikskosten verwijderd. Ja, alleen wanneerisIgnorable.true
Ready for Review De partner heeft het vereiste werk voltooid en wacht op verificatie van de onderliggende voorwaarde. Ja, afhankelijk van de onderstaande overgangsbeperkingen.
Complete Microsoft heeft bevestigd dat de onderliggende voorwaarde is opgelost. No. Voltooiing wordt door het systeem beheerd.

Programmatisch werken met een taak:

  1. Geef nalevingstaken weer en selecteer de taak die aandacht nodig heeft.
  2. Haal de taakdetails op om de huidige status, feedspecifieke informatie, notities en recente activiteit te bekijken.
  3. De status instellen op In Progress wanneer het werk begint.
  4. Herstel de voorwaarde in het juiste bronsysteem, zoals Microsoft Entra, de Azure-portal of het Partnercentrum.
  5. Stel de status in op Ready for Review wanneer het werk is voltooid en haal de taak opnieuw op na de bronverificatie om de status en de nieuwheid van de gegevens te controleren.

Important

Een geslaagde statusupdate bevestigt een werkstroomwijziging, niet de voltooiing van het onderliggende werk. Niet behandelen Ready for Review of Ignore als Complete. Gebruik voor een bekende, legitieme gebeurtenis Ignore alleen wanneer dit is toegestaan. Een genegeerde taak moet terugkeren In Progress naar voordat deze kan worden verplaatst Ready for Review. Een voltooide taak kan niet worden gewijzigd door deze bewerking.

API-bereik tijdens de overgang

In de opnieuw ontworpen werkruimte en de API worden niet noodzakelijkerwijs dezelfde acties weergegeven. Gebruik de bewerkingen en schema's in dit artikel als contract voor deze API, in plaats van ervan uit te gaan dat elke werkruimteactie een API-equivalent heeft.

Capability Ondersteuning in deze API
Taken en de bijbehorende details ophalen Lijst- en detailbewerkingen, waaronder taakgroep-id's, beschikbare bereikgegevens en vernieuwingstijdenstempels.
De status van een taak bijwerken Statusbewerking voor In Progress, Ready for Reviewen, indien toegestaan, Ignore. Elke aanvraag is gericht op één taak; er is hier geen bulkstatusbewerking gedefinieerd.
Notities en activiteiten weergeven Taakdetails bevatten bestaande notities en maximaal 50 vermeldingen voor bewaarde activiteiten. Het activiteitenlogboek kan worden afgekapt.
Notities of opmerkingen toevoegen Niet ondersteund door de bewerkingen in dit artikel. Neem geen notities op in de statusaanvraag.
Exemplaren weergeven of wijzigen Er wordt hier geen afzonderlijke exemplaarbewerking gedefinieerd. Breng de vereiste wijzigingen aan in het bronsysteem.
Beoordelingsreactietijd Een beoordeling van de tijd voor de hele partner naar de eerste geregistreerde statuswijziging. Het is geen resultaat van algehele naleving.
Abonnementen beheren Niet ondersteund door deze bewerkingen. Beheer het abonnement in het juiste bronsysteem.
De preview-versie van de werkruimte inschakelen Er is hier geen preview-wisselknop gedefinieerd. API-toegang vereist inschakeling voor de partnerorganisatie.

Tijdens de overgang van de werkruimte kunt u deze Partner Center-eindpunten onderscheiden van de huidige Microsoft Graph bèta-API's voor beveiligingswaarschuwingen, vereisten en beveiligingsscore. Dit artikel definieert geen buitengebruikstellingsdatum, een een-op-een-toewijzing van bestaande waarschuwings-id's aan taak-id's of een vervanging voor elke bestaande bewerking. Ondoorzichtige taak-id's verkrijgen uit deze API; maak ze niet op basis van bestaande waarschuwings- of abonnements-id's.

Note

In de werkruimte wordt de bevestigingsvereiste voor waarschuwingen van 24 uur beschreven in termen van het verplaatsen van taken naar In uitvoering. Het eindpunt voor reactietijd dat hier wordt beschreven, meet de eerste geregistreerde statuswijziging, inclusief verstreken tijd voor meetbare taken zonder wijziging. Gebruik de evaluatieregels bij het interpreteren van API-resultaten; stel niet dat het eindpunt alleen overgangen naar In Progress of alleen taken meet die al een antwoord hebben ontvangen.

Resourceconventies

In de volgende resources worden de JSON-gegevens beschreven die zijn geretourneerd of geaccepteerd door de bewerkingen in dit artikel. Net als in andere Partnercentrum REST-resources definiëren eigenschapstabellen de aanvraag- en antwoordelementen.

JSON-eigenschapsnamen en statuswaarden zijn hoofdlettergevoelig. Tijdstempels zijn UTC ISO 8601-tekenreeksen, bijvoorbeeld 2026-10-01T12:00:00.000Z. Velden met null-waarden kunnen bevatten null; ga er niet van uit dat elke taak klant-, abonnement-, deadline- of oplossingsgegevens bevat.

Nalevingstaak

Beschrijft een nalevingstaak, inclusief de huidige status, ernst, deadline en bijbehorende klant of abonnement. Zowel de lijst- als detailbewerkingen retourneren deze eigenschappen.

Property Type Description
taskId string Ondoorzichtige taak-id. Gebruik deze ongewijzigd, met URL gecodeerd, voor gedetailleerde aanvragen en statusaanvragen.
taskGroupId string Taakgroep-id.
taskGroupTitle tekenreeks of null Titel voor de taakgroep weergeven.
taskGroupClassification tekenreeks of null Classificatie zoals Fraud; afleiden geen volledige opsomming uit dit voorbeeld.
isEligibilityRequirement boolean Of de taakgroep is gemarkeerd als geschiktheidsvereiste.
requirementId string Vereiste-id, bruikbaar in een lijstfilter.
taskTitle tekenreeks of null Titel voor de taak weergeven.
status string Huidige taakstatus: New, In Progress, Ready for Review, , Completeof Ignore.
isIgnorable boolean Of de feed toestaat dat de taak wordt genegeerd.
customerTenantId tekenreeks of null Tenant-id van klant, indien beschikbaar.
customerName tekenreeks of null De weergavenaam van de klant, indien beschikbaar.
subscriptionId tekenreeks of null Abonnements-id, indien beschikbaar.
subscriptionName tekenreeks of null Weergavenaam van abonnement, indien beschikbaar.
severity tekenreeks of null Informational, , High, Mediumof Lownull als deze niet beschikbaar of niet herkend is.
deadlineDateTime tijdstempel of null Deadline voor berekende taken, indien beschikbaar.
createdDate timestamp Tijd voor het maken van taken.
lastModifiedDate tijdstempel of null Tijd van laatste taakwijziging.
lastRefreshDateTime tijdstempel of null Vernieuwingstijd voor taakgroepgegevens; niet het tijdstip waarop de client de taak heeft opgehaald.
resolvedDate tijdstempel of null Oplossingstijd, indien beschikbaar.
version string Ondoorzichtige opslagversie. Behoud de waarde, inclusief ingesloten aanhalingstekens; niet parseren.

Important

Taak-id's zijn ondoorzichtige tekenreeksen, niet GUID's. Kopieer taskId eens vanuit een lijst of detailantwoord en codeer de URL één keer als één padsegment. Maak geen id's, splits ze in zakelijke id's, voeg witruimte toe of codeer ze met base64. De gecodeerde dubbele punten in de voorbeelden zijn opzettelijk.

Details van nalevingstaak

Beschrijft één nalevingstaak met feedspecifieke details, notities en recente activiteiten. Bevat alle eigenschappen van de nalevingstaak plus de volgende eigenschappen.

Property Type Description
details object Feedspecifieke detailvelden. Het voorbeeld van een gedetailleerd antwoord is voor gebruiksafwijkingsdetectie; andere vereisten kunnen verschillende velden of een leeg object retourneren.
notes tekenreeks of null Bestaande taaknotities. De statusbewerking van deze API kan geen notities bijwerken.
activityLog matrix van resources voor activiteiten van nalevingstaken Maximaal 50 bewaarde activiteitenvermeldingen, nieuwste eerst.
activityLogTruncated boolean Waar wanneer de activiteitengeschiedenis wordt afgekapt. Behandel de matrix niet als een volledig audittrail.

Activiteit nalevingstaak

Beschrijft een vastgelegde wijziging in een nalevingstaak. Optionele waarden kunnen null zijn.

Property Type Description
date timestamp Datum en tijd van de activiteit.
action string Opgenomen actie, zoals FeedCreated.
oldStatus tekenreeks of null Taakstatus vóór de wijziging, indien beschikbaar.
newStatus tekenreeks of null Taakstatus na de wijziging, indien beschikbaar.
changeReason tekenreeks of null Reden voor de wijziging, indien beschikbaar.
notes tekenreeks of null Notities die zijn gekoppeld aan de activiteit, indien beschikbaar.

Verzameling nalevingstaken

Beschrijft een pagina met nalevingstaken.

Property Type Description
value matrix van resources voor nalevingstaken Taken op de huidige pagina. Een leeg resultaat is {"value":[]}.
@odata.nextLink string URL voor de volgende pagina. Alleen aanwezig wanneer er meer resultaten bestaan. Volg de geretourneerde koppeling in plaats van een vervolgtoken samen te stellen.

De verzameling heeft geen eigenschap totaalaantal. Zie Paginering voor vervolggedrag en verlooptijd.

Evaluatie van reactietijd

Beschrijft de gemiddelde tijd van uw partnerorganisatie tot de eerste statuswijziging voor nalevingstaken. Dit is een partnerbrede evaluatie, niet de verstreken tijd van een afzonderlijke taak, de tijd tot de uiteindelijke oplossing of de HTTP-API-latentie.

Property Type Description
completion string Evaluatieresultaat: complete, notCompleteof unknown. Geen taakstatus.
thresholdSeconds integer Evaluatiedrempel, momenteel 86.400 seconden (24 uur).
averageDurationSeconds geheel getal of null De gemiddelde gemeten duur in seconden, afgerond tot een hele seconde. Null als er geen meting beschikbaar is.
sampleCount geheel getal of null Het aantal meetbare taakvoorbeelden dat in het gemiddelde is opgenomen.
availability string Beschikbaarheid van het onderliggende berekeningsbewijs: available, partialof unavailable. Inspecteer dit afzonderlijk van completion.
reason tekenreeks of null Uitleg voor ontbrekend/gedeeltelijk bewijs, zoals , , , of truncatedHistoryregistryPartial. partialHistoryinsufficientHistorynoHistory Null wanneer dit niet nodig is.
definitionVersion integer Versie van de metingsdefinitie.
activeFeedSetVersion tekenreeks of null Ondoorzichtige versie die de actieve feedset identificeert die in de evaluatie wordt gebruikt.
windowStart tijdstempel of null Het begin van het cohortvenster voor metingen, inclusief.
windowEnd tijdstempel of null Het einde van het cohort van de meting, exclusief.
calculatedAt tijdstempel of null Berekeningstijd.
expiresAt tijdstempel of null Verlooptijd van evaluatie.

Zie De beoordeling van de reactietijd ophalen voor meetregels en bewijsbeperkingen.

Aanvraag voor bijwerken van taakstatus

Beschrijft de aanvraagbody voor het bijwerken van de werkstroomstatus van een nalevingstaak.

Property Type Required Description
status string Yes In ProgressPrecies , Ready for Reviewof Ignore.

statusAlleen leveren. Zie De status van een nalevingstaak bijwerken voor toegestane overgangen en beperkingen.

Resultaat van taakstatusupdate

Beschrijft een bevestigde statusupdate.

Property Type Description
taskId string Ondoorzichtige id van de bijgewerkte taak.
status string Status van bevestigde taak.
lastModifiedDate timestamp Tijd voor taakwijziging.
version string Ondoorzichtige opslagversie na de update, inclusief ingesloten aanhalingstekens.

Fout

Beschrijft een gewone fout in de nalevings-API. Verificatie/MFA-fouten en front-doorstoringen kunnen verschillende lichamen gebruiken; ga er niet van uit dat elke fout overeenkomt met deze shape.

Property Type Description
code integer Numerieke foutcode. Gebruik de HTTP-statuscode en antwoordtekst samen om de volgende actie te bepalen.
description string Beschrijving van de fout.
source string Id van de service die de fout heeft gegenereerd, zoals PCFraudEvents.

Zie Antwoord geslaagde en foutcodes voor HTTP-statuscodes en een voorbeeldfouttekst.

Operations

Gebruik de volgende REST-bewerkingen met deze resources.

Operation Method URI-aanvraag
Nalevingstaken vermelden GET /v1/compliance/tasks
Een nalevingstaak ophalen GET /v1/compliance/tasks/{taskId}
De evaluatie van de reactietijd ophalen GET /v1/compliance/responseTime
De status van een nalevingstaak bijwerken PUT /v1/compliance/tasks/{taskId}/status

Prerequisites

  • Configureer een Microsoft Entra-toepassing voor toegang tot partnercentrum-API's. Zie API-toegang instellen in partnercentrum voor hulp bij het instellen.
  • Haal een toegangstoken op met behulp van App+Gebruikersverificatie, zoals beschreven in Partnercentrum-verificatie. Verificatie met alleen apps wordt niet ondersteund door deze bewerkingen.
  • De gedelegeerde gebruiker moet voldoen aan MFA en gemachtigd zijn om nalevings-/beveiligingsgegevens weer te geven. Voor het bijwerken van de status is beheermachtiging vereist; Alleen-lezenmachtiging is onvoldoende.
  • De API moet zijn ingeschakeld voor de partnerorganisatie. Aanvragen worden uitgevoerd op de tenant van de geverifieerde partner, niet op een tenant die is geselecteerd via een aanvraagparameter of -header.

Zie Veilige toepassingsmodel inschakelen voor richtlijnen voor MFA-integratie.

REST-aanvraagconventies

De PRODUCTIEbasis-URL is https://api.partnercenter.microsoft.com. In de onderstaande voorbeelden wordt deze URL gebruikt. Voorbeelden stellen geen beschikbaarheid vast voor een bepaalde partnerorganisatie; de API moet zijn ingeschakeld voor die organisatie.

Headers aanvragen

De volgende headers zijn van toepassing op deze bewerkingen. Zie Rest-headers in partnercentrum voor algemene headers. Niet elke Partner Center-header is van toepassing op elke bewerking.

Koptekst Usage
Authorization Required. Bearer <token>, met behulp van een toegangstoken dat is verkregen via Partnercentrum-verificatie. Publiceer of registreer nooit een echt token.
Accept Gebruik application/json.
Content-Type Vereist voor PUT: application/json. GET-aanvragen hebben geen aanvraagbody.
MS-CorrelationId Geef een nieuwe GUID op voor elke aanroep om logboeken en netwerktraceringen te correleren bij het oplossen van problemen.
MS-RequestId Geef een GUID op die de aanvraag identificeert. Zie de naslaginformatie over REST-headers in partnercentrum voor algemene conventies voor opnieuw proberen. voor statusupdates volgt u de eindpuntspecifieke herstelrichtlijnen hieronder.

Note

De bewerking voor het bijwerken van de status vereist If-Matchniet. Neem niet aan dat een aanvraag-id of een geretourneerde ETag een onzekere statusupdate veilig maakt om opnieuw af te spelen. Haal de taak op voordat u beslist of u het opnieuw wilt proberen.

Nalevingstaken vermelden

Haal een gepagineerde lijst met nalevingstaken voor uw partnerorganisatie op, inclusief de status, ernst, deadline en beschikbare klant- of abonnementsgegevens van elke taak. Gebruik filters om de resultaten te beperken op status, taakgroep, vereiste, klanttenant of abonnement. Gebruik de geretourneerde taak-id's om details op te halen of de status van een taak bij te werken.

REST-aanvraag

Method URI-aanvraag
GET https://api.partnercenter.microsoft.com/v1/compliance/tasks

Parameters voor zoekopdrachten

Name Type Required Description
$top integer No Paginaformaat van 1 tot 100. Standaard: 100.
$filter string No Ondersteunde gelijkheidsexpressies die hieronder worden beschreven. Maximale lengte: 1000 tekens.
$skiptoken string No Ondoorzichtig vervolgtoken geleverd in @odata.nextLink. Volg de geretourneerde koppeling in plaats van een token te genereren.

Ondersteunde filtervelden: status, taskGroupId, requirementId, customerTenantIden subscriptionId. Gebruiken eq met tekenreekswaarden met één aanhalingsteken en and tussen predicaten. Een haakje or groep wordt alleen ondersteund voor statuswaarden, bijvoorbeeld:

requirementId eq 'UsageAnomalyDetection' and (status eq 'New' or status eq 'In Progress')

Ondersteunde statusfilterwaarden zijnNew, In Progress, Ready for Review, en CompleteIgnore. Escape a literal apostrof in a value as two aposrophes, and URL-encode query values. Dit eindpunt ondersteunt een beperkte OData-stijlsyntaxis, niet algemene OData: $orderby, $skip, $selecten herhaalde queryparameters worden niet ondersteund.

aanvraaginhoud

None.

Vraag om voorbeeld

GET https://api.partnercenter.microsoft.com/v1/compliance/tasks?$top=1&$filter=requirementId%20eq%20%27UsageAnomalyDetection%27%20and%20status%20eq%20%27New%27 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
MS-RequestId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb

REST-antwoord

Als dit lukt, retourneert deze methode 200 OK en een verzameling nalevingstaken in de hoofdtekst van het antwoord. Een leeg resultaat is {"value":[]}; er is geen eigenschap totaalaantal.

Voorbeeld van antwoord

{
  "value": [
    {
      "taskId": "usage-anomaly-detection::11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222",
      "taskGroupId": "usage-anomaly-detection",
      "taskGroupTitle": "Usage Anomaly Detection",
      "taskGroupClassification": "Fraud",
      "isEligibilityRequirement": false,
      "requirementId": "UsageAnomalyDetection",
      "taskTitle": "Action Required: Subscription Usage Anomaly Detected",
      "status": "New",
      "isIgnorable": true,
      "customerTenantId": null,
      "customerName": "Contoso Customer",
      "subscriptionId": "11111111-1111-4111-8111-111111111111",
      "subscriptionName": null,
      "severity": "High",
      "deadlineDateTime": "2026-10-15T12:00:00.000Z",
      "createdDate": "2026-09-15T12:00:00.000Z",
      "lastModifiedDate": "2026-09-15T12:00:00.000Z",
      "lastRefreshDateTime": "2026-10-01T11:00:00.000Z",
      "resolvedDate": null,
      "version": "\"33333333-3333-4333-8333-333333333333\""
    }
  ],
  "@odata.nextLink": "https://api.partnercenter.microsoft.com/v1/compliance/tasks?$top=1&$filter=requirementId%20eq%20%27UsageAnomalyDetection%27%20and%20status%20eq%20%27New%27&$skiptoken=55555555-5555-4555-8555-555555555555"
}

Pagination

Volg @odata.nextLink met dezelfde verificatie totdat de eigenschap afwezig is. Wijzig het paginaformaat of filter niet tijdens een doorkruising. Vervolgen verlopen één uur na de eerste pagina; als u een andere pagina ophaalt, wordt deze vervaldatum niet verlengd. Een ongeldig, verlopen of niet-compatibel token retourneert 400; opnieuw opstarten vanaf de eerste lijstaanvraag. Wijzigingen in de configuratie van de actieve feed kunnen een voortzetting ongeldig maken. Het wisselen van een veranderende lijst is geen momentopname van een bepaald tijdstip.

Een nalevingstaak ophalen

Eén nalevingstaak ophalen met behulp van een taak-id die wordt geretourneerd door het lijsteindpunt. Het antwoord bevat de overzichtseigenschappen van de taak plus feedspecifieke details, bestaande notities en recente activiteitengeschiedenis. Gebruik deze bewerking om een taak te onderzoeken of de huidige status te vernieuwen voordat u een statusupdate besluit.

REST-aanvraag

Method URI-aanvraag
GET https://api.partnercenter.microsoft.com/v1/compliance/tasks/{taskId}

URI Parameters

Name Type Required Description
taskId string Yes Ondoorzichtige taak-id die wordt geretourneerd door een lijst of detailantwoord, wordt eenmaal gecodeerd als één padsegment.

aanvraaginhoud

None. Er worden geen queryparameters ondersteund.

Vraag om voorbeeld

GET https://api.partnercenter.microsoft.com/v1/compliance/tasks/usage-anomaly-detection%3A%3A11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
MS-RequestId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb

REST-antwoord

Als dit lukt, retourneert deze methode 200 OK - en nalevingstaakdetails in de hoofdtekst van het antwoord. De ETag antwoordheader komt overeen version.

Voorbeeld van antwoord

{
  "details": {
    "alertId": "11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222",
    "alertDisplayName": "Action Required: Subscription Usage Anomaly Detected",
    "severity": "High",
    "subscriptionId": "11111111-1111-4111-8111-111111111111",
    "customerName": "Contoso Customer",
    "detectedTime": "2026-09-15T12:00:00.000Z",
    "description": "Unusual subscription usage was detected. Review the affected subscription."
  },
  "notes": null,
  "activityLog": [
    {
      "date": "2026-09-15T12:00:00.000Z",
      "action": "FeedCreated",
      "oldStatus": null,
      "newStatus": "New",
      "changeReason": null,
      "notes": null
    }
  ],
  "activityLogTruncated": false,
  "taskId": "usage-anomaly-detection::11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222",
  "taskGroupId": "usage-anomaly-detection",
  "taskGroupTitle": "Usage Anomaly Detection",
  "taskGroupClassification": "Fraud",
  "isEligibilityRequirement": false,
  "requirementId": "UsageAnomalyDetection",
  "taskTitle": "Action Required: Subscription Usage Anomaly Detected",
  "status": "New",
  "isIgnorable": true,
  "customerTenantId": null,
  "customerName": "Contoso Customer",
  "subscriptionId": "11111111-1111-4111-8111-111111111111",
  "subscriptionName": null,
  "severity": "High",
  "deadlineDateTime": "2026-10-15T12:00:00.000Z",
  "createdDate": "2026-09-15T12:00:00.000Z",
  "lastModifiedDate": "2026-09-15T12:00:00.000Z",
  "lastRefreshDateTime": "2026-10-01T11:00:00.000Z",
  "resolvedDate": null,
  "version": "\"33333333-3333-4333-8333-333333333333\""
}

De evaluatie van de reactietijd ophalen

Haal de evaluatie van de partnerorganisatie op over hoe snel nalevingstaken hun eerste statuswijziging ontvangen, gemeten op basis van de huidige drempelwaarde van 24 uur. De evaluatie omvat taken die in de voorgaande 30 dagen zijn geopend en omvat verstreken tijd voor meetbare taken die nog geen gewijzigde status hebben. Het retourneert de gemiddelde duur, het aantal steekproeven, het resultaat van de evaluatie en de beschikbaarheid van bewijsmateriaal; hiermee wordt de uiteindelijke oplossingstijd of API-latentie niet gemeten.

REST-aanvraag

Method URI-aanvraag
GET https://api.partnercenter.microsoft.com/v1/compliance/responseTime

Er worden geen queryparameters ondersteund.

aanvraaginhoud

None.

Vraag om voorbeeld

GET https://api.partnercenter.microsoft.com/v1/compliance/responseTime HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
MS-RequestId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb

REST-antwoord

Als dit lukt, retourneert deze methode 200 OK en een reactietijdevaluatie in de hoofdtekst van het antwoord.

Voorbeeld van antwoord

{
  "completion": "notComplete",
  "thresholdSeconds": 86400,
  "averageDurationSeconds": 108000,
  "sampleCount": 10,
  "availability": "available",
  "reason": null,
  "definitionVersion": 1,
  "activeFeedSetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "windowStart": "2026-09-01T12:00:00.000Z",
  "windowEnd": "2026-10-01T12:00:00.000Z",
  "calculatedAt": "2026-10-01T12:00:00.000Z",
  "expiresAt": "2026-10-01T12:10:00.000Z"
}

Evaluatieregels

De huidige definitie beschouwt taken die zijn geopend tijdens de voorgaande 30 dagen in actieve feeds, met uitzondering van taken die in eerste instantie zijn voltooid. Het meet de tijd van de opgenomen openings gebeurtenis tot de eerste geregistreerde statuswijziging; een meetbare taak zonder wijziging draagt bij tot de berekeningstijd. Ontbrekende of afgekapte geschiedenis kan de beschikbaarheid verminderen. Het gemiddelde is daarom niet beperkt tot taken waarop al is gereageerd en is geen tijd voor de definitieve oplossing.

Met meetbaar bewijs resulteert completeeen gemiddelde van of minder dan 86.400 seconden in ; boven dat resulteert notCompletein . Een gedeeltelijk feedregister evalueert.unknown Zonder geschiedenis kan de huidige implementatie worden geretourneerd completion: "complete" met availability: "unavailable" en een null-gemiddelde. Interpreteer dit niet als een gemeten reactietijd van nul seconden. Geslaagde evaluatieobjecten kunnen gedeeltelijk/niet-beschikbaar bewijs vertegenwoordigen; afhankelijkheidsfouten kunnen in plaats daarvan 503 retourneren.

De status van een nalevingstaak bijwerken

Werk de werkstroomstatus van een taak bij naar Wordt uitgevoerd, Gereed voor revisie of Negeren, afhankelijk van de huidige status van de taak en of de feed negeert. Voor deze bewerking is beheermachtiging vereist en wordt de bevestigde status, wijzigingstijd en versie geretourneerd. Als u de status wijzigt, wordt de voortgang van uw werkstroom vastgelegd; hiermee wordt het onderliggende probleem niet opgelost of kunt u de taak Voltooid markeren.

REST-aanvraag

Method URI-aanvraag
PUT https://api.partnercenter.microsoft.com/v1/compliance/tasks/{taskId}/status

URI Parameters

Name Type Required Description
taskId string Yes Ondoorzichtige taak-id die wordt geretourneerd door een lijst of detailantwoord, wordt eenmaal gecodeerd als één padsegment.

Er worden geen queryparameters ondersteund.

aanvraaginhoud

Gebruik een aanvraag voor het bijwerken van de taakstatus met de vereiste status eigenschap.

status Alleen leveren. Aanvullende/dubbele eigenschappen, een ontbrekende of niet-stringsstatus en ongeldige JSON retourneren 400.

  • New en Complete kan niet worden ingesteld door deze bewerking; Voltooid wordt door het systeem beheerd.
  • Een taak Voltooid kan niet worden gewijzigd door deze bewerking.
  • Negeren is alleen toegestaan wanneer de feed dit toestaat (isIgnorable).
  • Een genegeerde taak kan genegeerd blijven of opnieuw worden geopend naar In uitvoering, maar kan niet rechtstreeks naar Gereed voor revisie worden verplaatst.
  • De server controleert de gelijktijdigheid intern. Een clientheader If-Match is niet vereist voor dit eindpunt. De geretourneerde versie is geen gedocumenteerde clientvoorwaarde.

Vraag om voorbeeld

PUT https://api.partnercenter.microsoft.com/v1/compliance/tasks/usage-anomaly-detection%3A%3A11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222/status HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
MS-CorrelationId: cccccccc-cccc-4ccc-8ccc-cccccccccccc
MS-RequestId: dddddddd-dddd-4ddd-8ddd-dddddddddddd

{
  "status": "In Progress"
}

REST-antwoord

Als dit lukt, retourneert deze methode 200 OK en resulteert een taakstatusupdate in de hoofdtekst van het antwoord. De ETag antwoordheader komt overeen met de geretourneerde versie.

Voorbeeld van antwoord

{
  "taskId": "usage-anomaly-detection::11111111-1111-4111-8111-111111111111-22222222-2222-4222-8222-222222222222",
  "status": "In Progress",
  "lastModifiedDate": "2026-10-01T12:05:00.000Z",
  "version": "\"44444444-4444-4444-8444-444444444444\""
}

Important

Een statusupdate registreert een werkstroomwijziging; het onderliggende probleem wordt niet zelf opgelost. Bij een conflict, time-out of reactie waarin wordt aangegeven dat de update niet kan worden bevestigd, moet u de taak ophalen voordat u beslist of u het opnieuw wilt proberen. Sommige fouten kunnen optreden nadat de bronstatus al is opgeslagen. Een PUT niet blind afspelen.

Geslaagde antwoorden en foutcodes

Zie rest-foutcodes voor Partnercentrum voor algemene richtlijnen. De volgende gevallen zijn specifiek voor deze bewerkingen:

HTTP-status Betekenis/ clientactie
200 Geslaagde lijst, detail, evaluatie of statusupdate.
400 Ongeldige id, niet-ondersteunde/herhaalde queryparameter, ongeldig filter-/paginaformaat/vervolg, ongeldige hoofdtekst of niet-toegestane statusovergang. Corrigeer de aanvraag; paginering opnieuw starten voor ongeldige vervolgen.
401 Verificatie ontbreekt/is ongeldig, aanvullende verificatie is vereist of MFA ontbreekt. Haal een geschikt geverifieerd gebruikerstoken op.
403 De beller is geen ondersteunde gedelegeerde partnergebruiker, tenantvalidatie mislukt of de machtiging wordt geweigerd.
404 De taak is niet zichtbaar voor de geverifieerde partner/in een actieve feed of de API is niet ingeschakeld.
409 Gelijktijdige wijziging of bronsynchronisatie kan niet worden bevestigd. Vernieuw de taak voordat u het opnieuw probeert.
415 De PUT-aanvraag ontbreekt het vereiste JSON-inhoudstype.
503 Nalevingsgegevens, autorisatie, pagineringsopslag of een vereiste afhankelijkheid zijn tijdelijk niet beschikbaar. Voor schrijfbewerkingen inspecteert u het antwoord en vernieuwt u het voordat u het opnieuw probeert.

Voorbeeld van de hoofdtekst taak die niet is gevonden:

{
  "code": 600026,
  "description": "Compliance task not found.",
  "source": "PCFraudEvents"
}

Gewone nalevingsfouten maken gebruik van de foutresource . Verificatie/MFA-fouten en front-doorfouten kunnen verschillende lichamen gebruiken. Antwoorden ingesteld Cache-Control: no-store, private en Vary: Authorization.

Troubleshooting

Controleer de aanvraag-URL, API-versie, headers en JSON-opmaak wanneer een aanvraag mislukt. Gebruik de HTTP-statuscode en antwoordtekst samen om de volgende actie te bepalen. Zie Test en foutopsporing voor algemene richtlijnen voor REST-foutopsporing.

Noteer de aanvraagtijd, bewerking, HTTP-status en aanvraag- en correlatie-id's, zodat een mislukte aanroep kan worden getraceerd. Beveilig toegangstokens bij het vastleggen van logboeken of netwerktraceringen.

Gebruik voor lijstaanvragen de geretourneerde niet-geretourneerde @odata.nextLink aanvragen. Start opnieuw vanaf de eerste aanvraag als een vervolg verloopt. Voor statusupdates met een onzeker resultaat haalt u de huidige status van de taak op voordat u het opnieuw probeert.

  • Laatst bijgewerkt om