Microsoft.ApiManagement service/namedValues 2022-08-01
Bicep-resursdefinition
Resurstypen service/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/namedValues-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Egenskapsvärden
service/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue. | string[] Begränsningar: Max längd = 32 |
| värde | Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Max längd = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
Front Door Standard/Premium med API Management-ursprung
|
Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG- och global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget. |
Resursdefinition för ARM-mall
Resurstypen service/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/namedValues-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Egenskapsvärden
service/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/namedValues" |
| apiVersion | Resurs-API-versionen | '2022-08-01' |
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue. | string[] Begränsningar: Max längd = 32 |
| värde | Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Max längd = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
|
Front Door Standard/Premium med API Management-ursprung
|
Den här mallen skapar en Front Door Premium och en API Management-instans och använder en NSG- och global API Management-princip för att verifiera att trafiken har kommit via Front Door-ursprunget. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/namedValues-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Egenskapsvärden
service/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/namedValues@2022-08-01" |
| Namn | Resursnamnet | sträng (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) Begränsningar: Min längd = 1 Max längd = 256 Mönster = ^[A-Za-z0-9-._]+$ |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue. | string[] Begränsningar: Max längd = 32 |
| värde | Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng Begränsningar: Max längd = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |