Megosztás a következőn keresztül:

Bővítményjegyzék referenciája

  • Cikk

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Minden bővítmény rendelkezik egy JSON-jegyzékfájllal, amely alapvető információkat határoz meg a bővítményről. A fájl azt is meghatározza, hogyan bővítheti és javíthatja a felhasználói élményt. Ez a cikk bemutatja, hogyan hozhat létre jegyzékfájlt az Azure DevOps-bővítményhez.

Tipp.

Tekintse meg a bővítményfejlesztéssel kapcsolatos legújabb dokumentációnkat az Azure DevOps Extension SDK használatával.

Hozzon létre egy fájlt vss-extension.json a bővítménymappa gyökerénél. Ez a fájl olyan szükséges attribútumokat tartalmaz, mint a bővítmény azonosítója és telepítési céljai, ahol futtatható. Emellett meghatározza a bővítmény által végzett hozzájárulásokat is.

Tekintse meg a következő példát egy tipikus jegyzékre:

{
    "manifestVersion": 1,
    "id": "tools",
    "version": "0.1.0",
    "name": "Fabrikam Tools",
    "publisher": "fabrikam",
    "description": "Awesome tools to help you and your team do great things everyday.",
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "icons": {
        "default": "images/fabrikam-logo.png"
    },
    "scopes": [
        "vso.work",
        "vso.code_write",
        "vso.build_execute"
    ],
    "categories": [
        "Azure Boards"
    ],
    "branding": {
        "color": "rgb(34, 34, 34)",
        "theme": "dark"
    },
    "content": {
        "details": {
            "path": "readme.md"
        },
        "license": {
            "path": "eula.md"
        }
    },
    "links": {
        "getstarted": {
            "uri": "https://www.fabrikam-fiber-inc.com/help/getstarted"
        },
        "support": {
            "uri": "https://www.fabrikam-fiber-inc.com/support"
        }
    },
    "repository": {
        "type": "git",
        "uri": "https://github.com/fabrikam-fiber-inc/myextension"
    },
    "contributions": [
        {
            "id": "showCommits",
            "type": "ms.vss-web.action",
            "description": "Adds a menu action from builds grid to show associated items.",
            "targets": [
                "ms.vss-build-web.completed-build-menu"
            ],
            "properties": {
                "title": "View associated items",
                "uri": "launch.html"
            }
        }
    ],
    "files": [
        {
            "path": "launch.html",
            "addressable": true
        },        
        {
            "path": "node_modules/vss-web-extension-sdk/lib",
            "addressable": true,
            "packagePath": "lib"
        }
    ]
}

További információ a bemenetekről: ...

Szükséges attribútumok

Ezekre a tulajdonságokra van szükség:

Tulajdonság Leírás Jegyzetek
manifestVersion A jegyzékformátum verziójának megfelelő szám. Itt a 1 értéknek kell szerepelnie.
Azonosító A bővítmény azonosítója. Az azonosító egy olyan sztring, amely egyedinek kell lennie az ugyanazon közzétevő bővítményei között. Betűrendes vagy numerikus karakterrel kell kezdődnie, és tartalmaznia kell az "A" karaktert a Z-n, az "a" a z-n keresztül, a "0"-t a 9-ig és a "-" (kötőjelet). Példa: sample-extension
verzió Egy bővítmény verzióját meghatározó sztring. Formátumnak major.minor.patchkell lennie például 0.1.2 vagy 1.0.0. A következő formátumhoz egy negyedik számot is hozzáadhat: 0.1.2.3
név A bővítmény rövid, ember által olvasható neve. Legfeljebb 200 karakter hosszúságú lehet. Példa: "Fabrikam Agile Board Extension"
kiadó A közzétevő azonosítója. Ennek az azonosítónak meg kell egyeznie a bővítmény által közzétett azonosítóval. Lásd: Közzétevő létrehozása és kezelése.
Kategóriák A bővítmény kategóriáit képviselő sztringek tömbje. Legalább egy kategóriát meg kell adni, és nincs korlátozva, hogy hány kategóriát tartalmazzon. Érvényes értékek: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plansés Azure Artifacts.

Megjegyzések:
    - Használja a tfx-cli =0.6.3 verzióját >, ha programozott módon teszi közzé a bővítményt.
    - Ha az Azure DevOps Extension Tasks bővítményt használja a közzétételhez, győződjön meg arról, hogy annak >verziója = 1.2.8. Előfordulhat, hogy a hatókör legutóbbi változásai miatt jóvá kell hagynia a bővítményfrissítést.
    – A korábban említett kategóriák natív módon jelennek meg a Visual Studio Marketplace-en és az Azure DevOps Server 2019-ben >. A TFS korábbi verzióit célzó bővítmények esetén:
      – Ha a TFS-ügyfelek a Visual Studio Marketplace-en keresztül szerezik be a bővítményt (nem a helyi katalógust) csatlakoztatott környezetben, akkor a korábban megadott kategóriákat kell használniuk.
      - Ha közvetlenül (azaz nem a Visual Studio Marketplace-en keresztül) szeretné megosztani a bővítményt egy ügyféllel a TFS <=2018 használatával, akkor használja inkább a következő kategóriákat: Kód, Tervezés és nyomon követés, Build és kiadás, Tesztelés, Együttműködés és Integráció. Ha mind a Visual Studio Marketplace-en, mind közvetlenül egy TFS <= 2018-ügyféllel kell megosztania, akkor 2 bővítménycsomaggal kell rendelkeznie.
Célok Az integráció vagy a bővítmény által támogatott termékek és szolgáltatások. További információkért tekintse meg a telepítési célokat. Objektumok tömbje, ahol minden objektumnak van egy id mezője, amely az alábbiak egyikét jelzi:
    - Microsoft.VisualStudio.Services(Az Azure DevOps vagy TFS használatával működő bővítmények),
    Microsoft.TeamFoundation.Server- (A TFS-sel működő bővítmények),- Microsoft.VisualStudio.Services.Integration
    (az Azure DevOps vagy a TFS használatával működő integrációk)
    - Microsoft.TeamFoundation.Server.Integration (a TFS-sel működő integrációk)

Példák a szükséges attribútumokra

{
    "manifestVersion": 1,
    "id": "tools",
    "version": "0.1.0",
    "name": "Fabrikam Tools",
    "publisher": "fabrikam",
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ]
}

Választható attribútumok

Futtatókörnyezeti attribútumok

