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": "2017-03-01",
  "properties": {
    "description": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      }
    },
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "apiRevision": "string",
    "apiVersion": "string",
    "apiVersionSetId": "string",
    "displayName": "string",
    "serviceUrl": "string",
    "path": "string",
    "protocols": [
      "string"
    ],
    "apiVersionSet": {
      "properties": {
        "description": "string",
        "versionQueryName": "string",
        "versionHeaderName": "string",
        "displayName": "string",
        "versioningScheme": "string"
      }
    },
    "contentValue": "string",
    "contentFormat": "string",
    "wsdlSelector": {
      "wsdlServiceName": "string",
      "wsdlEndpointName": "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 identifier. Must be unique in the current API Management service instance.
type enum Yes apis
-or-
Microsoft.ApiManagement/service/apis

See Set name and type for child resources.
apiVersion enum Yes 2017-03-01
properties object Yes Api entity create of update properties. - ApiCreateOrUpdateProperties object
resources array No issues diagnostics schemas policies 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
apiVersionSetId string No A resource identifier for the related ApiVersionSet.
displayName string No API name.
serviceUrl string No Absolute URL of the backend service implementing this API.
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 ApiVersionSetContract object
contentValue string No Content value when Importing an API.
contentFormat 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
wsdlSelector object No Criteria to limit import of WSDL to a subset of the document. - ApiCreateOrUpdatePropertiesWsdlSelector object

AuthenticationSettingsContract object

Name Type Required Value
oAuth2 object No OAuth2 Authentication settings - OAuth2AuthenticationSettingsContract object

SubscriptionKeyParameterNamesContract object

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

ApiVersionSetContract object

Name Type Required Value
properties object No ApiVersionSetContractProperties object

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.

ApiVersionSetContractProperties object

Name Type Required Value
description string No Description of API Version Set.
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.
displayName string Yes Name of API Version Set
versioningScheme enum Yes An value that determines where the API Version identifer will be located in a HTTP request. - Segment, Query, Header

Quickstart templates

The following quickstart templates deploy this resource type.