Microsoft.ApiManagement service/apis 2018-01-01

The service/apis resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/apis resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2018-01-01' = {
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [ 'string' ]
        openidProviderId: 'string'
      }
      subscriptionKeyRequired: bool
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [ 'string' ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Property values

service/apis

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/apis'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2018-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
properties ApiCreateOrUpdateProperties

ApiCreateOrUpdateProperties

Name Description Value
apiRevision string
apiRevisionDescription string
apiType 'http'
'soap'
apiVersion string
apiVersionDescription string
apiVersionSet ApiVersionSetContractDetails
apiVersionSetId string
authenticationSettings AuthenticationSettingsContract
contentFormat 'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
contentValue string
description string
displayName string
path string (required)
protocols String array containing any of:
'http'
'https'
serviceUrl string
subscriptionKeyParameterNames SubscriptionKeyParameterNamesContract
type 'http'
'soap'
wsdlSelector ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name Description Value
description string
id string
versionHeaderName string
versioningScheme 'Header'
'Query'
'Segment'
versionQueryName string

AuthenticationSettingsContract

Name Description Value
oAuth2 OAuth2AuthenticationSettingsContract
openid OpenIdAuthenticationSettingsContract
subscriptionKeyRequired bool

OAuth2AuthenticationSettingsContract

Name Description Value
authorizationServerId string
scope string

OpenIdAuthenticationSettingsContract

Name Description Value
bearerTokenSendingMethods String array containing any of:
'authorizationHeader'
'query'
openidProviderId string

SubscriptionKeyParameterNamesContract

Name Description Value
header string
query string

ApiCreateOrUpdatePropertiesWsdlSelector

Name Description Value
wsdlEndpointName string
wsdlServiceName string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create an API Management instance and all sub resources using template

Deploy to Azure
This template demonstrates how to create a API Management service and configure sub-entities
Create Azure Front Door in front of Azure API Management

Deploy to Azure
This sample demonstrates how to use Azure Front Door as a global load balancer in front of Azure API Management.