Tulajdonság Leírás Jegyzetek
Hatókörök A bővítmény által igényelt engedélyeket felsoroló engedélyezési hatókörök (sztringek) tömbje. Például azt jelzi, vso.work hogy vs.code_write a bővítménynek írásvédett hozzáférésre van szüksége a munkaelemekhez, valamint olvasási/írási hozzáférést a forráskódhoz (és a kapcsolódó erőforráshoz). A bővítmény telepítésekor a hatókörök megjelennek a felhasználó számára. További információkért tekintse meg a hatókörök teljes listáját.
Igények A bővítmény által igényelt képességeket felsoroló követelmények (sztringek) tömbje. Például azt jelzi, api-version/3.0 hogy a bővítmény a 3.0-s verziójú API-kat használja, ezért nem futtatható olyan régebbi termékekben, amelyek nem támogatják ezt a verziót. További információkért tekintse meg az igények teljes listáját.
baseUri (Nem kötelező) alap URL-cím a bővítmény közreműködései által megadott összes relatív URL-címhez. Például: https://myapp.com/{{account.name}}/ Ezt a tulajdonságot üresen kell hagyni, ha a bővítmény tartalma a bővítményhez van csomagolva.
Hozzájárulások A rendszerhez való hozzájárulások tömbje.
contributionTypes A bővítmény által definiált hozzájárulástípusok tömbje 
{
    "scopes": [
        "vso.work",
        "vso.code_write",
        "vso.build_execute"
    ],
    "demands": [
        "api-version/3.0"
    ],
    "contributions": [
        {
            "id": "showCommits",
            "type": "ms.vss-web.action",
            "description": "Adds a menu action from builds grid to show associated items.",
            "targets": [
                "ms.vss-build-web.completed-build-menu"
            ],
            "properties": {
                "title": "View associated items",
                "uri": "launch.html"
            }
        }
    ]
}

Felderítési attribútumok

Ezek az opcionális tulajdonságok segítenek a felhasználóknak a bővítmény felderítésében és megismerésében:

