Definition af installationsplan

Denne artikel indeholder en oversigt over definitionsstrukturerne for elementer i udrulningsplanen. En udrulningsplan styrer den rækkefølge, elementerne installeres i, og definerer handlinger, der skal køres før eller efter udrulning af elementer.

Definitionsdele

I denne tabel vises definitionsdelene for udrulningsplanen.

Sti til definitionsdel Type Required Beskrivende tekst
plan.yml DeploymentPlan (YAML) ✅ Beskriver udrulningsplanen.
.platform PlatformDetails (JSON) ❌ Beskriver metadataene for elementet.

Installationsplan

Beskriver en udrulningsplan.

Name Type Required Beskrivende tekst
$schema String ✅ URL-adressen til JSON-skemaet for definitionen af udrulningsplanen.
version String ✅ Definitionsversionen for installationsplanen.
groups DeploymentGroup[] ✅ Samlingen af udrulningsgrupper.

DeploymentGroup

Beskriver en udrulningsgruppe, der repræsenterer det element, der er identificeret af logicalId.

Name Type Required Beskrivende tekst
name String ✅ Navnet på installationsgruppen.
logicalId Streng (GUID) ✅ Det logiske id for det udrullede element.
dependsOn GroupDependency[] ❌ Afhængighederne for udrulningsgruppen.
preActions DeploymentAction[] ❌ De handlinger, der skal køres, før elementet installeres.
postActions DeploymentAction[] ❌ De handlinger, der skal køres, når elementet er installeret.

GroupDependency

Beskriver en afhængighed af en udrulningsgruppe.

Name Type Required Beskrivende tekst
groupName String ✅ Navnet på en gruppe, som denne gruppe afhænger af.

Installationshandling

Beskriver en installationshandling.

Name Type Required Beskrivende tekst
name String ✅ Navnet på handlingen.
job DeploymentJob ✅ Det job, der skal køres for handlingen.

DeploymentJob

Beskriver et installationsjob.

Name Type Required Beskrivende tekst
type String ✅ Den offentligt tilgængelige jobtype, der understøttes af det element, der refereres til af logicalId. I forbindelse med udførelse af standardelement skal du bruge Execute. Tjenesten fortolker den til elementtypens interne jobimplementering. En jobtype, der ikke understøttes, medfører, at udførelsen af installationen mislykkes. Du kan se understøttede elementtyper under Elementtyper, du kan køre som en handling.
logicalId Streng (GUID) ✅ Det logiske id for det element, hvis job køres.

plan.yml eksempel

$schema: https://developer.microsoft.com/json-schemas/fabric/item/deploymentPlan/definition/plan/1.0.0/schema.json
version: 1.0.0
groups:
  - name: group1
    logicalId: aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
    preActions:
      - name: preAction1
        job:
          type: Execute
          logicalId: bbbbbbbb-1111-2222-3333-cccccccccccc
    postActions:
      - name: postAction1
        job:
          type: Execute
          logicalId: dddddddd-3333-4444-5555-eeeeeeeeeeee
  - name: group2
    logicalId: cccccccc-2222-3333-4444-dddddddddddd
    dependsOn:
      - groupName: group1

Overvejelser og begrænsninger

  • Det er kun de elementtyper, der er angivet i Elementtyper, som du kan køre som en handling , der kan refereres til af preActions og postActions.
  • groupName i en gruppeafhængighed skal svare til for name en anden gruppe i den samme plan.yml fil.

Eksempel på definition

{
  "parts": [
    {
      "path": "plan.yml",
      "payload": "<base64 encoded string>",
      "payloadType": "InlineBase64"
    },
    {
      "path": ".platform",
      "payload": "<base64 encoded string>",
      "payloadType": "InlineBase64"
    }
  ]
}
  • Sidst opdateret den