Sdílet prostřednictvím

Příjemci volaných služeb

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Hook služby můžete použít k provedení akce u služby příjemce, když dojde k události v projektu Azure DevOps. Například háček služby může uživatele upozornit, když se sestavení nezdaří.

Pokud chcete nakonfigurovat háček služby, vytvoříte odběr, který určuje událost, příjemce a akci. U některých uživatelů vytvoříte předplatné ve službě příjemce, ne v Azure DevOps. Tento článek obsahuje informace o nastaveních uživatelů, která používáte při programovém vytváření předplatného v Azure DevOps.

Při vytváření předplatného v Azure DevOps můžete vybírat z následujících příjemců:

Informace o těchto uživatelích a dalších uživatelích, které můžete integrovat s hooky služeb, najdete v tématu Dostupné služby.

Azure Service Bus

Service Bus je služba zasílání zpráv, která usnadňuje asynchronní komunikaci mezi aplikacemi a službami. Jako příjemce háku služby poskytuje integraci s frontami a tématy služby Service Bus a také se službou Azure Notification Hubs.

Odeslání zprávy do centra oznámení

Tato akce odešle obecné oznámení podle šablony do zadané instance Notification Hubs.

  • ID příjemce: azureServiceBus

  • ID akce: serviceBusNotificationHubSend

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    connectionString připojovací řetězec SAS Připojovací řetězec sdíleného přístupového podpisu (SAS) pro připojení ke službě Service Bus. Tento připojovací řetězec je k dispozici na webu Azure Portal. string Ano
    notificationHubName Název centra oznámení Název centra oznámení, do které chcete oznámení odeslat. Název může obsahovat pouze písmena, číslice, tečky, pomlčky, lomítka a podtržítka. Název musí začínat a končit písmenem nebo číslem. Centrum by již mělo existovat. string Ano
    tagsExpression Značky Výraz značky, který cílí na konkrétní sadu zařízení. Další informace najdete v tématu Směrování a značkové výrazy. string Ne

Odeslání zprávy do fronty služby Service Bus

Tato akce odešle řetězec JSON reprezentující událost do zadané fronty Service Bus. Další informace najdete v tématu Fronty, témata a odběry služby Service Bus.

  • ID příjemce: azureServiceBus

  • ID akce: serviceBusQueueSend

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    AuthenticationMechanismInputId Režim ověřování Režim ověřování, který se má použít: připojovací řetězec nebo připojení služby. string Ne
    ServiceConnectionInputId Připojení Azure Resource Manageru ID připojení služby. string Ne
    ServiceBusHostNameInputId Název hostitele služby Service Bus Název hostitele na webu Azure Portal ve formátu sb://<Service-Bus-name>.servicebus.windows.net. string Ne
    connectionString připojovací řetězec SAS Připojovací řetězec SAS, který se má použít pro připojení ke službě Service Bus. Tento připojovací řetězec je k dispozici na webu Azure Portal. string Ne
    queueName Název fronty Název fronty pro odeslání zprávy. Název může obsahovat pouze písmena, číslice, tečky, pomlčky, lomítka a podtržítka. Název musí začínat a končit písmenem nebo číslem. Pokud fronta neexistuje, vytvoří se, pokud zadaná připojovací řetězec má potřebná oprávnění. string Ano
    bypassSerializer Odeslat jako neserializovaný řetězec Možnost odesílání zpráv do služby Service Bus jako neserializované řetězce místo jako serializované řetězce .NET. Toto nastavení vyberte, pokud příjemce není klientem .NET, například když klient používá klient Azure Client Library pro Node. boolean Ne
    resourceDetailsToSend Podrobnosti o zdroji k odeslání Počet polí prostředků, které se mají odeslat do fronty. Možnosti jsou všechna pole, minimální číslo a žádná. string Ne
    messagesToSend Zprávy k odeslání Typy zpráv, které se mají odeslat do fronty. string Ne
    detailedMessagesToSend Podrobné zprávy k odeslání Typy podrobných zpráv, které se mají odeslat do fronty. string Ne

Odeslat zprávu do tématu služby Service Bus