Tulajdonság Leírás Jegyzetek
leírás Néhány mondat, amely leírja a bővítményeket. Legfeljebb 200 karakter hosszúságú lehet. A leírásnak a bővítmény "liftpályájának" kell lennie – néhány sor, amely leírja a bővítményt a Marketplace-en, és arra kéri a felhasználókat, hogy telepítsenek. Lásd az alábbi példát
Ikonok A bővítményt jelképező ikonok szótára. Érvényes kulcsok: default (128x128 képpont) BMP, GIF, EXIF, JPG, PNG és TIFF típusúak. A jövőben más kulcsok, például large (512x512 képpont) is támogatottak lehetnek. Az egyes kulcsok értéke a bővítmény ikonfájljának elérési útja
címkét Sztringcímkék tömbje, amelyek segítenek a felhasználóknak megtalálni a bővítményt. Példák: agile, project management, task timerés így tovább.
képernyőképek Olyan képek tömbje, amelyek nem vehetők fel a tartalomba. A képernyőképek akkor lesznek értékesek, ha a tartalomban szerepelnek, és ott érdemes használni, hogy minőségi piaci részletekkel szolgáljon a bővítményhez. Képernyőképeket használjon a kevésbé fontos, a tartalomban nem szereplő képekhez. Minden képnek 1366x768 képpontnak kell lennie. Az path egyes elemek a bővítményben lévő fájl elérési útja.
tartalom A felhasználók bővítményét leíró tartalomfájlok szótára. Minden bővítménynek szilárd tartalmat kell tartalmaznia. Így jelenítheti meg a felhasználóknak, hogy mire képes a bővítmény. Legyen gazdag, használható, és szükség esetén mellékeljen képernyőképeket. Adjon meg egy overview.md fájlt alaptartalom-elemként. A rendszer feltételezi, hogy minden fájl GitHub-stílusú Markdown formátumban van. Az path egyes elemek a bővítmény Markdown-fájljának elérési útja. Érvényes kulcsok: details. A jövőben más kulcsok is támogatottak lehetnek.
Linkek A hivatkozások szótára, amely segít a felhasználóknak a bővítmény további megismerésében, támogatásban és áthelyezésben. Érvényes kulcsok: getstarted – első lépések, beállítás vagy használat. learn - mélyebb tartalom, amely segít a felhasználóknak jobban megérteni a bővítményt vagy a szolgáltatást. license - végfelhasználói licencszerződés. privacypolicy - egy bővítmény adatvédelmi szabályzata. support - segítséget és támogatást kérhet egy bővítményhez. Az egyes kulcsok értéke egy mezővel rendelkező uri objektum, amely a hivatkozás abszolút URL-címe
raktár A bővítmény forráskódtárát leíró tulajdonságok szótára Érvényes kulcsok: type – Az adattár típusa. Példa: git. uri - Az adattár abszolút URL-címe.
Jelvények Külső metaadat-jelvényekre, például TravisCI-re, Appveyorra stb. mutató hivatkozások tömbje a jóváhagyott jelvények webhelyéről Érvényes kulcsok: href – Csatolja a felhasználót a jelvény kiválasztásakor. uri - A megjelenítendő jelvénykép abszolút URL-címe. description - A mutatón megjelenítendő jelvény leírása.
Branding A márkatulajdonságok szótára. Érvényes kulcsok: color - a bővítmény vagy a közzétevő elsődleges színe; lehet hexa (#ff00ff), RGB (rgb(100 200,50)) vagy támogatott HTML-színnevek (kék). theme- kiegészíti a színt; sötét színt használjon a sötét márkajelzéshez, a világosabb arculati színeket pedig világos színekkel.

Bővítmény megjelölése nyilvánosan

Alapértelmezés szerint az Azure DevOps Marketplace összes bővítménye privát. Ezek csak a közzétevő és a közzétevő által megosztott fiókok számára láthatók. Ha a közzétevő ellenőrzése megtörtént, a bővítményt nyilvánossá teheti a Public bővítményjegyzékben lévő jelölő beállításával:

{
    "galleryFlags": [
        "Public"
    ]
}

Or:

{
    "public": true
}

További információ: Csomag/Közzététel/Telepítés.

Bővítmény megjelölése előzetes verzióban

Ha a bővítmény készen áll a Marketplace-felhasználók kipróbálására, de még dolgozik néhány hiba vagy függvény hozzáadásán, megjelölheti a következőként preview:

{
    "galleryFlags": [
        "Preview"
    ]
}

Bővítmény megjelölése fizetős előzetes verzióként

Ha el szeretné adni a bővítményt a Marketplace-en, jelölje meg fizetős előzetes verzióként. Az ingyenesen megjelölt bővítmények nem módosíthatók fizetősre.

{
    "galleryFlags": [
        "Paid",
        "Preview"
    ]
}

Bővítmény megjelölése fizetősként

Ha el szeretné adni a bővítményt a Marketplace-en, megjelölheti a jelölővel és __BYOLENFORCED a Paid címkével (két aláhúzásjellel kezdődik):

{
    "galleryFlags": [
        "Paid"        
    ],
     "tags": [        
        "__BYOLENFORCED"
    ]
}

A jelölőnek és __BYOLENFORCED a Paid címkének is jelen kell lennie ahhoz, hogy egy bővítményt fizetősként jelöljön meg a Marketplace-en. A Bring-Your-Own-License (BYOL) azt jelenti, hogy a bővítmény közzétevője biztosítja a bővítmény számlázási és licencelési mechanizmusát, mivel azt az Azure DevOps-bővítményekhez készült Microsoft nem biztosítja. Minden fizetős bővítményre szükség van az adatvédelmi szabályzat, a támogatási szabályzat és a végfelhasználói licencszerződés meghatározásához. A közzétevőknek az alábbiak szerint kell tartalommal ellátniuk a Marketplace díjszabási lapjának tartalmát:

{
    "content": {
        "details": {
            "path": "overview.md"
        }, 
        "pricing": {
            "path": "pricing.md"
        }
    }
}

A fizetős licencelés felülbírálásához egy új szakaszt is hozzá kell adnia a bővítményjegyzékhez. A jövőben eltávolítjuk a fizetős licencelési ellenőrzést, és már nincs szükség a felülbírálásra. Egyelőre győződjön meg arról, hogy a bővítmény a várt módon jelenik meg. Minden felülbírálás egy azonosítóból és egy "viselkedésből" áll. Az "id" egyezzen a jegyzékben definiált hozzájárulások azonosítójával.

"licensing": {

      "overrides": [

        { "id": "my-hub", "behavior": " AlwaysInclude" }
      ]
    }

Ha a fizetős BYOL-bővítmény próbaidőszakot kínál (ezt javasoljuk), akkor a próbaidőszak hosszát napokban is megadhatja:

{
    "galleryproperties": {
        "trialDays": "30"
    } 
}

Feljegyzés

Ha meg szeretné célozni az Azure DevOps-t, de nem szeretne a bővítmény letöltési lehetőségét megjeleníteni, akkor adja hozzá a __DoNotDownload címkét (két aláhúzásjellel kezdődően) a bővítmény jegyzékfájljához. Ha a microsoftos számlázásról a BYOL-modellre helyezi át a korábban kínált számlázási és licencelési bővítményt, a megfelelő lépésekért forduljon hozzánk.

Példa további tulajdonságokra

{
    "description": "Awesome tools to help you and your team do great things everyday.",
    "icons": {
        "default": "images/fabrikam-logo.png"
    },
    "categories": [
        "Plan and track"
    ],
    "tags": [
        "working",
        "people person",
        "search"
    ],
    "content": {
        "details": {
            "path": "overview.md"
        },
        "license": {
            "path": "license-terms.md"
        }
    },
    "links": {
        "home": {
            "uri": "https://www.fabrikam-fiber-inc.com"
        },
        "getstarted": {
            "uri": "https://www.fabrikam-fiber-inc.com/help/getstarted"
        },
        "learn": {
            "uri": "https://www.fabrikam-fiber-inc.com/features"
        },
        "support": {
            "uri": "https://www.fabrikam-fiber-inc.com/support"
        },
        "repository": {
            "uri": "https://github.com/fabrikam-fiber-inc/tools"
        },
        "issues": {
            "uri": "https://github.com/fabrikam-fiber-inc/tools/issues"
        }
    },
    "repository": {
        "type": "git",
        "uri": "https://github.com/fabrikam-fiber-inc/tools"
    },
    "badges": [
        {
            "href": "https://travis.ci/fabrikam-fiber-inc/myextension",
            "uri": "https://travis.ci/fabrikam-fiber-inc/myextension.svg?branch=master",
            "description": "TravisCI build for the project"
        },
        {
            "href": "https://ci.appveyor.com/projects/fabrikam-fiber-inc/myextension",
            "uri": "https://ci.appveyor.com/api/projects/status/vlg2sgs2y7tsdxpj4c?svg=true",
            "description": "AppVeyor build for the project"
        }
    ],
    "branding": {
        "color": "rgb(34, 34, 34)",
        "theme": "dark"
    },
    "screenshots": [
        {
            "path": "screenshots/screen1.png"
        },
        {
            "path": "screenshots/screen2.png"
        }
    ]
}

Példa a Részletek lapra

  • 1 – leírás
  • 2 – ikon
  • 3 - kategóriák
  • 4 – képernyőképek
  • 5 – tartalom (részletek)
  • 6 – hivatkozások
  • 7 - márkajelzés

kártya

Marketplace Q &A – CustomerQnASupport tulajdonság

A Visual Studio Marketplace-en található összes bővítmény rendelkezik egy Kérdések és válaszok (Q &A) szakaszsal, amely lehetővé teszi a bővítményfelhasználók és a közzétevők közötti egy-az-egy nyilvános beszélgetést. A közzétevők választhatnak a Marketplace-kérdések és válaszok (Q&A), a GitHub problémái vagy az egyéni Q&A URL-címek között. A Marketplace-en a Q&A-t a jegyzék CustomerQnASupport tulajdonságával tilthatja le.

Alapértelmezett felület (nem szükséges módosítani a jegyzékfájlt)

  • GitHub-adattárral rendelkező bővítmények esetén a Marketplace átirányítja a Q&A szakaszban szereplő felhasználókat a kapcsolódó GitHub-problémákra.
  • GitHub-adattár nélküli bővítmények esetén a Marketplace Q&A engedélyezve van.

Az alapértelmezett beállításoktól eltérő felhasználói élmény érdekében használja a CustomerQnASupport tulajdonságot a jegyzékben.

{
    "CustomerQnASupport": {
        "enablemarketplaceqna": true,
        "url": "http://uservoice.visualstudio.com"
    } 
}

Tulajdonságok

Az Ügyfél q &a támogatási szakaszának tulajdonságai:

  • enablemarketplaceqna – a piactérre true beállított logikai mező vagy az egyéni Q&A; hamis a Q&A letiltásához
  • url – sztring, egyéni Q&A URL-címe

Példák a Q &A-támogatás használatára

Példa: Bővítmény egyéni Q &A használatával

{
     "CustomerQnASupport": {
        "enablemarketplaceqna":"true",
        "url": "http://uservoice.visualstudio.com"
    } 
}

Példa: Bővítmény GitHub-adattárral, de GitHub-problémák helyett a Marketplace Q &A használata

{
     "CustomerQnASupport": {
        "enablemarketplaceqna":"true"
    } 
}

Példa: A Q &A szakaszt letiltó bővítmény

{
     "CustomerQnASupport": {
        "enablemarketplaceqna":"false"
    } 
}

Hatókörök

A bővítményben definiálhat egy vagy több hatókört. Ezek a hatókörök határozzák meg, hogy a bővítmény mely erőforrásokhoz férhet hozzá, és hogy milyen műveletek hajthatók végre ezeken az erőforrásokon. A bővítményjegyzékben megadott hatókörök a bővítményhez kiadott hozzáférési jogkivonatokon beállított hatókörök. További információ: Hitelesítés és biztonság.

Ha nincs megadva hatókör, a bővítmények csak a felhasználói profilokhoz és a bővítményadatokhoz férhetnek hozzá.

Támogatott hatókörök

Kategória Hatókör Név Leírás Örökli a forrást
Speciális biztonság vso.advsec AdvancedSecurity (olvasás) Lehetővé teszi a riasztások, eredménypéldányok és elemzési eredménypéldányok olvasását.
vso.advsec_write AdvancedSecurity (olvasás és írás) Lehetővé teszi elemzések feltöltését a sarifban vso.advsec
vso.advsec_manage AdvancedSecurity (olvasás, írás és kezelés) Lehetővé teszi elemzések feltöltését a sarifban vso.advsec_write
Ügynökkészletek vso.agentpools Ügynökkészletek (olvasás) Lehetővé teszi a tevékenységek, készletek, üzenetsorok, ügynökök, valamint az ügynökök jelenleg futó vagy nemrég befejezett feladatainak megtekintését.
vso.agentpools_manage Ügynökkészletek (olvasás, kezelés) Lehetővé teszi készletek, üzenetsorok és ügynökök kezelését. vso.agentpools
vso.environment_manage Környezet (olvasás, kezelés) Lehetővé teszi készletek, üzenetsorok, ügynökök és környezetek kezelését. vso.agentpools_manage
Elemzés vso.analytics Elemzés (olvasás) Lehetővé teszi az elemzési adatok lekérdezését.
Naplózás vso.auditlog Naplózási napló (olvasás) Lehetővé teszi a naplózási napló olvasását a felhasználóknak.
vso.auditstreams_manage Streamek naplózása (olvasás) Lehetővé teszi a naplózási streamek felhasználók számára történő kezelését. vso.auditlog
Build vso.build Buildelés (olvasás) Lehetővé teszi a buildösszetevők, köztük a builderedmények, a definíciók és a kérések elérését, valamint a buildeseményekkel kapcsolatos értesítések szolgáltatáshookokon keresztüli fogadását. vso.hooks_write
vso.build_execute Buildelés (olvasás és végrehajtás) Lehetővé teszi a buildösszetevők( például a builderedmények, a definíciók és a kérések) elérését, valamint a buildek várólistára helyezését, a buildtulajdonságok frissítését, valamint a buildeseményekkel kapcsolatos értesítések fogadását szolgáltatáshookokon keresztül. vso.build
Kód vso.code Kód (olvasás) Lehetővé teszi a forráskód és a metaadatok olvasását a véglegesítésekről, a módosításkészletekről, az ágakról és más verziókövetési összetevőkről. Emellett lehetővé teszi a kódkeresést és a verziókövetési eseményekről való értesítést szolgáltatáshookokon keresztül. vso.hooks_write
vso.code_write Kód (olvasás és írás) Lehetővé teszi a forráskód olvasását, frissítését és törlését, a véglegesítések metaadatainak elérését, a módosításkészleteket, az ágakat és más verziókövetési összetevőket. Emellett lehetővé teszi a lekéréses kérelmek és a kódellenőrzések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül. vso.code
vso.code_manage Kód (olvasás, írás és kezelés) Lehetővé teszi a forráskód olvasását, frissítését és törlését, a véglegesítések metaadatainak elérését, a módosításkészleteket, az ágakat és más verziókövetési összetevőket. Emellett lehetővé teszi a kódtárak létrehozását és kezelését, a lekéréses kérelmek és a kódértékelések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül. vso.code_write
vso.code_full Kód (teljes) Teljes hozzáférést biztosít a forráskódhoz, a véglegesítések metaadataihoz, a módosításkészletekhez, az ágakhoz és más verziókövetési összetevőkhöz. Emellett lehetővé teszi a kódtárak létrehozását és kezelését, a lekéréses kérelmek és a kódértékelések létrehozását és kezelését, valamint a verziókövetési eseményekről szóló értesítések fogadását szolgáltatáshookokon keresztül. Emellett korlátozott támogatást is biztosít az ügyféloldali OM API-khoz. vso.code_manage
vso.code_status Kód (állapot) Lehetővé teszi a véglegesítési és lekéréses kérelmek állapotának olvasását és írását.
Csatlakoztatott kiszolgáló vso.connected_server Csatlakoztatott kiszolgáló Lehetővé teszi a helyszíni csatlakoztatott kiszolgálóról szükséges végpontok elérését.
Jogosultságok vso.entitlements Jogosultságok (olvasás) Csak olvasási hozzáférést biztosít a licencjogosultságok végpontjához a fiókjogosultságok lekéréséhez.
vso.memberentitlementmanagement MemberEntitlement Management (olvasás) Lehetővé teszi a felhasználók, a licencek, valamint az általuk elérhető projektek és bővítmények olvasását.
vso.memberentitlementmanagement_write MemberEntitlement Management (írás) Lehetővé teszi a felhasználók, a licencek, valamint az általuk elérhető projektek és bővítmények kezelését. vso.memberentitlementmanagement
Kiterjesztés vso.extension Bővítmények (olvasás) Lehetővé teszi a telepített bővítmények olvasását. vso.profile
vso.extension_manage Bővítmények (olvasás és kezelés) Lehetővé teszi más felügyeleti műveletek telepítését, eltávolítását és végrehajtását a telepített bővítményeken. vso.extension
vso.extension.data Bővítményadatok (olvasás) Lehetővé teszi a telepített bővítmények által tárolt adatok (beállítások és dokumentumok) olvasását. vso.profile
vso.extension.data_write Bővítményadatok (olvasás és írás) Lehetővé teszi a telepített bővítmények által tárolt adatok (beállítások és dokumentumok) olvasását és írását. vso.extension.data
Github-kapcsolatok vso.githubconnections GitHub-kapcsolatok (olvasás) Lehetővé teszi a GitHub-kapcsolatok és a GitHub-adattárak adatainak olvasását.
vso.githubconnections_manage GitHub-kapcsolatok (olvasás és kezelés) Lehetővé teszi a GitHub-kapcsolatok és a GitHub-adattárak adatainak olvasását és kezelését vso.githubconnections
Graph & identity vso.graph Gráf (olvasás) Lehetővé teszi a felhasználói, csoport-, hatókör- és csoporttagság-információk olvasását.
vso.graph_manage Gráf (kezelés) Lehetővé teszi a felhasználók, csoportok, hatókörök és csoporttagságok adatainak olvasását, valamint felhasználók, csoportok hozzáadását és csoporttagságok kezelését. vso.graph
vso.identity Identitás (olvasás) Lehetővé teszi az identitások és csoportok olvasását.
vso.identity_manage Identitás (kezelés) Lehetővé teszi az identitások és csoportok olvasását, írását és kezelését. vso.identity
Gépcsoport vso.machinegroup_manage Üzembe helyezési csoport (olvasás, kezelés) Lehetővé teszi az üzembehelyezési csoport és az ügynökkészletek kezelését. vso.agentpools_manage
Piactér vso.gallery Piactér Olvasási hozzáférést biztosít a nyilvános és privát elemekhez és közzétevőkhöz. vso.profile
vso.gallery_acquire Marketplace (beszerzés) Olvasási hozzáférést és elemek beszerzését teszi lehetővé. vso.gallery
vso.gallery_publish Marketplace (közzététel) Olvasási hozzáférést biztosít, valamint lehetővé teszi elemek feltöltését, frissítését és megosztását. vso.gallery
vso.gallery_manage Marketplace (kezelés) Olvasási hozzáférést biztosít, valamint lehetővé teszi az elemek és közzétevők közzétételét és kezelését. vso.gallery_publish
Értesítések vso.notification Értesítések (olvasás) Olvasási hozzáférést biztosít az előfizetésekhez és az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is. vso.profile
vso.notification_write Értesítések (írás) Olvasási és írási hozzáférést biztosít az előfizetésekhez, és olvasási hozzáférést biztosít az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is. vso.notification
vso.notification_manage Értesítések (kezelés) Olvasási, írási és felügyeleti hozzáférést biztosít az előfizetésekhez, és olvasási hozzáférést biztosít az esemény metaadataihoz, beleértve a szűrhető mezőértékeket is. vso.notification_write
vso.notification_diagnostics Értesítések (diagnosztika) Hozzáférést biztosít az értesítésekkel kapcsolatos diagnosztikai naplókhoz, és lehetővé teszi az egyes előfizetések diagnosztikáinak engedélyezését. vso.notification
Csomagolás vso.packaging Csomagolás (olvasás) Lehetővé teszi a hírcsatornák és csomagok olvasását. vso.profile
vso.packaging_write Csomagolás (olvasás és írás) Lehetővé teszi hírcsatornák és csomagok létrehozását és olvasását. vso.packaging
vso.packaging_manage Csomagolás (olvasás, írás és kezelés) Lehetővé teszi hírcsatornák és csomagok létrehozását, olvasását, frissítését és törlését. vso.packaging_write
Folyamaterőforrások vso.pipelineresources_use Folyamaterőforrások (használat) Lehetővé teszi egy folyamat védett erőforrás használatára vonatkozó kérésének jóváhagyását: ügynökkészlet, környezet, üzenetsor, adattár, biztonságos fájlok, szolgáltatáskapcsolat és változócsoport.
vso.pipelineresources_manage Folyamaterőforrások (használat és kezelés) Lehetővé teszi védett erőforrás vagy folyamat védett erőforrás használatára vonatkozó kérésének kezelését: ügynökkészlet, környezet, üzenetsor, adattár, biztonságos fájlok, szolgáltatáskapcsolat és változócsoport. vso.pipelineresources_manage
Projekt és csapat vso.project Projekt és csapat (olvasás) Lehetővé teszi projektek és csapatok olvasását.
vso.project_write Projekt és csapat (olvasás és írás) Lehetővé teszi a projektek és csapatok olvasását és frissítését. vso.project
vso.project_manage Projekt és csapat (olvasás, írás és kezelés) Lehetővé teszi projektek és csapatok létrehozását, olvasását, frissítését és törlését. vso.project_write
Kienged vso.release Kiadás (olvasás) Lehetővé teszi a kiadási összetevők olvasását, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet. vso.profile
vso.release_execute Kiadás (olvasás, írás és végrehajtás) Lehetővé teszi a kiadási összetevők olvasását és frissítését, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet, valamint az új kiadások várólistára helyezésének lehetőségét. vso.release
vso.release_manage Kiadás (olvasás, írás, végrehajtás és kezelés) Lehetővé teszi a kiadási összetevők olvasását, frissítését és törlését, beleértve a kiadásokat, a kiadási definíciókat és a kiadási környezetet, valamint az új kiadások várólistára helyezését és jóváhagyását. vso.release_manage
Biztonságos fájlok vso.securefiles_read Biztonságos fájlok (olvasás) Lehetővé teszi a biztonságos fájlok olvasását.
vso.securefiles_write Biztonságos fájlok (olvasás, létrehozás) Lehetővé teszi a biztonságos fájlok olvasását és létrehozását. vso.securefiles_read
vso.securefiles_manage Biztonságos fájlok (olvasás, létrehozás és kezelés) Lehetővé teszi a biztonságos fájlok olvasását, létrehozását és kezelését. vso.securefiles_write
Biztonság vso.security_manage Biztonság (kezelés) Lehetővé teszi a biztonsági engedélyek olvasását, írását és kezelését.
Szolgáltatáskapcsolatok vso.serviceendpoint Szolgáltatásvégpontok (olvasás) Lehetővé teszi a szolgáltatásvégpontok olvasását. vso.profile
vso.serviceendpoint_query Szolgáltatásvégpontok (olvasás és lekérdezés) Lehetővé teszi a szolgáltatásvégpontok olvasását és lekérdezését. vso.serviceendpoint
vso.serviceendpoint_manage Szolgáltatásvégpontok (olvasás, lekérdezés és kezelés) Lehetővé teszi a szolgáltatásvégpontok olvasását, lekérdezését és kezelését. vso.serviceendpoint_query
Service Hooks vso.hooks Szolgáltatáshookok (olvasás) Lehetővé teszi a szolgáltatáshook-előfizetések és metaadatok olvasását, beleértve a támogatott eseményeket, a fogyasztókat és a műveleteket. (Már nem nyilvános.) vso.profile
vso.hooks_write Szolgáltatáshookok (olvasás és írás) Lehetővé teszi a szolgáltatáshook-előfizetések létrehozását és frissítését, valamint a metaadatok olvasását, beleértve a támogatott eseményeket, fogyasztókat és műveleteket. (Már nem nyilvános.) vso.hooks
vso.hooks_interact Szolgáltatáshookok (interakció) Lehetővé teszi az interakciót és a műveletek végrehajtását a szolgáltatáshookok által fogadott eseményeken. (Már nem nyilvános.) vso.profile
Beállítások vso.settings Beállítások (olvasás) Lehetővé teszi a beállítások olvasását.
vso.settings_write Beállítások (olvasás és írás) Lehetővé teszi a beállítások létrehozását és olvasását.
Szimbólumok vso.symbols Szimbólumok (olvasás) Lehetővé teszi a szimbólumok olvasását. vso.profile
vso.symbols_write Szimbólumok (olvasás és írás) Lehetővé teszi szimbólumok olvasását és írását. vso.symbols
vso.symbols_manage Szimbólumok (olvasás, írás és kezelés) Lehetővé teszi a szimbólumok olvasását, írását és kezelését. vso.symbols_write
Tevékenységcsoportok vso.taskgroups_read Tevékenységcsoportok (olvasás) Lehetővé teszi a feladatcsoportok olvasását.
vso.taskgroups_write Tevékenységcsoportok (olvasás, létrehozás) Lehetővé teszi a tevékenységcsoportok olvasását és létrehozását. vso.taskgroups_read
vso.taskgroups_manage Tevékenységcsoportok (olvasás, létrehozás és kezelés) Lehetővé teszi a munkacsoportok olvasását, létrehozását és kezelését. vso.taskgroups_write
Csapat irányítópultja vso.dashboards Csapat irányítópultjai (olvasás) Lehetővé teszi a csapat irányítópultjának információinak olvasását.
vso.dashboards_manage Csapat irányítópultjai (kezelés) Lehetővé teszi a csapat irányítópult-adatainak kezelését. vso.dashboards
Tesztkezelés vso.test Tesztkezelés (olvasás) Lehetővé teszi a teszttervek, esetek, eredmények és más, tesztkezeléssel kapcsolatos összetevők olvasását. vso.profile
vso.test_write Tesztkezelés (olvasás és írás) Lehetővé teszi a teszttervek, esetek, eredmények és más tesztkezeléssel kapcsolatos összetevők olvasását, létrehozását és frissítését. vso.test
Szálak vso.threads_full PR-szálak Olvasási és írási lehetőséget biztosít a kérések megjegyzésszálainak lekéréséhez.
Jogkivonatok vso.tokens Delegált engedélyezési jogkivonatok Lehetővé teszi a felhasználók számára delegált engedélyezési jogkivonatok kezelését.
vso.tokenadministration Jogkivonat-felügyelet Lehetővé teszi a meglévő jogkivonatok kezelését (megtekintését és visszavonását) a szervezet rendszergazdái számára.
Felhasználói profil vso.profile Felhasználói profil (olvasás) Lehetővé teszi a profil, a fiókok, a gyűjtemények, a projektek, a csapatok és más legfelső szintű szervezeti összetevők olvasását.
vso.profile_write Felhasználói profil (írás) Lehetővé teszi a profilba való írást. vso.profile
Változócsoportok vso.variablegroups_read Változócsoportok (olvasás) Lehetővé teszi a változócsoportok olvasását.
vso.variablegroups_write Változócsoportok (olvasás, létrehozás) Lehetővé teszi változócsoportok olvasását és létrehozását. vso.variablegroups_read
vso.variablegroups_manage Változócsoportok (olvasás, létrehozás és kezelés) Lehetővé teszi a változócsoportok olvasását, létrehozását és kezelését. vso.variablegroups_write
Wiki vso.wiki Wiki (olvasás) Lehetővé teszi a wikik, wikilapok és wikimellékletek olvasását. Emellett lehetővé teszi a wikilapok keresését is.
vso.wiki_write Wiki (olvasás és írás) Lehetővé teszi a wikik, wikilapok és wikimellékletek olvasását, létrehozását és frissítését. vso.wiki
Munkaelemek vso.work Munkaelemek (olvasás) Lehetővé teszi a munkaelemek, lekérdezések, táblák, terület- és iterációs útvonalak és egyéb munkaelemek nyomon követésével kapcsolatos metaadatok olvasását. Emellett lehetővé teszi a lekérdezések végrehajtását, a munkaelemek keresését és a munkaelemek eseményeiről szóló értesítések fogadását szolgáltatáshookokon keresztül. vso.hooks_write
vso.work_write Munkaelemek (olvasás és írás) Lehetővé teszi a munkaelemek és lekérdezések olvasását, létrehozását és frissítését, a tábla metaadatainak frissítését, az olvasási területet és az iterációkat, valamint a munkaelemek nyomon követésével kapcsolatos egyéb metaadatok elérési útját, lekérdezéseket hajthat végre, és szolgáltatáshookokon keresztül értesítéseket kaphat a munkaelem-eseményekről. vso.work
vso.work_full Munkaelemek (megtelt) Teljes hozzáférést biztosít a munkaelemekhez, lekérdezésekhez, hátralékokhoz, tervekhez és munkaelem-követési metaadatokhoz. Emellett lehetővé teszi a munkahelyi elemek eseményeiről szóló értesítések fogadását szolgáltatáshookokon keresztül. vso.work_write
Felhasználói megszemélyesítés user_impersonation Felhasználói megszemélyesítés Teljes hozzáféréssel rendelkezik a Visual Studio Team Services REST API-khoz. Kérje és/vagy hagyja jóvá ezt a hatókört óvatosan, mivel nagyon hatékony!

Közzétett bővítmény hatókörének módosítása

A közzétett bővítmények hatókörét módosíthatja. Ha korábban telepítette a bővítményt (és engedélyezte az előző hatókörkészletet), engedélyezze az új hatóköröket, mielőtt frissíthet a legújabb verzióra.

A Bővítménybeállítások központ Műveletre kötelező szakasza azt a felhasználót jeleníti meg, aki ha van ilyen, a telepített bővítmények hitelesítést igényelnek:

hatókör módosítása

A rendszergazda ezután áttekintheti és engedélyezheti az új hatóköröket:

scope-change-dialog

Telepítési célok

Ahogy a név is mutatja, a telepítési célok határozzák meg azokat a termékeket és szolgáltatásokat, ahol telepítheti a bővítményt. Microsoft.VisualStudio.Services ez a leggyakoribb telepítési cél, és azt jelzi, hogy a bővítmény telepíthető az Azure DevOpsba.

A bővítmény vagy integráció telepítési céljait a targets jegyzék mezője határozza meg.

Bővítmények támogatott azonosítójai:

  • Microsoft.VisualStudio.Services.Cloud: telepítése az Azure DevOps Servicesbe
  • Microsoft.TeamFoundation.Server: telepítés az Azure DevOps Serverbe
  • Microsoft.VisualStudio.Services: mindkettőbe települ. Parancsikon és Microsoft.TeamFoundation.Server verzió Microsoft.VisualStudio.Services.Cloud[14.2,)

Az integrációk támogatott azonosítójai:

  • Microsoft.VisualStudio.Services.Cloud.Integration: integrálható az Azure DevOps Services szolgáltatással
  • Microsoft.TeamFoundation.Server.Integration: integrálható az Azure DevOps Serverrel
  • Microsoft.VisualStudio.Services.Integration: mindkettővel integrálható. Parancsikon a következőhöz:Microsoft.VisualStudio.Services.Cloud.IntegrationMicrosoft.TeamFoundation.Server.Integration

További információ: Bővíthetőségi pontok.

Példák telepítési célokra

Példa: Az Azure DevOpsszal működő bővítmény

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ]
}

