Delen via

Een OEM-toepassing registreren tijdens het imaging-proces

Belangrijk

Universal Orchestrator biedt functionaliteit voor OEM's om een toepassing te registreren tijdens het imaging-proces om een eenmalige versnelde installatie of update uit te voeren. Deze installatie vindt plaats binnen 30 minuten nadat een gebruiker zich aanmeldt bij een nieuw apparaat. Het versnellen van een toepassing kan een negatieve invloed hebben op de prestaties van de out-of-box-ervaring voor nieuwe apparaten.

Deze functionaliteit is beschikbaar in:

  • Windows 11 23H2 - KB5046732 (os build 22631.4541)
  • Windows 11 24H2 - KB5046740 (OS Build 26100.2454)
  • Windows 11 25H2 en nieuwere Versies van Windows

Eisen

Als u het versnelde app-framework wilt aansluiten, moet de app voldoen aan de volgende vereisten:

  • Het moet een app in MSIX-indeling voor de Store zijn.
  • Het moet een geldige productfamilienaam (PFN) hebben

Registratie

Registratiebestanden zijn ASCII JSON-bestanden die metagegevens bevatten met informatie over het gewenste versnelde proces en eventuele aangepaste targeting aan de clientzijde die moet worden uitgevoerd.

Versnelde apps ondersteunen twee mechanismen voor het bijwerken/verkrijgen van een app:

  1. In de Microsoft Store met behulp van een product-id (aanbevolen)
  2. Van een URL die een MSIX-pakket of -bundel bevat. Dit pakket moet een Store-app bevatten met een geldige Package Family Name (PFN). De OEM- of app-eigenaar is verantwoordelijk voor het onderhouden van deze URL.

Elk registratiebestand moet de volgende vereiste JSON-eigenschappen bevatten:

Sleutel Soort Beschrijving
PFN Snaar De familienaam van het pakket van de app (voorbeeld: Microsoft.WindowsStore_8wekyb3d8bbwe)
OEMName Snaar Tekenreeks die de OEM beschrijft die deze registratie verzorgt
UpdaterName Snaar Unieke naam om deze versnelde registratie bij te houden
Registratieversie Getal De versie van deze app-registratie
Bron Snaar Toegestane waarden:

Store | AangepasteURL

Store: zoekt rechtstreeks vanuit de Microsoft Store naar de app

CustomURL: zoekt naar de app op basis van een URL die is opgegeven in de waarde eindpunt van de app-registratie
Scenario Snaar Toegestane waarden:

Bijwerken | Overname | StubAcquisition

Update : (niet ondersteund voor CustomURL-stromen) probeert een bestaande app bij te werken naar de nieuwste beschikbare versie. Er wordt geen werk gedaan als de app niet aanwezig is

Overname: probeert de nieuwste versie van een app te verkrijgen.

