Použití pojmenovaných hodnot v zásadách API Management Azure

API Management zásady jsou výkonnou funkcí systému, která vydavateli umožňuje změnit chování rozhraní API prostřednictvím konfigurace. Zásady představují kolekci příkazů, které se postupně provádí na základě požadavku nebo odezvy z rozhraní API. Příkazy zásad lze vytvořit pomocí textových hodnot literálů, výrazů zásad a pojmenovaných hodnot.

Pojmenované hodnoty jsou globální kolekcí párů název/hodnota v každé API Management instanci. Počet položek v kolekci není žádným omezením. Pojmenované hodnoty lze použít ke správě hodnot a tajných kódů konstantních řetězců ve všech konfiguracích a zásadách rozhraní API.

Typy hodnot

Prosté hodnoty nebo tajné kódy mohou obsahovat výrazy zásad. Výraz například vrátí @(DateTime.Now.ToString()) řetězec obsahující aktuální datum a čas.

Podrobnosti o atributech pojmenované hodnoty najdete v referenčních API Management REST API .

Tajné kódy trezoru klíčů

Hodnoty tajných kódů je možné ukládat buď jako šifrované řetězce v API Management (vlastní tajné kódy), nebo odkazováním na tajné kódy v Azure Key Vault.

Použití tajných kódů trezoru klíčů se doporučuje, protože pomáhá API Management zabezpečení:

• Tajné kódy uložené v trezorech klíčů je možné opakovaně používat napříč službami.
• Na tajné kódy je možné použít podrobné zásady přístupu.
• Tajné kódy aktualizované v trezoru klíčů se automaticky obměnají v API Management. Po aktualizaci v trezoru klíčů se pojmenovaná hodnota API Management do 4 hodin. Tajný kód můžete také ručně aktualizovat pomocí Azure Portal nebo prostřednictvím správy REST API.

Požadavky na integraci trezoru klíčů

1. Postup vytvoření trezoru klíčů najdete v tématu Rychlý start: Vytvoření trezoru klíčů pomocí Azure Portal.
2. Povolte spravovanou identitu přiřazenou systémem nebo uživatelem v API Management instanci.
3. Přiřaďte spravované identitě zásady přístupu trezoru klíčů s oprávněními k získání a zobrazení seznamu tajných kódů z trezoru. Přidání zásady:
   1. Na portálu přejděte do trezoru klíčů.
   2. Vyberte Nastavení > Přístup a > +Přidat zásady přístupu.
   3. Vyberte Oprávnění k tajným klíči a pak vyberte Získat a Vy list.
   4. V části Vybrat objekt zabezpečení vyberte název prostředku vaší spravované identity. Pokud používáte identitu přiřazenou systémem, objekt zabezpečení je název vaší API Management instance.
4. Vytvořte nebo naimportujte tajný kód do trezoru klíčů. Viz Rychlý start: Nastavení a načtení tajného klíče z Azure Key Vault pomocí Azure Portal.

Pokud chcete použít tajný klíč trezoru klíčů, přidejte nebo upravte pojmenovanou hodnotua zadejte typ trezoru klíčů. Vyberte tajný kód z trezoru klíčů.

Požadavky na Key Vault firewall

Pokud Key Vault trezoru klíčů povolená brána firewall, požadavky jsou následující:

• Pro přístup k trezoru API Management musíte použít spravovanou identitu přiřazenou systémem vaší instance.
• V Key Vault firewall povolte možnost Povolit důvěryhodným službám Microsoftu tuto bránu firewall obejít.

Požadavky na virtuální síť

Pokud je API Management nasazená ve virtuální síti, nakonfigurujte také následující nastavení sítě:

• Povolte koncovému bodu služby Azure Key Vault v podsíti API Management služby.
• Nakonfigurujte pravidlo skupiny zabezpečení sítě (NSG), které povolí odchozí provoz do značek služeb AzureKeyVault a AzureActiveDirectory.

Podrobnosti najdete v tématu podrobnosti o konfiguraci sítě Připojení k virtuální síti.

Přidání nebo úprava pojmenované hodnoty

Přidání tajného klíče trezoru klíčů

Viz Požadavky pro integraci trezoru klíčů.

1. V Azure Portalpřejděte na svou instanci API Management.

2. V části Rozhraní API vyberte Pojmenované hodnoty > +Přidat.

3. Zadejte identifikátor názvu a zobrazovaný název, který se použije k odkazování na vlastnost v zásadách.

4. V části Typ hodnoty vyberte Trezor klíčů.