Példa: Olyan bővítmény, amely csak az Azure DevOps Services szolgáltatással működik

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services.Cloud"
        }
    ]
}

A telepítési célok az integrációs jegyzékben is használhatók. Ilyenek például azok a termékek, alkalmazások vagy eszközök, amelyek együttműködnek, de nem települnek az Azure DevOpsba.

Példa: Az Azure DevOpsszal működő integráció

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services.Integration"
        }
    ]
}

Példa: Csak az Azure DevOps Serverrel működő integráció

{
    "targets": [
        {
            "id": "Microsoft.TeamFoundation.Server.Integration"
        }
    ]
}

Telepítési célverziók

Egyes telepítési célazonosítók( például Microsoft.TeamFoundation.Server és Microsoft.TeamFoundation.Server.Integration) támogatnak egy választható verziótartományt. Ez az opcionális verziótartomány tovább pontosítja a bővítmény vagy integráció támogatott kiadásait.

A verzió vagy verziótartomány a version telepítési célobjektum mezőjén keresztül van megadva. Ez az érték a következő lehet:

  • Egy adott verzió, például: 15.0 (csak 2017-es RTM)
  • Támogatott verziók széles választéka, például: [14.0) (2015 RTM és újabb verziók), [14.3,15.1] (2015 3. frissítés– 2017. 1. frissítés). A tartományértékek pontosítása a következővel történik:
    • [: a minimális verziót magában foglaló verzió
    • ]: a maximális verziót magában foglaló verzió
    • (: minimálisan kizárólagos verzió
    • ): kizárólagos verzió maximális száma

