Neues Versandetikett erstellen

Verwenden Sie diese Methode in der Microsoft Hardware-API, um ein neues Versandetikett zu erstellen. Bevor Sie dies verwenden, stellen Sie sicher, dass Sie ein Produkt erstellt und dafür eine Einreichung erstellt haben. Ausführliche Informationen finden Sie unter Erstellen eines Produkts und Erstellen einer Übermittlung.

Voraussetzungen

Falls noch nicht geschehen, führen Sie alle prerequisites für die Microsoft Hardware-APIs aus, bevor Sie versuchen, eine dieser Methoden zu verwenden.

Anforderung

Diese Methode weist die folgende Syntax auf. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen des Headers und des Anforderungstexts.

Methode Anforderungs-URI
POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels

Die productID und submissionID in der Methode stellen die Übermittlung dar, für die das Versandetikett erstellt werden soll.

Anforderungs-Header

Header Typ Beschreibung
Autorisierung String Required. Das Microsoft Entra ID-Zugriffstoken in der Form Bearer<token>.
Akzeptieren String Dies ist optional. Gibt den Inhaltstyp an. Zulässiger Wert ist "application/json"

Anforderungsparameter

Stellen Sie keine Anforderungsparameter für diese Methode bereit.

Anforderungstext

Im folgenden Beispiel wird der JSON-Anforderungstext zum Erstellen einer neuen Versandbezeichnung veranschaulicht.

{
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793Z",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "manualAcquisition": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    }
  },
  "targeting": {
    "hardwareIds": [
      {
        "bundleId": "3aba7558-10ca-42db-b1d1-57af5718aea3",
        "infId": "foo.inf",
        "operatingSystemCode": "WINDOWS_v100_RS3_FULL",
        "pnpString": "hid\\vid_dummy256f&pid_dummyc62f"
      }
    ],
    "chids": [
      {
        "chid": "346511cf-ccee-5c6d-8ee9-3c70fc7aae83",
        "distributionState": "pendingAdd"
      }
    ],
    "restrictedToAudiences": [
      "00000000-0000-0000-0000-000000000001",
      "00000000-0000-0000-0000-000000000002"
      ],
    "inServicePublishInfo": {
      "flooring": "RS1",
      "ceiling": "RS3"
    }
  },
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Das folgende Beispiel veranschaulicht, wenn das Zielein andererPartner ist, akzeptiert das recipientSpecifications-Objekt jetzt blockDuaCreation:

{
    "recipientSpecifications": {
        "receiverPublisherId": "27691110",
        "enforceChidTargeting": false,
        "blockDuaCreation": true
    },
    "targeting": { ... },
    "name": "Sharing Label Name",
    "destination": "anotherPartner"
}

Ausführliche Informationen zu den Feldern in der Anforderung finden Sie in der ShippingLabel-Ressource.

Punkte, die beim Erstellen von Versandetiketten zu beachten sind

  • Beim Veröffentlichen in Windows Update (destination ist windowsUpdate), müssen Sie ein objekt publishingSpecifications einschließen. Für automatische Installationen (isAutoInstallDuringOSUpgrade oder isAutoInstallOnApplicableSystems ist wahr) müssen Sie additionalInfoForMsApproval festlegen.
  • wenn in der Versandbezeichnung isAutoInstallDuringOSUpgrade oder isAutoInstallOnApplicableSystems auf „true“ gesetzt ist, dann muss manualAcquisition auf „false“ gesetzt sein, und der Treiber wird mit auf „false“ gesetzter Option „Kann Benutzereingaben anfordern“ veröffentlicht.
  • wenn in der Versandbezeichnung isAutoInstallDuringOSUpgrade und isAutoInstallOnApplicableSystems false sind, dann muss manualAcquisition true sein, und der Treiber wird mit „Kann Benutzereingaben anfordern“ auf true gesetzt veröffentlicht.
  • Beim Teilen mit anderen Partnern (Ziel ist ein andererPartner) müssen Sie das recipientSpecifications-Objekt einschließen.
  • Das recipientSpecifications-Objekt unterstützt ein optionales BlockDuaCreation-Feld (Standard false). Bei Festlegung auf "true" kann der empfangende Partner die DUA-Shell nicht herunterladen oder abgeleitete (DUA)-Übermittlungen aus diesem freigegebenen Inhalt erstellen.

Auffüllen von Zielinformationen

Das objekt targeting enthält Daten, die Windows Update zu folgendem Thema anweisen:

  • Wie der Treiber in Bezug auf Hardware-IDs ausgerichtet werden soll.

  • Ob CHID oder Einschränkungen angewendet werden sollen.

Das Hardware-ID-Objekt sollte beim Erstellen einer neuen Versandbezeichnung eine gültige Kombination aus Bundle-ID, PNP-ID, Betriebssystemcode und INF-Namen enthalten. Laden Sie die Treibermetadatendatei (als Link bereitgestellt, wenn Sie Details zu einer Übermittlung erhalten) herunter, um die zulässigen, gültigen Kombinationen dieser Attribute für Ihre Übermittlung abzurufen. Weitere Informationen finden Sie unter Treiberpaketmetadaten.

Beispiele anfordern

Im folgenden Beispiel wird das Erstellen eines neuen Produkts veranschaulicht.

POST https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/{productID}/submissions/{submissionId}/shippingLabels HTTP/1.1
Authorization: Bearer <your access token>

Antwort

Das folgende Beispiel veranschaulicht den JSON-Antworttext, der von einer erfolgreichen Anforderung zum Erstellen einer Versandbezeichnung zurückgegeben wird. Details zu den Werten im Antworttext werden in der Tabelle nach dem Beispiel angezeigt.

{
  "id": 1152921504606997500,
  "productId": 14461751976964156,
  "submissionId": 1152921504621467600,
  "publishingSpecifications": {
    "goLiveDate": "2018-02-22T06:50:54.793+00:00",
    "visibleToAccounts": [
      27691110,
      27691111
    ],
    "isAutoInstallDuringOSUpgrade": true,
    "isAutoInstallOnApplicableSystems": false,
    "isDisclosureRestricted": false,
    "publishToWindows10s": true,
    "additionalInfoForMsApproval": {
      "microsoftContact": "abc@microsoft.com",
      "validationsPerformed": "Validation 1",
      "affectedOems": [
        "OEM1",
        "OEM2"
      ],
      "isRebootRequired": false,
      "isCoEngineered": false,
      "isForUnreleasedHardware": false,
      "hasUiSoftware": false,
      "businessJustification": "This is a business justification"
    },
    "manualAcquisition": false
  },
  "workflowStatus": {
    "currentStep": "preProcessShippingLabel",
    "state": "notStarted",
    "messages": []
  },
  "links": [
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "https://manage.devcenter.microsoft.com/v2.0/my/hardware/products/14461751976964157/submissions/1152921504621467613/shippingLabels/1152921504606997603",
      "rel": "update_shippinglabel",
      "method": "PATCH"
    }
  ],
  "name": "Shipping Label Name",
  "destination": "windowsUpdate"
}

Antwortkörper

Details zum Antworttextkörper finden Sie in der Versandetikett-Ressource.

Fehlercodes

Informationen zu Fehlercodes finden Sie unter Fehlercodes.

Siehe auch

Beispiele für hardwaredashboard-API (GitHub)

  • Last updated on