Microsoft.ApiManagement service/workspaces/namedValues 2023-05-01-preview
Bicep-resursdefinition
Resurstypen service/workspaces/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
Egenskapsvärden
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av 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 |
Microsoft.ApiManagement/service/workspaces/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| förälder | 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 den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst/arbetsytor |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[A-Za-z0-9-._]+$ (krävs) |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | 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 Begränsningar: Max längd = |
Resursdefinition för ARM-mall
Resurstypen service/workspaces/namedValues kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av 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 |
Microsoft.ApiManagement/service/workspaces/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | "2023-05-01-preview" |
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/namedValues" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[A-Za-z0-9-._]+$ (krävs) |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | 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 Begränsningar: Max längd = |
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"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
Egenskapsvärden
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| identityClientId | Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet. | sträng |
| secretIdentifier | Nyckelvalvshemlighetsidentifierare för hämtning av 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 |
Microsoft.ApiManagement/service/workspaces/namedValues
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Max längd = Mönster = ^[^*#&+:<>?]+$ (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst/arbetsytor |
| Egenskaper | NamedValue-entitetskontraktsegenskaper för PUT-åtgärden. | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/namedValues@2023-05-01-preview" |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| displayName | Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[A-Za-z0-9-._]+$ (krävs) |
| keyVault | KeyVault-platsinformation för namedValue. | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| hemlig | Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt. | Bool |
| Taggar | 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 Begränsningar: Max längd = |