StubAcquisition - probeert een 'stub' van de app te verkrijgen (als deze beschikbaar is). Hiermee verkrijgt u de volledige app als de stub niet beschikbaar is.
ProductId Snaar (Alleen vereist voor Store-scenario's)

De ProductId van de gewenste Store-app
Eindpunt Snaar (Alleen vereist voor CustomURL-scenario's)

Een tekenreeks-URI die verwijst naar een locatie die als host fungeert voor een MSIX-pakket. Moet een SSL-URI zijn die begint met https.

Daarnaast kunnen de volgende optionele eigenschappen worden opgegeven om het gedrag van de versnelde app-installatie te wijzigen of om de versnelde stroom alleen onder bepaalde voorwaarden te laten plaatsvinden.

Sleutel Soort Verstek Beschrijving
ToegestaanInOobe Booleaans Onwaar Of deze snelle app moet worden uitgevoerd tijdens de eerste gebruikerservaring (OOBE) van de gebruiker.

Belangrijk: Wees voorzichtig bij het instellen op true, omdat dit resourcebeperkingen op een apparaat kan veroorzaken tijdens de Out of Box Experience-procedure en de prestaties zoals de gebruiker ervaart negatief kan beïnvloeden.
MaxRetryCount (Maximaal Herhalingsaantal) Getal 1 Het aantal keren dat deze updater opnieuw mag proberen na een fout.

Maximum toegestane waarde is: 5
TimeoutduurInMinuten Getal 15 De duur in minuten om te wachten totdat deze updater het werk heeft voltooid.

Maximum toegestane waarde is: 30
Architectuur Snaar Geen beperking Toegestane waarden:

amd64 | arm64

Hiermee geeft u op of het versnelde werk alleen moet plaatsvinden voor een specifieke architectuur.
MinimumToegestaneBouwversie Getal Geen beperking Minimale Windows-buildversies waarbij het versnelde werk is toegestaan.

Als dit bijvoorbeeld is ingesteld op 22631, is versneld werk toegestaan voor Windows 11 23H2 (10.0.22631.x), maar geblokkeerd voor Windows 11 22H2 (10.0.22621.x)
HonorDeprovisioning Booleaans Onwaar (Alleen van toepassing op overnamescenario's)

Als de provisioning van de app eerder ongedaan is gemaakt, probeer deze dan niet opnieuw te verkrijgen.
OverslaanIndienAanwezig Booleaans Onwaar (Alleen van toepassing op overnamescenario's)

Voer het versnelde werk niet uit als er al een versie van de app aanwezig is.
Voorrang Getal 100 Een numerieke waarde van 1 - 100 om de relatieve prioriteit van deze toepassingsupdate aan te geven.

Lagere waarden geven een hogere relatieve prioriteit aan voor andere versnelde apps.
Uitgesloten regio's Array (tekenreeks) Geen beperkingen Een JSON-matrix met tekenreeksen voor regio's waarin deze app NIET moet worden versneld.

Elke vermelding in de matrix komt overeen met de iso 3166-1-landcode van de twee letters van de gewenste regio.

Voorbeeld: ["US", "MX"] zou deze stroom voorkomen op apparaten waar de regio Verenigde Staten of Mexico is.

Deze waarde kan niet worden gebruikt met IncludedRegions.
Opgenomen regio's Array (tekenreeks) Geen beperkingen Een JSON-matrix met tekenreeksen die duiden op een acceptatielijst met regio's waar deze app moet worden versneld.

Elke vermelding in de matrix komt overeen met de iso 3166-1-landcode van de twee letters van de gewenste regio.

Voorbeeld: ["US", "MX"] staat deze stroom alleen toe op apparaten waar de regio Verenigde Staten of Mexico is.

Deze waarde kan niet worden gebruikt met ExcludedRegions.
InbegrepenEdities Array (nummer) Geen beperkingen Een JSON-matrix met getallen die een acceptatielijst aangeven van edities waarin deze app moet worden versneld.

Elke vermelding in de matrix komt overeen met de editiecode die is opgehaald door de GetProductInfo-API.

Voorbeeld: [121, 122] om alleen Education- en EducationN-edities op te nemen

Deze waarde kan niet worden gebruikt met ExcludedEditions.
UitgeslotenEdities Array (nummer) Geen beperkingen Een JSON-matrix met getallen voor edities waarin deze app niet moet worden versneld.

Elke vermelding in de matrix komt overeen met de editiecode die is opgehaald door de GetProductInfo-API.

Voorbeeld: [121, 122] om Education en EducationN edities uit te sluiten.

Deze waarde kan niet worden gebruikt met IncludedEditions.

Voorbeelden

Winkelgebaseerde stub-acquisitie, alleen in de VS en Mexico, uit te voeren tijdens OOBE

{  
    "OEMName": "Contoso",
    "UpdaterName": "OEMApp1",
    "RegistrationVersion":1,  
    "Source": "Store",  
    "Scenario": "StubAcquisition",  
    "PFN": "FakePackageFamilyName",  
    "ProductId": "StoreProductId",  
    "HonorDeprovisioning": true,  
    "AllowedInOobe": true,  
    "IncludedRegions": ["US", "MX"],  
    "Priority": 50  
}

URL-gebaseerde verwerving van apps op amd64-apparaten, met uitzondering van de Education- en EducationN-edities, alleen in Windows 11 versie 23H2 (not Windows 11 22H2)

{  
    "OEMName": "Contoso",
    "UpdaterName": "OEMApp1",
    "RegistrationVersion":2,  
    "Source": "CustomURL",  
    "Scenario": "Acquisition",  
    "PFN": "FakePackageFamilyName",  
    "Endpoint": "https://<SSL_URI>",   
    "ExcludedEditions": [121, 122],   
    "Architecture": "amd64",   
    "MinimumAllowedBuildVersion": 22631,  
    "Priority": 60 
}

Gereedschap

Om het registratieproces te vergemakkelijken en bruikbare feedback te geven over de registratie-metagegevens, moeten OEM's de PowerShell-scripts van AppOrchestration en gebruiken vanaf de volgende locatie:

microsoft/ms-update-universalorchestrator: Scripts en hulpprogramma's voor onboarding van updatestromen op basis van Universal Orchestrator

De scripts voeren basisvalidatie uit en faseren de registratie naar de juiste locatie op het apparaat. Bij eventuele fouten genereren de scripts een uitzondering met de specifieke foutdetails.

De scripts gebruiken:

  1. Download de scripts naar uw apparaat. Op de gitHub-opslagplaatspagina kunt u ervoor kiezen om te downloaden als een ZIP-bestand en uit te pakken op uw apparaat
  2. Voer in een PowerShell-venster 'Import-Module <PathToScripts>\scripts\AppOrchestration.psd1' uit

Notitie

Deze scripts vereisen dat de gebruiker beheerdersbevoegdheden op het apparaat heeft en moet worden uitgevoerd vanuit een console met verhoogde bevoegdheid.

Er worden vier belangrijkste cmdlets gebruikt voor het registratieproces.

<Test-UpdaterRegistration PathToRegistrationFile>
Doel: De inhoud van een voorgesteld registratiebestand valideren (zonder registratie uit te voeren). Hiermee kan de OEM herhaaldelijk wijzigingen aanbrengen in de payload van het registratiebestand zonder dat dit invloed heeft op het apparaat.

Add-UpdaterRegistration <PathToRegistrationFile>
Doel: De inhoud van een registratiebestand op de juiste locatie valideren en faseren om de onboarding naar de versnelde app-stroom te realiseren.

Get-UpdaterRegistratie <OEMNaam><UpdaterNaam>
Doel: Als OEMName en UpdaterName worden opgegeven, retourneert u een samenvatting van een bestaande registratie die overeenkomt met deze waarden. Als deze invoer wordt weggelaten, retourneert u een samenvatting van alle huidige registraties die aanwezig zijn op het apparaat.

<Remove-UpdaterRegistration OEMName><UpdaterName>
Doel: Annuleer elke registratie die overeenkomt met OEMName en UpdaterName.

Uitvoering

Het Universal Orchestrator-framework roept automatisch elk van de geregistreerde apps op volgorde aan op basis van relatieve prioriteit, binnen de eerste 30 minuten van een gebruiker die het bureaublad bereikt op een nieuw apparaat (of tijdens User OOBE als AllowedInOobe is ingesteld op true). Elke geregistreerde toepassing die door het OEM-registratieproces wordt toegevoegd, wordt geprobeerd tot:

  • Het is succesvol geïnstalleerd
  • Het overschrijdt het maximum aantal fouten dat is opgegeven in MaxRetryCount. Na elke fout voert de app een afkoelperiode van 30 minuten in voordat deze opnieuw wordt geprobeerd.

Het Universal Orchestrator-framework voert geen versnelde pogingen uit als aan een van de volgende voorwaarden wordt voldaan:

  • Het apparaat heeft geen internettoegang.
  • Het apparaat bevindt zich op een netwerk met datalimiet.
  • Het apparaat bevindt zich op de batterij en de batterijbesparing is ingeschakeld.
  • Het apparaat is geconfigureerd met een beleid voor beperkt netwerkverkeer van Windows Update.
  • Het apparaat is geconfigureerd met een CTA-beleid dat niet is ingesteld voor AutoApprove.

In elk van deze gevallen bewaart het Universal Orchestrator-framework de registraties totdat de apparaatconfiguratie versnelde pogingen toestaat om door te gaan.

Als de app-registratie optionele waarden bevat die de versnelde stroom blokkeren (bijvoorbeeld vanwege het editietype), wordt in het Universal Orchestrator-framework van oordeel dat aan deze registratieaanvraag is voldaan en wordt deze niet opnieuw geprobeerd, zelfs niet als deze voorwaarden later op een apparaat kunnen worden gewijzigd.

Belangrijk

Wees voorzichtig bij het versnellen van apps via dit framework, omdat de updatebewerkingen optreden wanneer het apparaat mogelijk in gebruik is en een negatieve invloed kan hebben op de prestaties van de gebruikerservaring op een nieuw apparaat.

  • Last updated on