Tato akce odešle řetězcovou reprezentaci události JSON do zadaného tématu služby Service Bus. Další informace najdete v tématu Vytvoření tématu a odběrů služby Service Bus pomocí webu Azure Portal.

  • ID příjemce: azureServiceBus

  • ID akce: serviceBusTopicSend

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    AuthenticationMechanismInputId Režim ověřování Režim ověřování, který se má použít. string Ne
    ServiceConnectionInputId Připojení Azure Resource Manageru ID připojení služby. string Ne
    ServiceBusHostNameInputId Název hostitele služby Service Bus Název hostitele na webu Azure Portal ve formátu sb://{Service-Bus-name}.servicebus.windows.net. string Ne
    connectionString připojovací řetězec SAS Připojovací řetězec SAS, který se má použít pro připojení ke službě Service Bus. Tento připojovací řetězec je k dispozici na webu Azure Portal. string Ne
    topicName Název tématu Název tématu, do které chcete zprávu odeslat. Název může obsahovat pouze písmena, číslice, tečky, pomlčky, lomítka a podtržítka. Název musí začínat a končit písmenem nebo číslem. Pokud téma neexistuje, vytvoří se, pokud zadaný připojovací řetězec má potřebná oprávnění. string Ano
    bypassSerializer Odeslat jako neserializovaný řetězec Možnost odesílání zpráv do služby Service Bus jako neserializované řetězce místo jako serializované řetězce .NET. Toto nastavení vyberte, pokud příjemce není klientem .NET, například když klient používá klient Azure Client Library pro Node. boolean Ne
    resourceDetailsToSend Podrobnosti o zdroji k odeslání Počet polí zdrojů, která se mají odeslat do tématu. Možnosti jsou všechna pole, minimální číslo a žádná. string Ne
    messagesToSend Zprávy k odeslání Typy zpráv, které mají být odeslány do tématu. string Ne
    detailedMessagesToSend Podrobné zprávy k odeslání Typy detailních zpráv, které se mají odeslat na téma. string Ne

Azure Storage

Úložiště je řešení cloudového úložiště pro různé typy dat. Azure Queue Storage je součástí služby Storage, která poskytuje fronty pro zasílání zpráv a může působit jako součást mechanismu propojování služeb.

Vložení zprávy do fronty služby Storage

Tato akce vloží reprezentaci JSON ve formě řetězce události do specifikované fronty úložiště. Další informace najdete v tématu Co je Azure Queue Storage?

  • ID příjemce: azureStorageQueue

  • ID akce: enqueue

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    AuthenticationMechanismInputId Režim ověřování Režim ověřování, který se má použít. string Ne
    ServiceConnectionInputId Připojení Azure Resource Manageru ID připojení služby. string Ne
    accountName Název účtu úložiště Název přidružený k vašemu účtu úložiště. Tento název je k dispozici na webu Azure Portal. string Ano
    accountKey Klíč účtu úložiště Klíč přidružený k vašemu účtu úložiště. string Ne
    queueName Název fronty Název fronty, který musí být napsán pouze malými písmeny, se má použít v rámci služby Úložiště. Fronta s tímto názvem se vytvoří, pokud ještě neexistuje. string Ano
    visiTimeout Časový limit viditelnosti zpráv Hodnota časového limitu viditelnosti (v sekundách) pro zaslanou zprávu, relativně k času serveru. Hodnota musí být větší nebo rovna 0 a nesmí být větší než sedm dní nebo 604 800 sekund. Časový limit viditelnosti musí být nastaven na hodnotu, která je menší než hodnota času života zprávy. number Ano
    ttl Čas na živé zprávy Časový interval životnosti zprávy ve frontě, v sekundách. Maximální hodnota, kterou můžete použít, je sedm dní nebo 604 800 sekund. number Ano
    resourceDetailsToSend Podrobnosti o zdroji k odeslání Počet polí prostředků, které se mají odeslat do fronty. Možnosti jsou všechna pole, minimální číslo a žádná. string Ne
    messagesToSend Zprávy k odeslání Typy zpráv, které se mají odeslat do fronty. string Ne
    detailedMessagesToSend Podrobné zprávy k odeslání Typy podrobných zpráv, které se mají odeslat do fronty. string Ne

Bamboo

Bamboo je server kontinuální integrace od Atlassianu.

Vytvoření fronty sestavení

