Microsoft.ApiManagement-service 2017-03-01

• meest recente
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview-
• 2023-03-01-preview-
• 2022-09-01-preview-
• 2022-08-01
• 2022-04-01-preview-
• 2021-12-01-preview-
• 2021-08-01
• 2021-04-01-preview-
• 2021-01-01-preview-
• 2020-12-01
• 2020-06-01-preview-
• 2019-12-01
• 2019-12-01-preview-
• 2019-01-01
• 2018-06-01-preview-
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep-resourcedefinitie

Het resourcetype van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

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

Resource-indeling

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

resource symbolicname 'Microsoft.ApiManagement/service@2017-03-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
      }
    ]
    certificates: [
      {
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificatePassword: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    notificationSenderEmail: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

AdditionalLocation

Naam	Beschrijving	Waarde
plaats	De locatienaam van de extra regio tussen Azure Data Center-regio's.	tekenreeks (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk voor de locatie.	VirtualNetworkConfiguration-

ApiManagementServiceBasePropertiesCustomProperties

Naam	Beschrijving	Waarde

ApiManagementServiceIdentity

Naam	Beschrijving	Waarde
type	Het identiteitstype. Momenteel is het enige ondersteunde type SystemAssigned.	'SystemAssigned' (vereist)

ApiManagementServiceProperties

Naam	Beschrijving	Waarde
additionalLocations	Aanvullende datacenterlocaties van de API Management-service.	AdditionalLocation[]
Certificaten	Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd, is 10.	CertificateConfiguration[]
customProperties	Aangepaste eigenschappen van de API Management-service. Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld. Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen en Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.	ApiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Aangepaste hostnaamconfiguratie van de API Management-service.	HostnameConfiguration[]
notificationSenderEmail	E-mailadres van waaruit de melding wordt verzonden.	snaar Beperkingen: Maximale lengte = 100
publisherEmail	E-mail van Publisher.	snaar Beperkingen: Maximale lengte = 100 (vereist)
publisherName	Naam van uitgever.	snaar Beperkingen: Maximale lengte = 100 (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk van de API Management-service.	VirtualNetworkConfiguration-
virtualNetworkType	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.	'Extern' 'Intern' 'Geen'

ApiManagementServiceSkuProperties

Naam	Beschrijving	Waarde
capaciteit	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). De standaardwaarde is 1.	Int
naam	Naam van de SKU.	'Basis' 'Ontwikkelaar' 'Premium' 'Standaard' (vereist)

ApimResourceTags

Naam	Beschrijving	Waarde

CertificateConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
storeName	De locatie van het lokale certificaatarchief. Alleen root en CertificateAuthority zijn geldige locaties.	'CertificateAuthority' 'Hoofdmap' (vereist)

HostnameConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
defaultSslBinding	Geef true op voor het instellen van het certificaat dat is gekoppeld aan deze hostnaam als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, wordt dit het certificaat dat wordt aangeroepen. De eigenschap is handig als voor een service meerdere aangepaste hostnaam is ingeschakeld en moet worden bepaald welk standaard-SSL-certificaat moet worden gebruikt. De instelling wordt alleen toegepast op het type proxyhostnaam.	Bool
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
hostName	Hostnaam die moet worden geconfigureerd voor de Api Management-service.	tekenreeks (vereist)
keyVaultId	Url naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt automatisch bijwerken van ssl-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met MSI. Het geheim moet van het type application/x-pkcs12	snaar
negotiateClientCertificate	Geef waar op om altijd te onderhandelen over clientcertificaat op de hostnaam. De standaardwaarde is onwaar.	Bool
type	Type hostnaam.	'Beheer' 'Portal' 'Proxy' 'Scm' (vereist)

Microsoft.ApiManagement/service

Naam	Beschrijving	Waarde
identiteit	Beheerde service-identiteit van de Api Management-service.	ApiManagementServiceIdentity-
plaats	Resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 50 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist)
Eigenschappen	Eigenschappen van de API Management-service.	ApiManagementServiceProperties (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

VirtualNetworkConfiguration

Naam	Beschrijving	Waarde
subnetResourceId	De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd.	snaar Beperkingen: Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand	Beschrijving
Application Gateway met interne API Management en Web App	Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.
Een API Management-exemplaar met meerdere regio's maken	Deze sjabloon laat zien hoe u een API Management-exemplaar maakt met extra locaties. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en VS - oost2. De primaire locatie moet afwijken van extra locaties.
Een API Management-exemplaar maken met MSI Identity	Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit
Een API Management-exemplaar maken met behulp van een sjabloon	Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management
Een API Management-service maken met een privé-eindpunt	Met deze sjabloon maakt u een API Management-service, een virtueel netwerk en een privé-eindpunt dat de API Management-service beschikbaar maakt voor het virtuele netwerk.
Een API Management-service maken met SSL vanuit KeyVault	Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met door de gebruiker toegewezen identiteit. Deze identiteit gebruikt om een SSL-certificaat op te halen uit KeyVault en wordt bijgewerkt door elke 4 uur te controleren.
API Management maken in intern VNet met App Gateway-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt op een particulier netwerk dat wordt beveiligd door Azure Application Gateway.
API Management implementeren in een extern VNet met openbare IP-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de externe modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
API Management implementeren in een intern VNet met openbare IP-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de interne modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
API Management implementeren in beschikbaarheidszones	Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone
API Management implementeren met een externe Azure Cache voor Redis-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de verbruikslaag met een extern Exemplaar van Azure Cache voor Redis als de externe API Management-cache.
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 van de service kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

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

Resource-indeling

Als u een Microsoft.ApiManagement/serviceresource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2017-03-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        }
      }
    ],
    "certificates": [
      {
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificatePassword": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "notificationSenderEmail": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

AdditionalLocation

Naam	Beschrijving	Waarde
plaats	De locatienaam van de extra regio tussen Azure Data Center-regio's.	tekenreeks (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk voor de locatie.	VirtualNetworkConfiguration-

ApiManagementServiceBasePropertiesCustomProperties

Naam	Beschrijving	Waarde

ApiManagementServiceIdentity

Naam	Beschrijving	Waarde
type	Het identiteitstype. Momenteel is het enige ondersteunde type SystemAssigned.	'SystemAssigned' (vereist)

ApiManagementServiceProperties

Naam	Beschrijving	Waarde
additionalLocations	Aanvullende datacenterlocaties van de API Management-service.	AdditionalLocation[]
Certificaten	Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd, is 10.	CertificateConfiguration[]
customProperties	Aangepaste eigenschappen van de API Management-service. Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld. Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen en Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.	ApiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Aangepaste hostnaamconfiguratie van de API Management-service.	HostnameConfiguration[]
notificationSenderEmail	E-mailadres van waaruit de melding wordt verzonden.	snaar Beperkingen: Maximale lengte = 100
publisherEmail	E-mail van Publisher.	snaar Beperkingen: Maximale lengte = 100 (vereist)
publisherName	Naam van uitgever.	snaar Beperkingen: Maximale lengte = 100 (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk van de API Management-service.	VirtualNetworkConfiguration-
virtualNetworkType	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.	'Extern' 'Intern' 'Geen'

ApiManagementServiceSkuProperties

Naam	Beschrijving	Waarde
capaciteit	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). De standaardwaarde is 1.	Int
naam	Naam van de SKU.	'Basis' 'Ontwikkelaar' 'Premium' 'Standaard' (vereist)

ApimResourceTags

Naam	Beschrijving	Waarde

CertificateConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
storeName	De locatie van het lokale certificaatarchief. Alleen root en CertificateAuthority zijn geldige locaties.	'CertificateAuthority' 'Hoofdmap' (vereist)

HostnameConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
defaultSslBinding	Geef true op voor het instellen van het certificaat dat is gekoppeld aan deze hostnaam als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, wordt dit het certificaat dat wordt aangeroepen. De eigenschap is handig als voor een service meerdere aangepaste hostnaam is ingeschakeld en moet worden bepaald welk standaard-SSL-certificaat moet worden gebruikt. De instelling wordt alleen toegepast op het type proxyhostnaam.	Bool
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
hostName	Hostnaam die moet worden geconfigureerd voor de Api Management-service.	tekenreeks (vereist)
keyVaultId	Url naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt automatisch bijwerken van ssl-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met MSI. Het geheim moet van het type application/x-pkcs12	snaar
negotiateClientCertificate	Geef waar op om altijd te onderhandelen over clientcertificaat op de hostnaam. De standaardwaarde is onwaar.	Bool
type	Type hostnaam.	'Beheer' 'Portal' 'Proxy' 'Scm' (vereist)

Microsoft.ApiManagement/service

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2017-03-01'
identiteit	Beheerde service-identiteit van de Api Management-service.	ApiManagementServiceIdentity-
plaats	Resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 50 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist)
Eigenschappen	Eigenschappen van de API Management-service.	ApiManagementServiceProperties (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type	Het resourcetype	'Microsoft.ApiManagement/service'

VirtualNetworkConfiguration

Naam	Beschrijving	Waarde
subnetResourceId	De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd.	snaar Beperkingen: Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Quickstart-sjablonen

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

Sjabloon	Beschrijving
Application Gateway met interne API Management en Web App	Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.
Een API Management-exemplaar met meerdere regio's maken	Deze sjabloon laat zien hoe u een API Management-exemplaar maakt met extra locaties. De primaire locatie is hetzelfde als de locatie van de resourcegroep. Voor extra locaties toont de sjabloon NorthCentralUs en VS - oost2. De primaire locatie moet afwijken van extra locaties.
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-	Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert
Een API Management-exemplaar maken met MSI Identity	Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management met een MSI-identiteit
Een API Management-exemplaar maken met behulp van een sjabloon	Met deze sjabloon maakt u een ontwikkelaarsexemplaren van Azure API Management
Een API Management-exemplaar maken met aangepaste hostnamen	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt met aangepaste hostnaam voor de portal en meerdere aangepaste hostnamen voor proxy
Een API Management-service maken met een privé-eindpunt	Met deze sjabloon maakt u een API Management-service, een virtueel netwerk en een privé-eindpunt dat de API Management-service beschikbaar maakt voor het virtuele netwerk.
Een API Management-service maken met SSL vanuit KeyVault	Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met door de gebruiker toegewezen identiteit. Deze identiteit gebruikt om een SSL-certificaat op te halen uit KeyVault en wordt bijgewerkt door elke 4 uur te controleren.
API Management-exemplaar maken en bewaken	Met deze sjabloon maakt u een exemplaar van de Azure API Management-service en Log Analytics-werkruimte en stelt u bewaking in voor uw API Management-service met Log Analytics
API Management maken in intern VNet met App Gateway-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt op een particulier netwerk dat wordt beveiligd door Azure Application Gateway.
API Management maken met aangepaste proxy ssl met behulp van KeyVault	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt en aangepaste hostnaam configureert voor proxy met ssl-certificaat vanuit keyvault.
Azure Front Door maken vóór Azure API Management	In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management.
API Management implementeren in een extern VNet met openbare IP-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de externe modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
API Management implementeren in een intern VNet met openbare IP-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de Premium-laag binnen het subnet van uw virtuele netwerk in de interne modus en aanbevolen NSG-regels configureert op het subnet. Het exemplaar wordt geïmplementeerd in twee beschikbaarheidszones. Met de sjabloon wordt ook een openbaar IP-adres van uw abonnement geconfigureerd.
API Management implementeren in beschikbaarheidszones	Met deze sjabloon maakt u een Premium-exemplaar van Azure API Management en implementeert u deze in een beschikbaarheidszone
API Management implementeren met een externe Azure Cache voor Redis-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt in de verbruikslaag met een extern Exemplaar van Azure Cache voor Redis als de externe API Management-cache.
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 Terraform (AzAPI-provider)

Het resourcetype van de service 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/serviceresource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2017-03-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
        }
      ]
      certificates = [
        {
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificatePassword = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      notificationSenderEmail = "string"
      publisherEmail = "string"
      publisherName = "string"
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Eigenschapswaarden

AdditionalLocation

Naam	Beschrijving	Waarde
plaats	De locatienaam van de extra regio tussen Azure Data Center-regio's.	tekenreeks (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk voor de locatie.	VirtualNetworkConfiguration-

ApiManagementServiceBasePropertiesCustomProperties

Naam	Beschrijving	Waarde

ApiManagementServiceIdentity

Naam	Beschrijving	Waarde
type	Het identiteitstype. Momenteel is het enige ondersteunde type SystemAssigned.	'SystemAssigned' (vereist)

ApiManagementServiceProperties

Naam	Beschrijving	Waarde
additionalLocations	Aanvullende datacenterlocaties van de API Management-service.	AdditionalLocation[]
Certificaten	Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd, is 10.	CertificateConfiguration[]
customProperties	Aangepaste eigenschappen van de API Management-service. Als u Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 instelt, worden de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitgeschakeld. Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen en Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.	ApiManagementServiceBasePropertiesCustomProperties
hostnameConfigurations	Aangepaste hostnaamconfiguratie van de API Management-service.	HostnameConfiguration[]
notificationSenderEmail	E-mailadres van waaruit de melding wordt verzonden.	snaar Beperkingen: Maximale lengte = 100
publisherEmail	E-mail van Publisher.	snaar Beperkingen: Maximale lengte = 100 (vereist)
publisherName	Naam van uitgever.	snaar Beperkingen: Maximale lengte = 100 (vereist)
virtualNetworkConfiguration	Configuratie van virtueel netwerk van de API Management-service.	VirtualNetworkConfiguration-
virtualNetworkType	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.	'Extern' 'Intern' 'Geen'

ApiManagementServiceSkuProperties

Naam	Beschrijving	Waarde
capaciteit	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). De standaardwaarde is 1.	Int
naam	Naam van de SKU.	'Basis' 'Ontwikkelaar' 'Premium' 'Standaard' (vereist)

ApimResourceTags

Naam	Beschrijving	Waarde

CertificateConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
storeName	De locatie van het lokale certificaatarchief. Alleen root en CertificateAuthority zijn geldige locaties.	'CertificateAuthority' 'Hoofdmap' (vereist)

HostnameConfiguration

Naam	Beschrijving	Waarde
certificatePassword	Certificaatwachtwoord.	snaar
defaultSslBinding	Geef true op voor het instellen van het certificaat dat is gekoppeld aan deze hostnaam als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, wordt dit het certificaat dat wordt aangeroepen. De eigenschap is handig als voor een service meerdere aangepaste hostnaam is ingeschakeld en moet worden bepaald welk standaard-SSL-certificaat moet worden gebruikt. De instelling wordt alleen toegepast op het type proxyhostnaam.	Bool
encodedCertificate	Base64 Gecodeerd certificaat.	snaar
hostName	Hostnaam die moet worden geconfigureerd voor de Api Management-service.	tekenreeks (vereist)
keyVaultId	Url naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt automatisch bijwerken van ssl-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met MSI. Het geheim moet van het type application/x-pkcs12	snaar
negotiateClientCertificate	Geef waar op om altijd te onderhandelen over clientcertificaat op de hostnaam. De standaardwaarde is onwaar.	Bool
type	Type hostnaam.	'Beheer' 'Portal' 'Proxy' 'Scm' (vereist)

Microsoft.ApiManagement/service

Naam	Beschrijving	Waarde
identiteit	Beheerde service-identiteit van de Api Management-service.	ApiManagementServiceIdentity-
plaats	Resourcelocatie.	tekenreeks (vereist)
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 50 Patroon = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (vereist)
Eigenschappen	Eigenschappen van de API Management-service.	ApiManagementServiceProperties (vereist)
Sku	SKU-eigenschappen van de API Management-service.	ApiManagementServiceSkuProperties (vereist)
Tags	Resourcetags	Woordenlijst met tagnamen en -waarden.
type	Het resourcetype	"Microsoft.ApiManagement/service@2017-03-01"

VirtualNetworkConfiguration

Naam	Beschrijving	Waarde
subnetResourceId	De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd.	snaar Beperkingen: Patroon = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$