Az Azure DevOps Server verziószámai:

Felszabadítás Kiadások Verzió
2010 Minden kiadás 10,0
2012 Minden kiadás 11,0
2013 RTM és frissítések 12.0, 12.1, 12.2, 12.3, 12.4
2015 RTM és frissítések 14.0, 14.1, 14.2, 14.3
2017 RTM és frissítések 15.0, 15.1
2018 RTM és frissítések 16.0
2019 RTM és frissítések 17,0
2020 RTM és frissítések 18.0

Példák a verziókra

Példa: Az Azure DevOpsszal működő bővítmény

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services.Cloud"
        },
        {
            "id": "Microsoft.TeamFoundation.Server",
            "version": "[15.0,)"
        }
    ]
}

Parancsikonok

Microsoft.VisualStudio.Services az Azure DevOps parancsikonja.

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ]
}

egyenértékű a következő értékeket:

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services.Cloud"
        },
        {
            "id": "Microsoft.TeamFoundation.Server",
            "version": "[14.2,)"
        }
    ]
}

Telepítési célok és igények használata

A telepítési célok és igények együttes használatával a felhasználók megfelelő képet láthatnak a bővítmény vagy integráció által kompatibilis termékekről/szolgáltatásokról. Például egy telepítési cél Microsoft.VisualStudio.Services api-version/3.0 megadása igény szerint, a bővítmény az Azure DevOpsszal működik.

