Delen via

Microsoft.ApiManagement-service/namedValues 2024-05-01

  • Artikel

Bicep-resourcedefinitie

Het resourcetype service/namedValues kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.ApiManagement/service/namedValues wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

Eigenschapswaarden

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Naam Beschrijving Waarde
identityClientId Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim. snaar
secretIdentifier Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi snaar

Microsoft.ApiManagement/service/namedValues

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: service
Eigenschappen Benoemde entiteitscontracteigenschappen voor PUT-bewerking. NamedValueCreateContractPropertiesOrNamedValueContractProperties

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Naam Beschrijving Waarde
displayName Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[A-Za-z0-9-._]+$ (vereist)
keyVault KeyVault-locatiedetails van de namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
geheim Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar. Bool
Tags Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren. tekenreeks[]
waarde Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Maximale lengte =

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand Beschrijving
Front Door Standard/Premium met API Management-oorsprong Met deze sjabloon maakt u een Front Door Premium en een API Management-exemplaar en gebruikt u een NSG- en globaal API Management-beleid om te valideren dat verkeer afkomstig is van de Front Door-oorsprong.

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/namedValues kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/namedValues-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/namedValues",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Eigenschapswaarden

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Naam Beschrijving Waarde
identityClientId Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim. snaar
secretIdentifier Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi snaar

Microsoft.ApiManagement/service/namedValues

Naam Beschrijving Waarde
apiVersion De API-versie '2024-05-01'
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
Eigenschappen Benoemde entiteitscontracteigenschappen voor PUT-bewerking. NamedValueCreateContractPropertiesOrNamedValueContractProperties
type Het resourcetype 'Microsoft.ApiManagement/service/namedValues'

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Naam Beschrijving Waarde
displayName Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[A-Za-z0-9-._]+$ (vereist)
keyVault KeyVault-locatiedetails van de namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
geheim Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar. Bool
Tags Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren. tekenreeks[]
waarde Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Maximale lengte =

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
Front Door Standard/Premium met API Management-oorsprong

implementeren in Azure 		Met deze sjabloon maakt u een Front Door Premium en een API Management-exemplaar en gebruikt u een NSG- en globaal API Management-beleid om te valideren dat verkeer afkomstig is van de Front Door-oorsprong.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/namedValues kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/namedValues-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/namedValues@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

Eigenschapswaarden

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Naam Beschrijving Waarde
identityClientId Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim. snaar
secretIdentifier Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi snaar

Microsoft.ApiManagement/service/namedValues

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Maximale lengte =
Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: service-
Eigenschappen Benoemde entiteitscontracteigenschappen voor PUT-bewerking. NamedValueCreateContractPropertiesOrNamedValueContractProperties
type Het resourcetype "Microsoft.ApiManagement/service/namedValues@2024-05-01"

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Naam Beschrijving Waarde
displayName Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[A-Za-z0-9-._]+$ (vereist)
keyVault KeyVault-locatiedetails van de namedValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
geheim Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar. Bool
Tags Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren. tekenreeks[]
waarde Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Maximale lengte =