Microsoft.ApiManagement service/apis 2019-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@2019-01-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [ 'string' ]
        openidProviderId: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    path: 'string'
    protocols: [ 'string' ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    value: '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.
'2019-01-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (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.
parentSymbolicName
properties Api Create or Update Properties. ApiCreateOrUpdateProperties

ApiCreateOrUpdateProperties

Name Description Value
apiRevision Describes the Revision of the Api. If no value is provided, default revision 1 is created string
apiRevisionDescription Description of the Api Revision. string
apiType Type of Api to create.
* http creates a SOAP to REST API
* soap creates a SOAP pass-through API .
'http'
'soap'
apiVersion Indicates the Version identifier of the API if the API is versioned string
apiVersionDescription Description of the Api Version. string
apiVersionSet An API Version Set contains the common configuration for a set of API Versions relating ApiVersionSetContractDetails
apiVersionSetId A resource identifier for the related ApiVersionSet. string
authenticationSettings API Authentication Settings. AuthenticationSettingsContract
description Description of the API. May include HTML formatting tags. string
displayName API name. Must be 1 to 300 characters long. string
format Format of the Content in which the API is getting imported. 'openapi'
'openapi+json'
'openapi+json-link'
'openapi-link'
'swagger-json'
'swagger-link-json'
'wadl-link-json'
'wadl-xml'
'wsdl'
'wsdl-link'
isCurrent Indicates if API revision is current api revision. bool
path Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. string (required)
protocols Describes on which protocols the operations in this API can be invoked. String array containing any of:
'http'
'https'
serviceUrl Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. string
sourceApiId API identifier of the source API. string
subscriptionKeyParameterNames Subscription key parameter names details. SubscriptionKeyParameterNamesContract
subscriptionRequired Specifies whether an API or Product subscription is required for accessing the API. bool
type Type of API. 'http'
'soap'
value Content value when Importing an API. string
wsdlSelector Criteria to limit import of WSDL to a subset of the document. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name Description Value
description Description of API Version Set. string
id Identifier for existing API Version Set. Omit this value to create a new Version Set. string
name The display Name of the API Version Set. string
versionHeaderName Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header. string
versioningScheme An value that determines where the API Version identifier will be located in a HTTP request. 'Header'
'Query'
'Segment'
versionQueryName Name of query parameter that indicates the API Version if versioningScheme is set to query. string

AuthenticationSettingsContract

Name Description Value
oAuth2 API OAuth2 Authentication settings details. OAuth2AuthenticationSettingsContract
openid API OAuth2 Authentication settings details. OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

Name Description Value
authorizationServerId OAuth authorization server identifier. string
scope operations scope. string

OpenIdAuthenticationSettingsContract

Name Description Value
bearerTokenSendingMethods How to send token to the server. String array containing any of:
'authorizationHeader'
'query'
openidProviderId OAuth authorization server identifier. string

SubscriptionKeyParameterNamesContract

Name Description Value
header Subscription key header name. string
query Subscription key query string parameter name. string

ApiCreateOrUpdatePropertiesWsdlSelector

Name Description Value
wsdlEndpointName Name of endpoint(port) to import from WSDL string
wsdlServiceName Name of service to import from WSDL 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.