Microsoft.Web customApis 2016-06-01

  • مقالة
  • قراءة خلال 2 دقائق

The customApis 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.Web/customApis resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  etag: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {}
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any()
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
}

Property values

customApis

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Web/customApis'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2016-06-01'
name The resource name string (required)
location Resource location string
tags Resource tags Dictionary of tag names and values. See Tags in templates
etag Resource ETag string
properties Custom API properties CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Name Description Value
apiDefinitions API Definitions ApiResourceDefinitions
apiType The API type 'NotSpecified'
'Rest'
'Soap'
backendService The API backend service ApiResourceBackendService
brandColor Brand color string
capabilities The custom API capabilities string[]
connectionParameters Connection parameters object
description The custom API description string
displayName The display name string
iconUri The icon URI string
runtimeUrls Runtime URLs string[]
swagger Any object For Bicep, you can use the any() function.
wsdlDefinition The WSDL definition WsdlDefinition

ApiResourceDefinitions

Name Description Value
modifiedSwaggerUrl The modified swagger URL string
originalSwaggerUrl The original swagger URL string

ApiResourceBackendService

Name Description Value
serviceUrl The service URL string

WsdlDefinition

Name Description Value
content The WSDL content string
importMethod The WSDL import method 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service The service with name and endpoint names WsdlService
url The WSDL URL string
content The WSDL content string
importMethod The WSDL import method 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service The service with name and endpoint names WsdlService
url The WSDL URL string

WsdlService

Name Description Value
endpointQualifiedNames List of the endpoints' qualified names string[]
qualifiedName The service's qualified name string (required)