Microsoft.ApiManagement service/namedValues 2021-12-01-preview
Definicja zasobu Bicep
Typ zasobu service/namedValues można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Wartości właściwości
service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
| Nadrzędny | W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Symboliczna nazwa zasobu typu: usługa |
| properties | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | ciąg (wymagany) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| wpis tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | bool |
| tags | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy Nazwanawartości. | ciąg[] |
| wartość | Wartość właściwości NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | ciąg |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nazwa | Opis | Wartość |
|---|---|---|
| identityClientId | Wartość null dla wartości SystemAssignedIdentity lub Client Id for UserAssignedIdentity , która będzie używana do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. | ciąg |
| secretIdentifier | Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Udostępnienie wpisów tajnych w wersji uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management za pomocą aka.ms/apimmsi | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
Front Door Standard/Premium ze źródłem API Management |
Ten szablon tworzy usługę Front Door Premium i wystąpienie API Management oraz używa sieciowej grupy zabezpieczeń i zasad globalnych API Management w celu sprawdzenia, czy ruch przechodzi przez źródło usługi Front Door. |
Definicja zasobu szablonu usługi ARM
Typ zasobu service/namedValues można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Wartości właściwości
service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.ApiManagement/service/namedValues" |
| apiVersion | Wersja interfejsu API zasobów | "2021-12-01-preview" |
| name | Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON. |
ciąg (wymagany) |
| properties | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | ciąg (wymagany) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| wpis tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | bool |
| tags | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy Nazwanawartości. | ciąg[] |
| wartość | Wartość właściwości NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | ciąg |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nazwa | Opis | Wartość |
|---|---|---|
| identityClientId | Wartość null dla wartości SystemAssignedIdentity lub Client Id for UserAssignedIdentity , która będzie używana do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. | ciąg |
| secretIdentifier | Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Udostępnienie wpisów tajnych w wersji uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management za pomocą aka.ms/apimmsi | ciąg |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| Front Door Standard/Premium ze źródłem API Management |
Ten szablon tworzy usługę Front Door Premium i wystąpienie API Management oraz używa sieciowej grupy zabezpieczeń i zasad globalnych API Management w celu sprawdzenia, czy ruch przechodzi przez źródło usługi Front Door. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu service/namedValues można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Wartości właściwości
service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.ApiManagement/service/namedValues@2021-12-01-preview" |
| name | Nazwa zasobu | ciąg (wymagany) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługa |
| properties | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | ciąg (wymagany) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| wpis tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | bool |
| tags | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy Nazwanawartości. | ciąg[] |
| wartość | Wartość właściwości NamedValue. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | ciąg |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Nazwa | Opis | Wartość |
|---|---|---|
| identityClientId | Wartość null dla elementu SystemAssignedIdentity lub identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. | ciąg |
| secretIdentifier | Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi | ciąg |