Erstellen einer neuen Versandbezeichnung

Artikel
12/08/2023

Verwenden Sie diese Methode in der Microsoft-Hardware-API , um ein neues Versandetikett zu erstellen. Stellen Sie vor der Verwendung dieses Produkts sicher, dass Sie ein Produkt erstellt und eine Übermittlung für dieses Produkt erstellt haben. Weitere Informationen finden Sie unter Erstellen eines Produkts und Erstellen einer Übermittlung.

Voraussetzungen

Wenn Sie dies noch nicht getan haben, müssen Sie alle Voraussetzungen für die Microsoft-Hardware-APIs erfüllen, bevor Sie versuchen, eine dieser Methoden zu verwenden.

Anforderung

Diese Methode hat die folgende Syntax. In den folgenden Abschnitten finden Sie Verwendungsbeispiele und Beschreibungen des Header und 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.

Anforderungsheader

Header	type	BESCHREIBUNG
Authorization	String	Erforderlich. Der Microsoft Entra ID-Zugriffstoken im Format Bearertoken<>.
Akzeptieren	String	Optional. Gibt den Typ des Inhalts an. Zulässiger Wert ist "application/json"

Anforderungsparameter

Geben Sie keine Anforderungsparameter für diese Methode an.

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"
}

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

Punkte, die beim Erstellen von Versandetiketten zu beachten sind

Beim Veröffentlichen in Windows Update (Ziel ist windowsUpdate) müssen Sie ein publishingSpecifications-Objekt einschließen. Für automatische Installationen (isAutoInstallDuringOSUpgrade oder isAutoInstallOnApplicableSystems ist true), müssen Sie additionalInfoForMsApproval festlegen.
Wenn in der Versandbezeichnung isAutoInstallDuringOSUpgrade oder isAutoInstallOnApplicableSystems true ist, muss manualAcquisition false sein, und der Treiber wird veröffentlicht, wobei "Benutzereingabe anfordern darf" auf false festgelegt ist.
Wenn in der Versandbezeichnung isAutoInstallDuringOSUpgrade und isAutoInstallOnApplicableSystems false sind, muss manualAcquisition true sein, und der Treiber wird veröffentlicht, wobei "Benutzereingabe anfordern darf" auf true festgelegt ist.
Bei der Freigabe für andere Partner (destination ist ein andererPartner) müssen Sie das recipientSpecifications-Objekt einschließen.

Auffüllen von Zielinformationen

Das Zielobjekt enthält Daten, die Windows Update zu Folgendem anweisen:

Wie der Treiber als Ziel in Bezug auf Hardware-IDs verwendet werden soll.
Gibt an, ob CHID oder Einschränkungen angewendet werden sollen.

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

Anforderungsbeispiele

Im folgenden Beispiel wird veranschaulicht, wie Sie ein neues Produkt erstellen.

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

Antwort

Im folgenden Beispiel wird der JSON-Antworttext veranschaulicht, 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"
}

Antworttext

Ausführliche Informationen zum Antworttext finden Sie unter Versandetikettenressource.

Fehlercodes

Informationen zu Fehlercodes finden Sie unter Fehlercodes.

Weitere Informationen

Beispiele für die Hardware-Dashboard-API (GitHub)

Freigeben über