Microsoft.ApiManagement service/namedValues 2023-05-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/namedValues kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/namedValues-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Eigenschaftswerte
service/namedValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: Dienst |
| properties | Eigenschaften des NamedValue-Entitätsvertrags für den PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten. | Zeichenfolge (erforderlich) |
| keyVault | KeyVault-Standortdetails des namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“. | bool |
| tags | Optionale Tags, die bei Angabe verwendet werden können, um die Liste NamedValue zu filtern. | string[] |
| value | Wert des NamedValue-Werts. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei "GET"-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Geheimnis des Schlüsseltresors verwendet wird. | Zeichenfolge |
| secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines versionsbasierten Geheimnisses verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Front Door Standard/Premium mit API Management Ursprung |
Diese Vorlage erstellt eine Front Door Premium- und eine API Management instance und verwendet eine NSG- und globale API Management-Richtlinie, um zu überprüfen, ob der Datenverkehr über den Front Door-Ursprung gekommen ist. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/namedValues kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/namedValues-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Eigenschaftswerte
service/namedValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/namedValues" |
| apiVersion | Die Ressourcen-API-Version | '2023-05-01-preview' |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| properties | Eigenschaften des NamedValue-Entitätsvertrags für PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten. | Zeichenfolge (erforderlich) |
| keyVault | Details zum KeyVault-Speicherort des namedValue-Werts. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“. | bool |
| tags | Optionale Tags, die bei Angabe verwendet werden können, um die NamedValue-Liste zu filtern. | string[] |
| value | Wert von NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird. | Zeichenfolge |
| secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines geheimen Schlüssels mit Versionsangabe verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Front Door Standard/Premium mit API Management Ursprung |
Diese Vorlage erstellt eine Front Door Premium- und eine API Management instance und verwendet eine NSG- und globale API Management richtlinie, um zu überprüfen, ob Datenverkehr den Front Door-Ursprung erreicht hat. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp service/namedValues kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/namedValues-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Eigenschaftswerte
service/namedValues
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
| properties | Eigenschaften des NamedValue-Entitätsvertrags für PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten. | Zeichenfolge (erforderlich) |
| keyVault | Details zum KeyVault-Speicherort des namedValue-Werts. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“. | bool |
| tags | Optionale Tags, die bei Angabe verwendet werden können, um die NamedValue-Liste zu filtern. | string[] |
| value | Wert von NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Zeichenfolge |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity , die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird. | Zeichenfolge |
| secretIdentifier | Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Die Bereitstellung eines geheimen Schlüssels mit Versionsangabe verhindert die automatische Aktualisierung. Dazu muss API Management Dienst mit aka.ms/apimmsi konfiguriert werden. | Zeichenfolge |