Microsoft.ApiManagement service/namedValues 2024-06-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp "service/namedValues" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- 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 die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Eigenschaftswerte
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. | Schnur |
| secretIdentifier | Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. | Schnur |
Microsoft.ApiManagement/service/namedValues
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| Elternteil | 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 des Typs: Dienst- |
| Eigenschaften | NamedValue-Entitätsvertragseigenschaften für PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Sie darf nur Buchstaben, Ziffern, Punkt, Gedankenstrich und Unterstriche enthalten. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[A-Za-z0-9-._]+$ (erforderlich) |
| keyVault | KeyVault-Standortdetails des namedValue.KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| geheim | Bestimmt, ob der Wert ein Geheimschlüssel ist und verschlüsselt werden soll. Der Standardwert ist "false". | Bool |
| Schilder | Optionale Tags, die verwendet werden können, um die NamedValue-Liste zu filtern. | string[] |
| Wert | Der Wert des NamedValue-Werts. Kann Richtlinienausdrücke enthalten. Es darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Schnur Zwänge: Max. Länge = |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Front Door Standard/Premium mit API-Management-Ursprung | Diese Vorlage erstellt eine Front Door Premium- und eine API-Verwaltungsinstanz und verwendet eine NSG- und globale API-Verwaltungsrichtlinie, um zu überprüfen, ob der Datenverkehr über den Front Door-Ursprung erfolgt ist. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "service/namedValues" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- 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": "2024-06-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Eigenschaftswerte
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. | Schnur |
| secretIdentifier | Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. | Schnur |
Microsoft.ApiManagement/service/namedValues
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2024-06-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| Eigenschaften | NamedValue-Entitätsvertragseigenschaften für PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/namedValues' |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Sie darf nur Buchstaben, Ziffern, Punkt, Gedankenstrich und Unterstriche enthalten. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[A-Za-z0-9-._]+$ (erforderlich) |
| keyVault | KeyVault-Standortdetails des namedValue.KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| geheim | Bestimmt, ob der Wert ein Geheimschlüssel ist und verschlüsselt werden soll. Der Standardwert ist "false". | Bool |
| Schilder | Optionale Tags, die verwendet werden können, um die NamedValue-Liste zu filtern. | string[] |
| Wert | Der Wert des NamedValue-Werts. Kann Richtlinienausdrücke enthalten. Es darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Schnur Zwänge: Max. Länge = |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Front Door Standard/Premium mit API-Management-Ursprung
|
Diese Vorlage erstellt eine Front Door Premium- und eine API-Verwaltungsinstanz und verwendet eine NSG- und globale API-Verwaltungsrichtlinie, um zu überprüfen, ob der Datenverkehr über den Front Door-Ursprung erfolgt ist. |
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 unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/namedValues-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Eigenschaftswerte
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| identityClientId | Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird. | Schnur |
| secretIdentifier | Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. | Schnur |
Microsoft.ApiManagement/service/namedValues
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Max. Länge = Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | NamedValue-Entitätsvertragseigenschaften für PUT-Vorgang. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/namedValues@2024-06-01-preview" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| displayName | Eindeutiger Name von NamedValue. Sie darf nur Buchstaben, Ziffern, Punkt, Gedankenstrich und Unterstriche enthalten. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[A-Za-z0-9-._]+$ (erforderlich) |
| keyVault | KeyVault-Standortdetails des namedValue.KeyVault location details of the namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| geheim | Bestimmt, ob der Wert ein Geheimschlüssel ist und verschlüsselt werden soll. Der Standardwert ist "false". | Bool |
| Schilder | Optionale Tags, die verwendet werden können, um die NamedValue-Liste zu filtern. | string[] |
| Wert | Der Wert des NamedValue-Werts. Kann Richtlinienausdrücke enthalten. Es darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen. | Schnur Zwänge: Max. Länge = |