Tato akce zařadí do fronty sestavení Bamboo.

  • ID příjemce: bamboo

  • ID akce: queueBuild

  • Podporované události: git.push, build.completetfvc.checkin

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    serverBaseUrl Základní adresa URL Bamboo Identifikátor URI, který obsahuje název hostitele serveru Bamboo. uri Ano
    basicAuthCredentials Základní přihlašovací údaje pro ověřování Standardní přihlašovací údaje, které se mají použít k ověření na serveru Bamboo. Pokud se chcete vyhnout odesílání přihlašovacích údajů ve formátu prostého textu, použijte protokol HTTPS k šifrování přihlašovacích údajů přes protokol TLS (Transport Layer Security). V Azure DevOps doporučujeme používat instanční objekty a spravované identity. string Ano
    planName Plán Název plánu, který má být zařazen do fronty. string Ano

Datadog

Datadog je monitorovací a analytická platforma pro cloudová prostředí.

Publikování události v Datadogu

Tato akce vytvoří událost a odpovídající metriky v datadogu.

  • ID příjemce: datadog

  • ID akce: postEventInDatadog

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    apiKey Klíč rozhraní API služby Datadog Přístupový klíč pro váš účet Datadog. Klíč rozhraní API najdete na portálu Datadog. Přejděte do svého profilu a pak vyberte Nastavení organizace>Klíče rozhraní API. string Ano
    accountType Typ účtu Datadog Typ vašeho účtu Datadog. Typ účtu můžete určit z názvu hostitele adresy URL, kterou váš účet Datadog používá:
    - app.datadoghq.com: US
    - app.datadoghq.eu: EU
    - us3.datadoghq.com: US3
    - us5.datadoghq.com: US5
    - ap1.datadoghq.com: AP1
    - app.dog-gov.com: GOV    		 string Ano

Grafana

Grafana je opensourcový řídicí panel a editor grafů.

Přidání poznámky do databáze Grafana

Tato akce vytvoří poznámku v Grafaně.

  • ID příjemce: grafana

  • ID akce: addAnnotation

  • Podporované události: ms.vss-release.deployment-completed-event

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    url Adresa URL Grafana Adresa URL, která se má použít k publikování poznámek v Grafana. uri Ano
    apiToken Token rozhraní API Přístupový token pro publikování poznámek do databáze Grafana. Informace o vytvoření tokenu najdete v tématu Vytvoření tokenů a řídicích panelů účtu služby pro organizaci. string Ano
    tags Značky Čárkami oddělený seznam značek, které se mají použít pro přidávání poznámek. string Ano
    annotationDeploymentDurationWindow Označte časové okno nasazení Možnost konfigurace okna doby trvání poznámky
    – Pokud je tato možnost vybrána, poznámka se vztahuje na čas mezi zahájením a dokončením nasazení.
    - Pokud není vybrána, poznámka se vztahuje na dokončení nasazení.    		 boolean Ne
    text Text Vlastní popis poznámky. Pokud není zadáno, toto nastavení popisuje verzi a stav. Toto nastavení může zahrnovat odkazy, například <a href="https://www.contoso.com" target="_blank">Contoso</a>. string Ne
    dashboardId Palubní deska ID řídicího panelu pro přidání poznámky. Pokud není zadané ID, přidá se poznámka na globální úrovni. string Ne

Jenkins

Jenkins je server kontinuální integrace, který můžete použít k nepřetržitému sestavování a testování softwarových projektů.

Spustit sestavení Git

Tato akce používá plugin Jenkins Git k spuštění sestavení v úložišti Git.

  • ID příjemce: jenkins

  • ID akce: triggerGitBuild

  • Podporované události: git.push, git.pullrequest.merged

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    serverBaseUrl Základní adresa URL Jenkinse Identifikátor URI, který obsahuje název hostitele serveru Jenkins. uri Ano
    basicAuthCredentials Základní přihlašovací údaje pro ověřování Standardní přihlašovací údaje pro ověřování HTTP. Pokud se chcete vyhnout odesílání přihlašovacích údajů ve formátu prostého textu, použijte protokol HTTPS k šifrování přihlašovacích údajů přes protokol TLS. V Azure DevOps doporučujeme používat instanční objekty a spravované identity. string Ano
    useTfsPlugin Úroveň integrace Vybraná úroveň integrace, která je jednou ze dvou hodnot:
    – Integrované rozhraní API Jenkinse
    – Rozšířená integrace poskytovaná modulem plug-in Azure DevOps Server, pokud je tento modul plug-in nainstalovaný na serveru Jenkinse    		 string Ne

