Microsoft.ApiManagement 서비스/caches 2024-05-01

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/캐시 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

사용 예제

Bicep 샘플

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 확인된 모듈

다음 Azure 확인된 모듈 사용하여 이 리소스 유형을 배포할 수 있습니다.

Module 묘사
API 관리 서비스 - 캐시 API 관리 서비스용 AVM 자식 모듈 - 캐시

Azure 빠른 시작 샘플

다음 Azure 빠른 시작 템플릿에는 이 리소스 유형을 배포하기 위한 Bicep 샘플이 포함되어 있습니다.

Bicep 파일 묘사
외부 Azure Cache for Redis 사용하여 API Management 배포 이 템플릿은 외부 Azure Cache for Redis 인스턴스를 API Management 외부 캐시로 사용하여 소비 계층에서 Azure API Management 인스턴스를 만드는 방법을 보여 줍니다.

리소스 형식

Microsoft.ApiManagement/service/caches 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

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

속성 값

Microsoft.ApiManagement/서비스/캐시

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식의 리소스에 대한 기호 이름: 서비스
속성 캐시 속성 세부 정보입니다. 캐시컨트랙트프로퍼티

캐시컨트랙트프로퍼티

이름 묘사 값
연결 문자열 캐시할 런타임 연결 문자열 문자열

제약 조건:
최대 길이 = 300(필수)
묘사 캐시 설명 문자열

제약 조건:
최대 길이 = 2000
리소스ID 외부 시스템 캐시에 있는 엔터티의 원래 URI는 다음을 가리킵니다. 문자열

제약 조건:
최대 길이 = 2000
useFromLocation 캐시를 사용할 위치 식별자('기본' 또는 유효한 Azure 지역 식별자여야 합니다). 문자열

제약 조건:
최대 길이 = 256(필수)

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/캐시 리소스 유형을 배포할 수 있습니다.

사용 예제

Azure 빠른 시작 템플릿

다음 Azure 빠른 시작 템플릿은 이 리소스 유형을 배포할 있습니다.

템플렛 묘사
외부 Azure Cache for Redis 사용하여 API Management 배포

Azure
배포
이 템플릿은 외부 Azure Cache for Redis 인스턴스를 API Management 외부 캐시로 사용하여 소비 계층에서 Azure API Management 인스턴스를 만드는 방법을 보여 줍니다.

리소스 형식

Microsoft.ApiManagement/service/caches 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

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

속성 값

Microsoft.ApiManagement/서비스/캐시

이름 묘사 값
API버전 api 버전 '2024-05-01'
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
속성 캐시 속성 세부 정보입니다. 캐시컨트랙트프로퍼티
형 리소스 종류 'Microsoft.ApiManagement/서비스/캐시'

캐시컨트랙트프로퍼티

이름 묘사 값
연결 문자열 캐시할 런타임 연결 문자열 문자열

제약 조건:
최대 길이 = 300(필수)
묘사 캐시 설명 문자열

제약 조건:
최대 길이 = 2000
리소스ID 외부 시스템 캐시에 있는 엔터티의 원래 URI는 다음을 가리킵니다. 문자열

제약 조건:
최대 길이 = 2000
useFromLocation 캐시를 사용할 위치 식별자('기본' 또는 유효한 Azure 지역 식별자여야 합니다). 문자열

제약 조건:
최대 길이 = 256(필수)

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업으로 서비스/캐시 리소스 유형을 배포할 수 있습니다.

  • 자원 그룹 각 API 버전에서 변경된 속성 목록은 변경 로그를 참조하세요.

사용 예제

Terraform 샘플

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]
  }
}

리소스 형식

Microsoft.ApiManagement/service/caches 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

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

속성 값

Microsoft.ApiManagement/서비스/캐시

이름 묘사 값
이름 리소스 이름 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 80
패턴 = ^[^*#&+:<>?]+$(필수)
부모 ID 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
속성 캐시 속성 세부 정보입니다. 캐시컨트랙트프로퍼티
형 리소스 종류 "Microsoft.ApiManagement/서비스/caches@2024-05-01"

캐시컨트랙트프로퍼티

이름 묘사 값
연결 문자열 캐시할 런타임 연결 문자열 문자열

제약 조건:
최대 길이 = 300(필수)
묘사 캐시 설명 문자열

제약 조건:
최대 길이 = 2000
리소스ID 외부 시스템 캐시에 있는 엔터티의 원래 URI는 다음을 가리킵니다. 문자열

제약 조건:
최대 길이 = 2000
useFromLocation 캐시를 사용할 위치 식별자('기본' 또는 유효한 Azure 지역 식별자여야 합니다). 문자열

제약 조건:
최대 길이 = 256(필수)