Share via

Microsoft.ApiManagement service/gateways/certificateAuthorities 2020-06-01-preview

Bicep resource definition

The service/gateways/certificateAuthorities resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/gateways/certificateAuthorities resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    isTrusted: bool
  }
}

Property Values

Microsoft.ApiManagement/service/gateways/certificateAuthorities

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service/gateways
properties Gateway certificate authority details. GatewayCertificateAuthorityContractProperties

GatewayCertificateAuthorityContractProperties

Name Description Value
isTrusted Determines whether certificate authority is trusted. bool

Usage Examples

Bicep Samples

A basic example of deploying API Management Gateway Certificate Authority.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The base64-encoded certificate data')
param certificateData string
@secure()
@description('The password for the certificate')
param certificatePassword string

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  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.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30': '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: 1
    name: 'Developer'
  }
}

resource certificate 'Microsoft.ApiManagement/service/certificates@2021-08-01' = {
  parent: service
  name: resourceName
  properties: {
    data: null
    password: null
  }
}

resource gateway 'Microsoft.ApiManagement/service/gateways@2021-08-01' = {
  parent: service
  name: resourceName
  properties: {
    description: ''
    locationData: {
      city: ''
      countryOrRegion: ''
      district: ''
      name: 'test'
    }
  }
}

resource certificateAuthority 'Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-08-01' = {
  parent: gateway
  name: 'certificate.name'
  properties: {
    isTrusted: false
  }
}

ARM template resource definition

The service/gateways/certificateAuthorities resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/gateways/certificateAuthorities resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/gateways/certificateAuthorities",
  "apiVersion": "2020-06-01-preview",
  "name": "string",
  "properties": {
    "isTrusted": "bool"
  }
}

Property Values

Microsoft.ApiManagement/service/gateways/certificateAuthorities

Name Description Value
apiVersion The api version '2020-06-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
properties Gateway certificate authority details. GatewayCertificateAuthorityContractProperties
type The resource type 'Microsoft.ApiManagement/service/gateways/certificateAuthorities'

GatewayCertificateAuthorityContractProperties

Name Description Value
isTrusted Determines whether certificate authority is trusted. bool

Usage Examples

Terraform (AzAPI provider) resource definition

The service/gateways/certificateAuthorities resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/gateways/certificateAuthorities resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      isTrusted = bool
    }
  }
}

Property Values

Microsoft.ApiManagement/service/gateways/certificateAuthorities

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/gateways
properties Gateway certificate authority details. GatewayCertificateAuthorityContractProperties
type The resource type "Microsoft.ApiManagement/service/gateways/certificateAuthorities@2020-06-01-preview"

GatewayCertificateAuthorityContractProperties

Name Description Value
isTrusted Determines whether certificate authority is trusted. bool

Usage Examples

Terraform Samples

A basic example of deploying API Management Gateway Certificate Authority.

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

variable "certificate_data" {
  type        = string
  description = "The base64-encoded certificate data"
  sensitive   = true
}

variable "certificate_password" {
  type        = string
  description = "The password for the certificate"
  sensitive   = true
}

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.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168"                         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30"                              = "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 = 1
      name     = "Developer"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  timeouts {
    create = "180m"
    update = "180m"
    delete = "60m"
  }
}

resource "azapi_resource" "gateway" {
  type      = "Microsoft.ApiManagement/service/gateways@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      locationData = {
        city            = ""
        countryOrRegion = ""
        district        = ""
        name            = "test"
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "certificate" {
  type      = "Microsoft.ApiManagement/service/certificates@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      data     = var.certificate_data
      password = var.certificate_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "certificateAuthority" {
  type      = "Microsoft.ApiManagement/service/gateways/certificateAuthorities@2021-08-01"
  parent_id = azapi_resource.gateway.id
  name      = azapi_resource.certificate.name
  body = {
    properties = {
      isTrusted = false
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on