Usługa Microsoft.ApiManagement/namedValues 2021-12-01-wersja zapoznawcza

Definicja zasobu Bicep

Typ zasobu service/namedValues można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Przykłady użycia

Przykłady Bicep

Podstawowy przykład wdrażania API Management nazwanej wartości.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 0
    name: 'Consumption'
  }
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
}

resource namedValue 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    displayName: 'TestProperty230630032559683679'
    secret: false
    tags: [
      'tag1'
      'tag2'
    ]
    value: 'Test Value'
  }
}

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Module Opis
Usługa zarządzania API – Nazwana wartość Moduł podrzędny AVM dla usługi zarządzania API – Nazwana Wartość

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
usługi Front Door Standard/Premium z źródła usługi API Management Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, czy ruch przechodzi przez źródło usługi Front Door.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/namedValues

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
nadrzędny W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości kontraktu jednostki NamedValue dla operacji PUT. NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Nazwa Opis Wartość
identityClientId (identyfikator klienta) Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. ciąg
secretIdentifier (identyfikator sekretu) Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi ciąg

NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties

Nazwa Opis Wartość
nazwa wyświetlana Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane)
keyVault Szczegóły lokalizacji usługi KeyVault o nazwieValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
klucz tajny Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. Bool
Tagi Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. ciąg znakowy[]
wartość Wartość nazwanej wartości. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Maksymalna długość = 4096

Definicja zasobu szablonu usługi ARM

Typ zasobu service/namedValues można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
usługi Front Door Standard/Premium z źródła usługi API Management

wdrażanie w usłudze Azure
Ten szablon tworzy usługę Front Door Premium i wystąpienie usługi API Management oraz używa sieciowej grupy zabezpieczeń i globalnych zasad usługi API Management, aby sprawdzić, czy ruch przechodzi przez źródło usługi Front Door.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.ApiManagement/service/namedValues

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2021-12-01-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości kontraktu jednostki NamedValue dla operacji PUT. NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/namedValues"

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Nazwa Opis Wartość
identityClientId (identyfikator klienta) Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. ciąg
secretIdentifier (identyfikator sekretu) Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi ciąg

NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties

Nazwa Opis Wartość
nazwa wyświetlana Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane)
keyVault Szczegóły lokalizacji usługi KeyVault o nazwieValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
klucz tajny Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. Bool
Tagi Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. ciąg znakowy[]
wartość Wartość nazwanej wartości. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Maksymalna długość = 4096

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/namedValues można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania API Management nazwanej wartości.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "namedValue" {
  type      = "Microsoft.ApiManagement/service/namedValues@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      displayName = "TestProperty230630032559683679"
      secret      = false
      tags = [
        "tag1",
        "tag2",
      ]
      value = "Test Value"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/namedValues, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/namedValues@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  }
}

Wartości właściwości

Microsoft.ApiManagement/service/namedValues

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Maksymalna długość = 256
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości kontraktu jednostki NamedValue dla operacji PUT. NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/namedValues@2021-12-01-preview"

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

Nazwa Opis Wartość
identityClientId (identyfikator klienta) Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. ciąg
secretIdentifier (identyfikator sekretu) Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi ciąg

NazwanaWartośćCreateContractPropertiesOrNamedValueContractProperties

Nazwa Opis Wartość
nazwa wyświetlana Unikatowa nazwa nazwa_wartości. Może zawierać tylko litery, cyfry, kropkę, kreskę i znaki podkreślenia. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 256
Wzorzec = ^[A-Za-z0-9-._]+$ (wymagane)
keyVault Szczegóły lokalizacji usługi KeyVault o nazwieValue. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
klucz tajny Określa, czy wartość jest wpisem tajnym i powinna być zaszyfrowana, czy nie. Wartość domyślna to false. Bool
Tagi Opcjonalne tagi, które po podaniu mogą służyć do filtrowania listy NamedValue. ciąg znakowy[]
wartość Wartość nazwanej wartości. Może zawierać wyrażenia zasad. Może nie być pusty lub składać się tylko z białych znaków. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Maksymalna długość = 4096