Služba Microsoft.ApiManagement /namedValues 2024-05-01
- nejnovější
-
2024-06-01-preview - 2024-05-01
-
2023-09-01-preview -
2023-05-01-preview - 1. 3. 2023 ve verzi Preview
-
2022-09-01-preview - 2022-08-01
-
2022-04-01-preview -
12. 12. 2021 ve verzi Preview -
2021-08-01 -
2021-04-01-preview -
2021-01-01-preview - 12. 12. 2020
- 2020-06-01-preview
- 12. 12. 2019
-
12. 12. 2019
Definice prostředku Bicep
Typ prostředku service/namedValues je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/namedValues, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Hodnoty vlastností
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| identityClientId | Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. | řetězec |
| secretIdentifier | Identifikátor tajného klíče trezoru klíčů pro načtení tajného kódu Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi | řetězec |
Microsoft.ApiManagement/service/namedValues
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku | řetězec Omezení: Maximální délka = Model = ^[^*#&+:<>?]+$ (povinné) |
| rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: služby |
| vlastnosti | Vlastnosti kontraktu entity NamedValue pro operaci PUT | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| displayName | Jedinečný název pojmenované hodnoty. Může obsahovat pouze písmena, číslice, tečku, pomlčku a podtržítka. | řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = ^[A-Za-z0-9-._]+$ (povinné) |
| keyVault | Podrobnosti o umístění služby KeyVault pojmenované hodnoty | keyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajný | Určuje, zda je hodnota tajný klíč a má být zašifrována, nebo ne. Výchozí hodnota je false. | Bool |
| visačky | Volitelné značky, které lze při zadání použít k filtrování seznamu NamedValue. | string[] |
| hodnota | Hodnota pojmenované hodnoty. Může obsahovat výrazy zásad. Nemusí být prázdný nebo se skládat pouze z prázdných znaků. Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. | řetězec Omezení: Maximální délka = |
Ukázky rychlého startu
Následující ukázky rychlého startu nasadí tento typ prostředku.
| Soubor Bicep | Popis |
|---|---|
| služby Front Door Standard/Premium s původu služby API Management | Tato šablona vytvoří front Door Premium a instanci služby API Management a použije zásadu NSG a globální služby API Management k ověření, že provoz prošel původem služby Front Door. |
Definice prostředku šablony ARM
Typ prostředku service/namedValues je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/namedValues, přidejte do šablony následující JSON.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Hodnoty vlastností
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| identityClientId | Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. | řetězec |
| secretIdentifier | Identifikátor tajného klíče trezoru klíčů pro načtení tajného kódu Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi | řetězec |
Microsoft.ApiManagement/service/namedValues
| Jméno | Popis | Hodnota |
|---|---|---|
| apiVersion | Verze rozhraní API | '2024-05-01' |
| Jméno | Název prostředku | řetězec Omezení: Maximální délka = Model = ^[^*#&+:<>?]+$ (povinné) |
| vlastnosti | Vlastnosti kontraktu entity NamedValue pro operaci PUT | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Typ prostředku | Microsoft.ApiManagement/service/namedValues |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| displayName | Jedinečný název pojmenované hodnoty. Může obsahovat pouze písmena, číslice, tečku, pomlčku a podtržítka. | řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = ^[A-Za-z0-9-._]+$ (povinné) |
| keyVault | Podrobnosti o umístění služby KeyVault pojmenované hodnoty | keyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajný | Určuje, zda je hodnota tajný klíč a má být zašifrována, nebo ne. Výchozí hodnota je false. | Bool |
| visačky | Volitelné značky, které lze při zadání použít k filtrování seznamu NamedValue. | string[] |
| hodnota | Hodnota pojmenované hodnoty. Může obsahovat výrazy zásad. Nemusí být prázdný nebo se skládat pouze z prázdných znaků. Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. | řetězec Omezení: Maximální délka = |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
| Šablona | Popis |
|---|---|
|
služby Front Door Standard/Premium s původu služby API Management nasazení  |
Tato šablona vytvoří front Door Premium a instanci služby API Management a použije zásadu NSG a globální služby API Management k ověření, že provoz prošel původem služby Front Door. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku service/namedValues je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/namedValues, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2024-05-01"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Hodnoty vlastností
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| identityClientId | Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. | řetězec |
| secretIdentifier | Identifikátor tajného klíče trezoru klíčů pro načtení tajného kódu Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi | řetězec |
Microsoft.ApiManagement/service/namedValues
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku | řetězec Omezení: Maximální délka = Model = ^[^*#&+:<>?]+$ (povinné) |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: služby |
| vlastnosti | Vlastnosti kontraktu entity NamedValue pro operaci PUT | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Typ prostředku | Microsoft.ApiManagement/service/namedValues@2024-05-01 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| displayName | Jedinečný název pojmenované hodnoty. Může obsahovat pouze písmena, číslice, tečku, pomlčku a podtržítka. | řetězec Omezení: Minimální délka = 1 Maximální délka = 1 Model = ^[A-Za-z0-9-._]+$ (povinné) |
| keyVault | Podrobnosti o umístění služby KeyVault pojmenované hodnoty | keyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajný | Určuje, zda je hodnota tajný klíč a má být zašifrována, nebo ne. Výchozí hodnota je false. | Bool |
| visačky | Volitelné značky, které lze při zadání použít k filtrování seznamu NamedValue. | string[] |
| hodnota | Hodnota pojmenované hodnoty. Může obsahovat výrazy zásad. Nemusí být prázdný nebo se skládat pouze z prázdných znaků. Tato vlastnost nebude vyplněna při operacích GET. K získání hodnoty použijte požadavek POST /listSecrets. | řetězec Omezení: Maximální délka = |