Microsoft.ApiManagement service/namedValues 2020-12-01
Definicja zasobu Bicep
Typ zasobu service/namedValues można wdrożyć przy użyciu operacji docelowych:
- 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 dziennika 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@2020-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Wartości właściwości
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | struna |
| 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 | struna |
Microsoft.ApiManagement/service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| rodzic | W 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. |
Nazwa symboliczna zasobu typu: usługi |
| Właściwości | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | Bool |
| Tagi | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. | string[] |
| wartość | Wartość nazwanej wartości. 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 na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | struna Ograniczenia: Maksymalna długość = 4096 |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
| Plik Bicep | Opis |
|---|---|
| usługi Front Door Standard/Premium z źródła usługi API Management | Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, 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ć przy użyciu operacji docelowych:
- 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 dziennika 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": "2020-12-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Wartości właściwości
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | struna |
| 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 | struna |
Microsoft.ApiManagement/service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | '2020-12-01' |
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| Właściwości | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/namedValues" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | Bool |
| Tagi | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. | string[] |
| wartość | Wartość nazwanej wartości. 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 na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | struna Ograniczenia: Maksymalna długość = 4096 |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
usługi Front Door Standard/Premium z źródła usługi API Management wdrażanie  |
Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, 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ć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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@2020-12-01"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Wartości właściwości
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 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. | struna |
| 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 | struna |
Microsoft.ApiManagement/service/namedValues
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Właściwości kontraktu jednostki NamedValue dla operacji PUT. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/namedValues@2020-12-01" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| displayName | Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 256 Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane) |
| keyVault | Szczegóły lokalizacji usługi KeyVault o nazwieValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| tajny | Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. | Bool |
| Tagi | Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. | string[] |
| wartość | Wartość nazwanej wartości. 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 na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. | struna Ograniczenia: Maksymalna długość = 4096 |