Microsoft.ApiManagement-tjänst/cacheminnen 2023-09-01-preview

Bicep-resursdefinition

Resurstypen tjänst/cacheminnen kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Användningsexempel

Bicep-exempel

Ett grundläggande exempel på distribution av API Management Redis Cache.

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

resource redis 'Microsoft.Cache/redis@2023-04-01' = {
  name: resourceName
  location: 'eastus'
  properties: {
    enableNonSslPort: true
    minimumTlsVersion: '1.2'
    sku: {
      capacity: 2
      family: 'C'
      name: 'Standard'
    }
  }
}

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 cache 'Microsoft.ApiManagement/service/caches@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    connectionString: '${redis.name}.redis.cache.windows.net:6380,password=${redis.listKeys().primaryKey},ssl=true,abortConnect=False'
    useFromLocation: 'default'
  }
}

Azure-verifierade moduler

Följande Azure-verifierade moduler kan användas för att distribuera den här resurstypen.

Module Beskrivning
API Management Service - Cache AVM-barnmodul för API-hanteringstjänst - Cache

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Bicep-fil Beskrivning
Distribuera API Management med en extern Azure Cache for Redis- Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis-instans som extern API Management-cache.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/caches-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/caches@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    connectionString: 'string'
    description: 'string'
    resourceId: 'string'
    useFromLocation: 'string'
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/caches

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 80
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
Egenskaper Information om cacheegenskaper. CacheContractProperties (på engelska)

CacheContractProperties (på engelska)

Namn Beskrivning Värde
anslutningssträng Körningsanslutningssträng till cache sträng

Begränsningar:
Maximal längd = 300 (krävs)
beskrivning Cachebeskrivning sträng

Begränsningar:
Max längd = 2000
resursId Ursprunglig URI för entitet i externt systemcache pekar på sträng

Begränsningar:
Max längd = 2000
useFromLocation Platsidentifierare att använda cache från (ska vara antingen "standard" eller giltig Azure-regionidentifierare) sträng

Begränsningar:
Maximal längd = 256 (krävs)

Resursdefinition för ARM-mall

Resurstypen tjänst/cacheminnen kan distribueras med åtgärder som mål:

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall Beskrivning
Distribuera API Management med en extern Azure Cache for Redis-

Distribuera till Azure
Den här mallen visar hur du skapar en instans av Azure API Management på förbrukningsnivån med en extern Azure Cache for Redis-instans som extern API Management-cache.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/caches-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/caches",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "connectionString": "string",
    "description": "string",
    "resourceId": "string",
    "useFromLocation": "string"
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/caches

Namn Beskrivning Värde
apiVersion API-versionen "2023-09-01-preview"
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 80
Mönster = ^[^*#&+:<>?]+$ (krävs)
Egenskaper Information om cacheegenskaper. CacheContractProperties (på engelska)
typ Resurstypen "Microsoft.ApiManagement/service/caches"

CacheContractProperties (på engelska)

Namn Beskrivning Värde
anslutningssträng Körningsanslutningssträng till cache sträng

Begränsningar:
Maximal längd = 300 (krävs)
beskrivning Cachebeskrivning sträng

Begränsningar:
Max längd = 2000
resursId Ursprunglig URI för entitet i externt systemcache pekar på sträng

Begränsningar:
Max längd = 2000
useFromLocation Platsidentifierare att använda cache från (ska vara antingen "standard" eller giltig Azure-regionidentifierare) sträng

Begränsningar:
Maximal längd = 256 (krävs)

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/cacheminnen kan distribueras med åtgärder som mål:

  • Resursgrupper För en lista över ändrade egenskaper i varje API-version, se ändringslogg.

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på distribution av API Management Redis Cache.

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" "redis" {
  type      = "Microsoft.Cache/redis@2023-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = "eastus"
  body = {
    properties = {
      sku = {
        capacity = 2
        family   = "C"
        name     = "Standard"
      }
      enableNonSslPort  = true
      minimumTlsVersion = "1.2"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Cache/redis@2023-04-01"
  resource_id            = azapi_resource.redis.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

resource "azapi_resource" "cache" {
  type      = "Microsoft.ApiManagement/service/caches@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      connectionString = "${azapi_resource.redis.name}.redis.cache.windows.net:6380,password=${data.azapi_resource_action.listKeys.output.primaryKey},ssl=true,abortConnect=False"
      useFromLocation  = "default"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.connectionString]
  }
}

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/caches-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/caches@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      connectionString = "string"
      description = "string"
      resourceId = "string"
      useFromLocation = "string"
    }
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/caches

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 80
Mönster = ^[^*#&+:<>?]+$ (krävs)
föräldra_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Information om cacheegenskaper. CacheContractProperties (på engelska)
typ Resurstypen "Microsoft.ApiManagement/service/caches@2023-09-01-preview"

CacheContractProperties (på engelska)

Namn Beskrivning Värde
anslutningssträng Körningsanslutningssträng till cache sträng

Begränsningar:
Maximal längd = 300 (krävs)
beskrivning Cachebeskrivning sträng

Begränsningar:
Max längd = 2000
resursId Ursprunglig URI för entitet i externt systemcache pekar på sträng

Begränsningar:
Max längd = 2000
useFromLocation Platsidentifierare att använda cache från (ska vara antingen "standard" eller giltig Azure-regionidentifierare) sträng

Begränsningar:
Maximal längd = 256 (krävs)