Microsoft.ApiManagement service/workspaces/namedValues
Bicep-resursdefinition
Resurstypen service/workspaces/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/namedValues-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Egenskapsvärden
service/workspaces/namedValues
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: arbetsytor |
properties | NamedValue-entitetskontraktegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
Name | Beskrivning | Värde |
---|---|---|
displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) |
keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
hemlighet | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | boolesk |
tags | Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue. | string[] |
värde | Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet. | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | Beskrivning | Värde |
---|---|---|
identityClientId | Null för SystemAssignedIdentity eller Klient-ID för UserAssignedIdentity , som används för att komma åt nyckelvalvshemlighet. | sträng |
secretIdentifier | Hemlig identifierare för Nyckelvalv för att hämta hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Resursdefinition för ARM-mall
Resurstypen service/workspaces/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/namedValues-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/workspaces/namedValues",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
Egenskapsvärden
service/workspaces/namedValues
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/namedValues" |
apiVersion | Resurs-API-versionen | "2023-05-01-preview" |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
properties | NamedValue-entitetskontraktegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
Name | Beskrivning | Värde |
---|---|---|
displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) |
keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
hemlighet | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är false. | boolesk |
tags | Valfria taggar som när de tillhandahålls kan användas för att filtrera namedvalue-listan. | string[] |
värde | Värdet för NamedValue. Kan innehålla principuttryck. Det får inte vara tomt eller bara bestå av tomt utrymme. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | Beskrivning | Värde |
---|---|---|
identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. | sträng |
secretIdentifier | Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/workspaces/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/namedValues-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/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"
}
})
}
Egenskapsvärden
service/workspaces/namedValues
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/namedValues@2023-05-01-preview" |
name | Resursnamnet | sträng (krävs) |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: arbetsytor |
properties | Egenskaper för entitetskontraktet NamedValue för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
Name | Beskrivning | Värde |
---|---|---|
displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng (krävs) |
keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
hemlighet | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är false. | boolesk |
tags | Valfria taggar som när de tillhandahålls kan användas för att filtrera namedvalue-listan. | string[] |
värde | Värdet för NamedValue. Kan innehålla principuttryck. Det får inte vara tomt eller bara bestå av tomt utrymme. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. | sträng |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
Name | Beskrivning | Värde |
---|---|---|
identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som används för att komma åt key vault-hemlighet. | sträng |
secretIdentifier | Key Vault-hemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindras automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi | sträng |
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för