Aktivace obecného sestavení

Tato akce aktivuje obecné sestavení Jenkinse, které vyvolá adresu URL sestavení Jenkinse.

  • ID příjemce: jenkins

  • ID akce: triggerGenericBuild

  • Podporované události: git.push, git.pullrequest.merged, build.complete, tfvc.checkinms.vss-release.deployment-completed-event

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    serverBaseUrl Základní adresa URL Jenkinse Identifikátor URI, který obsahuje název hostitele serveru Jenkins. uri Ano
    basicAuthCredentials Základní přihlašovací údaje pro ověřování Standardní přihlašovací údaje pro ověřování HTTP. Pokud se chcete vyhnout odesílání přihlašovacích údajů ve formátu prostého textu, použijte protokol HTTPS k šifrování přihlašovacích údajů přes protokol TLS. V Azure DevOps doporučujeme používat instanční objekty a spravované identity. string Ano
    buildName Sestavení Název sestavení, který se má aktivovat. string Ano
    useTfsPlugin Úroveň integrace Vybraná úroveň integrace, která je jednou ze dvou hodnot:
    – Integrované rozhraní API Jenkinse
    – Rozšířená integrace poskytovaná modulem plug-in Azure DevOps Server, pokud je tento modul plug-in nainstalovaný na serveru Jenkinse    		 string Ne
    buildAuthToken Token sestavení Autorizační token pro sestavení. Sestavení můžou vzdáleně aktivovat jenom uživatelé, kteří znají token. string Ne
    buildParameterized Přijímá parametry Možnost, která určuje, jestli sestavení přijímá parametry. boolean Ne
    buildParams Parametry sestavení Parametry sestavení ve formě párů název-hodnota. V každé dvojici jsou název a hodnota oddělené dvojtečkou, například <parameter>:<value>. Každý pár název-hodnota se zobrazí na vlastním řádku. string Ne

Slack

Slack je prohledávatelná platforma pro týmovou komunikaci.

Publikování zprávy do kanálu

Tato akce odesílá zprávu o události do kanálu Slack. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps pomocí Slacku.

  • ID příjemce: slack

  • ID akce: postMessageToChannel

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    url Adresa URL webhooku Slack Adresa URL webhooku poskytovaná Slackem pro odesílání požadavků HTTP POST do. uri Ano

Trello

Trello je nástroj pro řízení projektů, který pomocí panelů, seznamů a karet pomáhá týmům sledovat pracovní postupy.

Vytvoření karty

Tato akce vytvoří kartu na existujícím seznamu v Trello. Karta může představovat úkol, problém, událost nebo jiné položky související s projektem. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps Services a TFS pomocí Trello.

  • ID příjemce: trello

  • ID akce: createCard

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    userToken Token uživatele Token uživatele, který poskytuje přístup k prostředkům Trello. Token získáte tak, že přejdete na autorizační stránku Trello. string Ano
    boardId Prkno Název desky, na které se vytvoří karta Trello. string Ano
    listId Seznam Název seznamu, na kterém se vytvoří karta Trello. string Ano
    labels Popisky Seznam barev štítků oddělený čárkami, které se mají použít na vytvořenou kartu. Platné názvy barev popisků jsou red, , orangeyellow, green, blue, a purple. string Ne
    addToTop Vytvoření na začátku seznamu Možnost, která určuje, jestli se má karta vytvořit na začátku nebo na konci seznamu Trello. Pokud je truetoto pole , karta se vytvoří na začátku. boolean Ne
    cardName Název karty Název nové karty Ve výchozím nastavení se jako název používá textový popis události. Zástupné symboly můžete použít k vložení obsahu z události do názvu. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps Services a TFS pomocí Trello. string Ne
    cardDescription Popis karty Popis nové karty Podrobný popis události Markdownu se ve výchozím nastavení používá jako popis. Zástupné symboly můžete použít k vložení obsahu z události do popisu. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps Services a TFS pomocí Trello. string Ne