5. Zadejte identifikátor tajného klíče trezoru klíčů (bez verze) nebo zvolte Vybrat a vyberte tajný kód z trezoru klíčů.

   Důležité

   Pokud zadáte identifikátor tajného kódu trezoru klíčů sami, ujistěte se, že nemá informace o verzi. V opačném případě se tajný kód automaticky v trezoru API Management po aktualizaci v trezoru klíčů.

6. V části Identita klienta vyberte spravovanou identitu přiřazenou systémem nebo existující spravovanou identitu přiřazenou uživatelem. Zjistěte, jak přidat nebo upravit spravované identity ve vaší API Management službě.

   Poznámka

   Identita potřebuje oprávnění k získání a zobrazení seznamu tajných kódů z trezoru klíčů. Pokud jste ještě nenakonfigurovali přístup k trezoru klíčů, API Management vás vyzve, aby mohl automaticky nakonfigurovat identitu s potřebnými oprávněními.

7. Přidejte jednu nebo více volitelných značek, které vám pomůžou uspořádat pojmenované hodnoty, a pak uložit.

8. Vyberte Vytvořit.

   

Přidání prosté hodnoty nebo tajné hodnoty

az apim nv create --resource-group apim-hello-word-resource-group \
    --display-name "named_value_01" --named-value-id named_value_01 \
    --secret true --service-name apim-hello-world --value test

az apim nv list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

az apim nv show --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --named-value-id named_value_01

az apim nv show-secret --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --named-value-id named_value_01

az apim nv delete --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --named-value-id named_value_01

Použití pojmenované hodnoty

Příklady v této části používají pojmenované hodnoty uvedené v následující tabulce.

Pokud chcete v zásadách použít pojmenovanou hodnotu, umístěte její zobrazovaný název do dvojité dvojice složených závorek, jako je , jak je {{ContosoHeader}} znázorněno v následujícím příkladu:

<set-header name="{{ContosoHeader}}" exists-action="override">
  <value>{{ContosoHeaderValue}}</value>
</set-header>

V tomto příkladu se používá jako název hlavičky v zásadách a používá se jako ContosoHeader set-header hodnota této ContosoHeaderValue hlavičky. Když se tato zásada vyhodnotí během požadavku nebo odpovědi na API Management gateway a nahradí se {{ContosoHeader}} {{ContosoHeaderValue}} jejich příslušnými hodnotami.

Pojmenované hodnoty lze použít jako kompletní hodnoty atributů nebo elementů, jak je znázorněno v předchozím příkladu, ale lze je také vložit do nebo zkombinovat s částí textového výrazu literálu, jak je znázorněno v následujícím příkladu:

<set-header name = "CustomHeader{{ContosoHeader}}" ...>

Pojmenované hodnoty mohou také obsahovat výrazy zásad. V následujícím příkladu ExpressionProperty se používá výraz .

<set-header name="CustomHeader" exists-action="override">
    <value>{{ExpressionProperty}}</value>
</set-header>

Když se tato zásada {{ExpressionProperty}} vyhodnotí, nahradí se její hodnotou @(DateTime.Now.ToString()) . Vzhledem k tomu, že hodnota je výraz zásad, výraz se vyhodnotí a zásada pokračuje v jeho provádění.

Můžete to otestovat na portálu Azure Portal nebo vývojářské portálu zavoláte operaci, která má zásadu s pojmenovanou hodnotou v oboru. V následujícím příkladu se volá operace se dvěma předchozími příklady set-header zásad s pojmenovaných hodnotami. Všimněte si, že odpověď obsahuje dvě vlastní hlavičky, které byly nakonfigurovány pomocí zásad s pojmenovaných hodnotami.

Pokud se podíváte na trasování odchozího rozhraní API pro volání, které obsahuje dvě předchozí ukázkové zásady s pojmenovaných hodnotami, uvidíte dvě zásady s vkládanou pojmenovanou hodnotou a také vyhodnocení výrazu zásady pro pojmenovanou hodnotu, která obsahovala výraz set-header zásady.

I když pojmenované hodnoty mohou obsahovat výrazy zásad, nesmí obsahovat jiné pojmenované hodnoty. Pokud se text obsahující odkaz na pojmenovanou hodnotu použije pro hodnotu, například , nebude tento odkaz vyřešen a Text: {{MyProperty}} nahrazen.

Odstranění pojmenované hodnoty

Pokud chcete odstranit pojmenovanou hodnotu, vyberte název a pak v místní nabídce ( ... ) vyberte Odstranit.

Další kroky

• Další informace o práci se zásadami
  • Zásady v API Management
  • referenční příručce o zásadách
  • Výrazy zásad