Microsoft.ApiManagement service/apis 2016-10-10

Bicep resource definition

The service/apis resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Property values

AuthenticationSettingsContract

Name Description Value
oAuth2 API OAuth2 Authentication settings details. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Name Description Value
authenticationSettings Collection of authentication settings included into this API. AuthenticationSettingsContract
description Description of the API. May include HTML formatting tags. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (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.
Symbolic name for resource of type: service
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

Constraints:
Max length = (required)
protocols Describes on which protocols the operations in this API can be invoked. String array containing any of:
'Http'
'Https' (required)
serviceUrl Absolute URL of the backend service implementing this API. string

Constraints:
Min length = 1
Max length = 1 (required)
subscriptionKeyParameterNames Protocols over which API is made available. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

ARM template resource definition

The service/apis resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-10-10",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Property values

AuthenticationSettingsContract

Name Description Value
oAuth2 API OAuth2 Authentication settings details. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Name Description Value
apiVersion The api version '2016-10-10'
authenticationSettings Collection of authentication settings included into this API. AuthenticationSettingsContract
description Description of the API. May include HTML formatting tags. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (required)
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

Constraints:
Max length = (required)
protocols Describes on which protocols the operations in this API can be invoked. String array containing any of:
'Http'
'Https' (required)
serviceUrl Absolute URL of the backend service implementing this API. string

Constraints:
Min length = 1
Max length = 1 (required)
subscriptionKeyParameterNames Protocols over which API is made available. SubscriptionKeyParameterNamesContract
type The resource type 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

Terraform (AzAPI provider) resource definition

The service/apis resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-10-10"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Property values

AuthenticationSettingsContract

Name Description Value
oAuth2 API OAuth2 Authentication settings details. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Name Description Value
authenticationSettings Collection of authentication settings included into this API. AuthenticationSettingsContract
description Description of the API. May include HTML formatting tags. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
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

Constraints:
Max length = (required)
protocols Describes on which protocols the operations in this API can be invoked. String array containing any of:
'Http'
'Https' (required)
serviceUrl Absolute URL of the backend service implementing this API. string

Constraints:
Min length = 1
Max length = 1 (required)
subscriptionKeyParameterNames Protocols over which API is made available. SubscriptionKeyParameterNamesContract
type The resource type "Microsoft.ApiManagement/service/apis@2016-10-10"

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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