Microsoft.ApiManagement service/apis template reference

Template format

To create a Microsoft.ApiManagement/service/apis resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2019-01-01",
  "properties": {
    "description": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "openidProviderId": "string",
        "bearerTokenSendingMethods": [
          "string"
        ]
      },
      "subscriptionKeyRequired": "boolean"
    },
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "apiRevision": "string",
    "apiVersion": "string",
    "isCurrent": "boolean",
    "apiRevisionDescription": "string",
    "apiVersionDescription": "string",
    "apiVersionSetId": "string",
    "subscriptionRequired": "boolean",
    "sourceApiId": "string",
    "displayName": "string",
    "serviceUrl": "string",
    "path": "string",
    "protocols": [
      "string"
    ],
    "apiVersionSet": {
      "id": "string",
      "name": "string",
      "description": "string",
      "versioningScheme": "string",
      "versionQueryName": "string",
      "versionHeaderName": "string"
    },
    "value": "string",
    "format": "string",
    "wsdlSelector": {
      "wsdlServiceName": "string",
      "wsdlEndpointName": "string"
    },
    "apiType": "string"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ApiManagement/service/apis object

Name Type Required Value
name string Yes API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
type enum Yes Microsoft.ApiManagement/service/apis
apiVersion enum Yes 2019-01-01
properties object Yes Api entity create of update properties. - ApiCreateOrUpdateProperties object
resources array No tagDescriptions issues diagnostics schemas policies tags operations releases

ApiCreateOrUpdateProperties object

Name Type Required Value
description string No Description of the API. May include HTML formatting tags.
authenticationSettings object No Collection of authentication settings included into this API. - AuthenticationSettingsContract object
subscriptionKeyParameterNames object No Protocols over which API is made available. - SubscriptionKeyParameterNamesContract object
type enum No Type of API. - http or soap
apiRevision string No Describes the Revision of the Api. If no value is provided, default revision 1 is created
apiVersion string No Indicates the Version identifier of the API if the API is versioned
isCurrent boolean No Indicates if API revision is current api revision.
apiRevisionDescription string No Description of the Api Revision.
apiVersionDescription string No Description of the Api Version.
apiVersionSetId string No A resource identifier for the related ApiVersionSet.
subscriptionRequired boolean No Specifies whether an API or Product subscription is required for accessing the API.
sourceApiId string No API identifier of the source API.
displayName string No API name. Must be 1 to 300 characters long.
serviceUrl string No Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path string Yes 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.
protocols array No Describes on which protocols the operations in this API can be invoked. - http or https
apiVersionSet object No Version set details - ApiVersionSetContractDetails object
value string No Content value when Importing an API.
format enum No Format of the Content in which the API is getting imported. - wadl-xml, wadl-link-json, swagger-json, swagger-link-json, wsdl, wsdl-link, openapi, openapi+json, openapi-link
wsdlSelector object No Criteria to limit import of WSDL to a subset of the document. - ApiCreateOrUpdatePropertiesWsdlSelector object
apiType enum No Type of Api to create. * http creates a SOAP to REST API * soap creates a SOAP pass-through API. - http or soap

AuthenticationSettingsContract object

Name Type Required Value
oAuth2 object No OAuth2 Authentication settings - OAuth2AuthenticationSettingsContract object
openid object No OpenID Connect Authentication Settings - OpenIdAuthenticationSettingsContract object
subscriptionKeyRequired boolean No Specifies whether subscription key is required during call to this API, true - API is included into closed products only, false - API is included into open products alone, null - there is a mix of products.

SubscriptionKeyParameterNamesContract object

Name Type Required Value
header string No Subscription key header name.
query string No Subscription key query string parameter name.

ApiVersionSetContractDetails object

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

ApiCreateOrUpdatePropertiesWsdlSelector object

Name Type Required Value
wsdlServiceName string No Name of service to import from WSDL
wsdlEndpointName string No Name of endpoint(port) to import from WSDL

OAuth2AuthenticationSettingsContract object

Name Type Required Value
authorizationServerId string No OAuth authorization server identifier.
scope string No operations scope.

OpenIdAuthenticationSettingsContract object

Name Type Required Value
openidProviderId string No OAuth authorization server identifier.
bearerTokenSendingMethods array No How to send token to the server. - authorizationHeader or query

Quickstart templates

The following quickstart templates deploy this resource type.