Vytvořit seznam

Tato akce vytvoří seznam na existující desce v Trello. Seznam slouží k uspořádání karet na panelu a obvykle představuje stav. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps Services a TFS pomocí Trello.

  • ID příjemce: trello

  • ID akce: createList

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    userToken Token uživatele Token uživatele, který poskytuje přístup k prostředkům Trello. Token získáte tak, že přejdete na autorizační stránku Trello. string Ano
    boardId Prkno Název desky, na které se vytvoří seznam Trello. string Ano
    addToBottom Vytvoření v dolní části panelu Možnost, která označuje, jestli se má karta vytvořit na začátku nebo na konci panelu. Pokud je truetoto pole , karta se vytvoří na konci. boolean Ne
    listName Název seznamu Název nového seznamu. Ve výchozím nastavení se jako název používá textový popis události. Zástupné symboly můžete použít k vložení obsahu z události do názvu. Další informace najdete v tématu Vytvoření háku služby pro Azure DevOps Services a TFS pomocí Trello. string Ne

Webhooky

Webhooky poskytují způsob odeslání reprezentace JSON události Azure DevOps do jakékoli služby, která má veřejný koncový bod.

Publikování prostřednictvím protokolu HTTP

Tato akce publikuje reprezentaci objektu JSON události na zadanou adresu URL. Koncové body HTTPS se doporučují kvůli možnému využití privátních dat v datové části události. Další informace naleznete v tématu Webhooky.

  • ID příjemce: webHooks

  • ID akce: httpRequest

  • Podporované události: Všechny události

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    url URL Adresa URL pro odeslání protokolu HTTP POST. uri Ano
    acceptUntrustedCerts Přijetí nedůvěryhodných certifikátů SSL Možnost, že pro koncový bod nevyžaduje důvěryhodný certifikát SSL (Secure Sockets Layer). Tuto možnost použijte pouze při vývoji a testování. boolean Ne
    basicAuthCredentials Základní přihlašovací údaje pro ověřování Standardní přihlašovací údaje pro ověřování HTTP. Pokud se chcete vyhnout odesílání přihlašovacích údajů ve formátu prostého textu, použijte protokol HTTPS k šifrování přihlašovacích údajů přes protokol TLS. V Azure DevOps doporučujeme používat instanční objekty a spravované identity. string Ano
    httpHeaders Záhlaví HTTP Klíče a hodnoty hlaviček HTTP ve formě párů klíč-hodnota. V každé dvojici jsou klíč a hodnota oddělené dvojtečkou, například <key>:<value>. Každý pár klíč-hodnota se zobrazí na vlastním řádku. Tyto hodnoty můžou zobrazit každý, kdo má přístup k předplatnému háku služby. string Ne
    resourceDetailsToSend Podrobnosti o zdroji k odeslání Počet polí prostředků, které se mají odeslat do fronty. Možnosti jsou všechna pole, minimální číslo a žádná. string Ne
    messagesToSend Zprávy k odeslání Typy zpráv, které se mají odeslat do fronty. string Ne
    detailedMessagesToSend Podrobné zprávy k odeslání Typy podrobných zpráv, které se mají odeslat do fronty. string Ne

Zendesk

Zendesk je sada, která nabízí vystavování tiketů helpdesku, sledování problémů a zákaznickou podporu, v rámci modelu software jako služba (SaaS).

Vytvoření soukromého komentáře v lístku

Tato akce vytvoří soukromý komentář v tiketu Zendesk.

  • ID příjemce: zendesk

  • ID akce: createPrivateComment

  • Podporované události: workitem.commented

  • Nastavení:

    Vstupní ID Název Popis Datový typ Povinné
    accountName Název účtu Název účtu Zendesk. Název účtu najdete v adrese URL vašeho účtu Zendesk, který má formát https://<account-name>.zendesk.com. string Ano
    username Jméno uživatele Uživatelské jméno uživatele Zendesku, který aktualizuje lístky. string Ano
    apiToken Token rozhraní API Token rozhraní API Zendesku. Token najdete tak, že přejdete do aplikace Zendesk a pak vyberete Admin>Kanály>API. string Ano

Související obsah

  • Last updated on