Tipp.

A REST API-kkal kapcsolatos további információkért tekintse meg a REST API-referenciát.

Példa: 3.0-s verziójú API-kat használó bővítmény

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "demands": [
        "api-version/3.0"
    ]
}

A következő telepítési célokat oldja fel:

  1. Microsoft.VisualStudio.Services.Cloud
  2. Microsoft.TeamFoundation.Serververzió: [15.0,)

Példa: 2.0-s verziójú API-kat használó integráció

{
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services.Integration"
        }
    ],
    "demands": [
        "api-version/2.0"
    ]
}

A következő telepítési célokat oldja fel:

  1. Microsoft.VisualStudio.Services.Cloud.Integration
  2. Microsoft.TeamFoundation.Server.Integrationverzió: [14.0,)

Igények

Az igények lehetővé teszik a bővítmény által igényelt képességek és egyéb funkciók megadását. Ezekkel az igényekkel korlátozhatja a bővítmény közzétételének vagy telepítésének helyét.

A Visual Studio Marketplace-en az igények alapján listázhatja a bővítmény által kompatibilis termékeket és környezeteket, ami segít az ügyfeleknek megérteni, hogy a bővítmény működik-e például az Azure DevOps verziójával.

Tekintse meg az alábbi példát arra, hogyan adhatók meg a követelmények a bővítményjegyzékben.

{
    "demands": [
        "api-version/3.0",
        "contribution/ms.vss-dashboards-web.widget-catalog"
    ]
}

Ebben a példában a bővítmény az API-k 3.0-s verzióját igényli, ami azt jelenti, hogy csak az Azure DevOpsra telepíthető. Azt is megköveteli, hogy a ms.vss-dashboards-web bővítményt (és annak widget-catalog hozzájárulását) a bővítmény telepítése előtt telepíteni (és engedélyezni) kell a gyűjteményben.

Támogatott igények

Típus Leírás Ki van jelölve a közzétételkor? Be van jelölve a telepítéskor?
environment/cloud Felhőkörnyezetben való futtatást igényel Igen Igen
environment/onprem Helyszíni környezetben való futtatást igényel Igen Igen
api-version/{version} Egy adott API-verziót igényel (minimum) Nem Igen
extension/{id} Egy adott bővítmény telepítését/engedélyezését igényli Nem Igen
contribution/{id} Egy adott hozzájárulást igényel Nem Igen
contributionType/{id} Egy adott hozzájárulástípust igényel Nem Igen

Feljegyzés

  • Csak akkor használja environment/cloud és environment/onprem csak akkor, ha a bővítmény olyan topológiával kapcsolatos követelményekkel rendelkezik, amelyek az adott környezetben való futtatást igénylik.
  • extension, contributionés contributionType a követelmények a telepítéskor lesznek kiértékelve, és megköveteli, hogy a megadott bővítmény már telepítve legyen és engedélyezve legyen a szervezetben/gyűjteményben.

Fájlok

Ebben files a szakaszban hivatkozhat a bővítményben felvenni kívánt fájlokra. Mappákat és egyes fájlokat is hozzáadhat:

{
    "files": [
        {
            "path": "hello-world.html", "addressable": true
        },
        {
            "path": "scripts", "addressable": true
        },
        {
            "path": "images/logo.png", "addressable": true, "packagePath": "/"
        }
    ]
}

Tulajdonságok

A Fájlok szakasz tulajdonságai:

  • elérési út – A lemezen lévő erőforrás elérési útja, amely a gyökérkönyvtárhoz viszonyítva lehet.
  • címezhető – (nem kötelező) Állítsa igaz értékre, ha azt szeretné, hogy a fájl URL-címezhető legyen. Alapértelmezés szerint hamis.
  • packagePath – (nem kötelező) A csomagon belüli erőforrás elérési útja. Alapértelmezés szerint a lemez relatív elérési útja a gyökérkönyvtárból.
  • contentType – (nem kötelező) A fájl MIME-típusa. Alapértelmezés szerint a fájlkiterjesztés és az operációs rendszer beállításai alapján a legjobb tipp.
  • assetType – (nem kötelező) Adja meg az eszköztétel Típus attribútumának értékét a VSIX-jegyzékben. Sztringek tömbje is lehet, ebben az esetben több objektumbejegyzés is hozzáadódik ehhez a fájlhoz. A packagePath alapértelmezett értéke.
  • lang – (nem kötelező) Az objektum nyelve. A honosított fájlok kézbesítése az Accept-Language fejléc alapján történik. Hagyja üresen, ha azt szeretné, hogy a fájl az alapértelmezett (vagy tartalék) nyelven legyen aláírva. Ugyanannak a fájlnak a honosított verzióinak ugyanazzal az eszköztípuslal kell rendelkezniük.

Hozzájárulások

Minden egyes hozzájárulási bejegyzés a következő tulajdonságokkal rendelkezik:

  • id – Hivatkozási azonosító (sztring) a hozzájáruláshoz. Az egyes hozzájárulási azonosítók egyedivé tétele egy bővítményen belül. Lásd : hivatkozási hozzájárulások és -típusok.
  • típus – A hozzájáruláshoz tartozó hozzájárulás azonosítója.
  • leírás – (Nem kötelező) A hozzájárulást leíró sztring.
  • célok – A hozzájárulás célként megadott (hozzájáruláshoz hozzájáruló) hozzájárulási azonosítók tömbje. Lásd: A hozzájárulások célba juttatása.
  • properties – (Nem kötelező) Olyan objektum, amely a hozzájárulás típusában meghatározott tulajdonságokat tartalmazza.

További információkért tekintse meg a hozzájárulási modell áttekintését.

Hozzájárulási típusok

Minden egyes hozzájárulási bejegyzés a következő tulajdonságokkal rendelkezik:

  • id – A hozzájárulás típusának referenciaazonosítója (sztringje). Minden egyes hozzájárulástípus azonosítóját egyedivé teheti egy bővítményen belül. Lásd : hivatkozási hozzájárulások és -típusok.
  • név – A hozzájárulás típusának rövid neve.
  • leírás – (Nem kötelező) Egy sztring, amely részletesebben leírja a hozzájárulás típusát.
  • properties – (Nem kötelező) Egy szótár, amely a tulajdonságneveket a tulajdonságleírásokhoz rendeli. Ezek a tulajdonságok azokat a kötelező és választható tulajdonságokat írják le, amelyeket az ilyen típusú hozzájárulások használhatnak.

A tulajdonságleírások a következő tulajdonságokkal rendelkeznek:

  • leírás – (Nem kötelező) A tulajdonság használatát leíró sztring.
  • kötelező – (Nem kötelező) Logikai érték, amely ha igaz, azt jelzi, hogy a tulajdonság minden ilyen típusú hozzájáruláshoz szükséges.
  • type – A tulajdonság értékének típusa, amely lehet sztring, uri, guid, logikai, egész szám, dupla, dateTime, tömb vagy objektum.

További információkért tekintse meg a hozzájárulási modell áttekintését.

Hozzájárulások és típusok hivatkozása

Egyedi azonosítók használatával hivatkozhat a hozzájárulásokra és a hozzájárulástípusokra. A tulajdonsággal rendelkező type referenciatípusok, valamint a targets tulajdonsággal kapcsolatos egyéb hozzájárulások.

  • A teljes hozzájárulási hivatkozás tartalmazza a közzétevő azonosítóját, a bővítményazonosítót és a hozzájárulás/típus azonosítót, ponttal (.) elválasztva. A hozzájárulás teljes azonosítója például ms.vss-web.hub az "ms" (Microsoft) kiadó által közzétett "vss-web" bővítmény "hub" azonosítójával.
  • Előfordulhat, hogy a relatív hozzájárulási hivatkozások egy bővítményjegyzékben egy adott bővítményen belül egy másik hozzájárulásra vagy hozzájárulástípusra való hivatkozáshoz lesznek felhasználva. Ebben az esetben a közzétevő és a bővítmény azonosítója NEM szerepel, az azonosító pedig egy pont (.), amelyet a hozzájárulás azonosítója követ. A ".hub" például a korábban az "ms.vss-web.hub" parancsikonjaként említett vss-web bővítményben használható.

Hozzájárulások célba juttatása

Egyes hozzájárulások más hozzájárulások által megcélzott tárolókként működnek.

  • A hub-hozzájárulások célcsoportokat célozhatnak meg. Egy lap renderelésekor a webes felhasználói felület megjeleníti az összes olyan hub-hozzájárulást, amely a kiválasztott hubcsoportot célozza. A központi csoportok egy központi csoportgyűjteményt céloznak meg, amely egy adott navigációs területen megjelenő központcsoportokat határoz meg, például projektszintű rendszergazdai lapokat.
  • A különböző típusú hozzájárulások a következő menüket célozhatják meg: művelet, hiperhivatkozás-művelet és műveletszolgáltató. A műveletek és a hivatkozásműveletek egyetlen menüelem-bejegyzést biztosítanak. A műveletszolgáltató több dinamikus menüelemet is megadhat. Egy adott menüben az elemek összesítve lesznek az adott menübeli hozzájárulást célként szolgáló összes hozzájárulás (bármelyik ilyen típusú) között.

Központ ikon hozzáadása

Az ikonok hubhoz való hozzáadásáról további információt a központ ikonjára vonatkozó útmutatóban talál.

Támogatott jelvényszolgáltatások

A Marketplace csak a következő megbízható szolgáltatások jelvényeit támogatja:

  • api.travis-ci.org/
  • badge.fury.io/
  • badges.frapsoft.com/
  • badges.gitter.im/
  • badges.greenkeeper.io/
  • cdn.travis-ci.org/
  • ci.appveyor.com/
  • codeclimate.com/
  • codecov.io/
  • coveralls.io/
  • david-dm.org/
  • gemnasium.com/
  • img.shields.io/
  • isitmaintained.com/
  • marketplace.visualstudio.com/
  • snyk.io/
  • travis-ci.com/
  • travis-ci.org/
  • vsmarketplacebadges.dev/
  • bithound.io/
  • deepscan.io/
  • githost.io/
  • gitlab.com/
  • opencollective.co/

Feljegyzés

Cserélje le a "vsmarketplacebadge.apphb.com" kifejezést a "vsmarketplacebadges.dev" kifejezésre.

Ha egy másik szolgáltatás jelvényét szeretné megjeleníteni, lépjen kapcsolatba az ügyfélszolgálattal a fejlesztői közösségnél.

Példajegyzék

Az alábbi bővítmény egy műveletet ad hozzá a kész buildek helyi menüjéhez, valamint egy központot a Build Hub csoporthoz:

{
    "manifestVersion": 1,
    "id": "tools",
    "version": "0.1.0",
    "name": "Fabrikam Tools",
    "publisher": "fabrikam",
    "description": "Awesome tools to help you and your team do great things everyday.",
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "demands": [
        "api-version/3.0"
    ],
    "icons": {
        "default": "images/fabrikam-logo.png"
    },
    "scopes": [
        "vso.work",
        "vso.code_write"
    ],
    "categories": [
        "Plan and track"
    ],
    "tags": [
        "working",
        "people person",
        "search"
    ],
    "branding": {
        "color": "rgb(34, 34, 34)",
        "theme": "dark"
    },
    "screenshots": [
        {
            "path": "screenshots/screen1.png"
        },
        {
            "path": "screenshots/screen2.png"
        }
    ],
    "content": {
        "details": {
            "path": "overview.md"
        },
        "license": {
            "path": "eula.md"
        }
    },
    "links": {
        "home": {
            "uri": "https://www.fabrikam-fiber-inc.com"
        },
        "getstarted": {
            "uri": "https://www.fabrikam-fiber-inc.com/help/getstarted"
        },
        "learn": {
            "uri": "https://www.fabrikam-fiber-inc.com/features"
        },
        "support": {
            "uri": "https://www.fabrikam-fiber-inc.com/support"
        },
        "repository": {
            "uri": "https://github.com/fabrikam-fiber-inc/tools"
        },
        "issues": {
            "uri": "https://github.com/fabrikam-fiber-inc/tools/issues"
        }
    },
    "repository": {
        "type": "git",
        "uri": "https://github.com/fabrikam-fiber-inc/myextension"
    },
    "badges": [
        {
            "href": "https://travis.ci/fabrikam-fiber-inc/myextension",
            "uri": "https://travis.ci/fabrikam-fiber-inc/myextension.svg?branch=master",
            "description": "TravisCI build for the project"
        },
        {
            "href": "https://ci.appveyor.com/projects/fabrikam-fiber-inc/myextension",
            "uri": "https://ci.appveyor.com/api/projects/status/vlg2sgs2y7tsdxpj4c?svg=true",
            "description": "AppVeyor build for the project"
        }
    ],
    "contributions": [
        {
            "id": "showCommits",
            "type": "ms.vss-web.action",
            "description": "Adds a menu action from builds grid to show associated items.",
            "targets": [
                "ms.vss-build-web.completed-build-menu"
            ],
            "properties": {
                "title": "View associated items",
                "uri": "launch.html"
            }
        }
    ]
}