Microsoft.Web customApis 2016-06-01

  • Artikel

Bicep-resursdefinition

Resurstypen customApis kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Web/customApis-resurs lägger du till följande Bicep i mallen.

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'
    }
  }
}

Egenskapsvärden

customApis

Name Beskrivning Värde
name Resursnamnet sträng (krävs)
location Resursplats sträng
tags Resurstaggar Ordlista med taggnamn och värden. Se Taggar i mallar
Etag Resurs-ETag sträng
properties Anpassade API-egenskaper CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Name Beskrivning Värde
apiDefinitions API-definitioner ApiResourceDefinitions
apiType API-typen "NotSpecified"
"Vila"
"Soap"
backendService API-serverdelstjänsten ApiResourceBackendService
brandColor Varumärkesfärg sträng
funktioner De anpassade API-funktionerna string[]
connectionParameters Anslutningsparametrar objekt
beskrivning Beskrivning av anpassat API sträng
displayName Visningsnamnet sträng
iconUri Ikonens URI sträng
runtimeUrls Url:er för körning string[]
swagger JSON-representationen av swagger För Bicep kan du använda funktionen any().
wsdlDefinition WSDL-definitionen WsdlDefinition

ApiResourceDefinitions

Name Beskrivning Värde
modifiedSwaggerUrl Den ändrade swagger-URL:en sträng
originalSwaggerUrl Den ursprungliga swagger-URL:en sträng

ApiResourceBackendService

Name Beskrivning Värde
serviceUrl Tjänstens URL sträng

WsdlDefinition

Name Beskrivning Värde
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng

WsdlService

Name Beskrivning Värde
endpointQualifiedNames Lista över slutpunkternas kvalificerade namn string[]
qualifiedName Tjänstens kvalificerade namn sträng (krävs)

Resursdefinition för ARM-mall

Resurstypen customApis kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Web/customApis-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "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": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string",
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  }
}

Egenskapsvärden

customApis

Name Beskrivning Värde
typ Resurstypen "Microsoft.Web/customApis"
apiVersion Resurs-API-versionen '2016-06-01'
name Resursnamnet sträng (krävs)
location Resursplats sträng
tags Resurstaggar Ordlista med taggnamn och värden. Se Taggar i mallar
Etag Resurs-ETag sträng
properties Anpassade API-egenskaper CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Name Beskrivning Värde
apiDefinitions API-definitioner ApiResourceDefinitions
apiType API-typen "NotSpecified"
"Vila"
"Soap"
backendService API-serverdelstjänsten ApiResourceBackendService
brandColor Varumärkesfärg sträng
funktioner De anpassade API-funktionerna string[]
connectionParameters Anslutningsparametrar objekt
beskrivning Beskrivning av anpassat API sträng
displayName Visningsnamnet sträng
iconUri Ikonens URI sträng
runtimeUrls Url:er för körning string[]
swagger JSON-representationen av swagger
wsdlDefinition WSDL-definitionen WsdlDefinition

ApiResourceDefinitions

Name Beskrivning Värde
modifiedSwaggerUrl Den ändrade swagger-URL:en sträng
originalSwaggerUrl Den ursprungliga swagger-URL:en sträng

ApiResourceBackendService

Name Beskrivning Värde
serviceUrl Tjänstens URL sträng

WsdlDefinition

Name Beskrivning Värde
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng

WsdlService

Name Beskrivning Värde
endpointQualifiedNames Lista över slutpunkternas kvalificerade namn string[]
qualifiedName Tjänstens kvalificerade namn sträng (krävs)

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen customApis kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Web/customApis-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

customApis

Name Beskrivning Värde
typ Resurstypen "Microsoft.Web/customApis@2016-06-01"
name Resursnamnet sträng (krävs)
location Resursplats sträng
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar Ordlista med taggnamn och värden.
Etag Resurs-ETag sträng
properties Anpassade API-egenskaper CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Name Beskrivning Värde
apiDefinitions API-definitioner ApiResourceDefinitions
apiType API-typen "NotSpecified"
"Vila"
"Soap"
backendService API-serverdelstjänsten ApiResourceBackendService
brandColor Varumärkesfärg sträng
funktioner De anpassade API-funktionerna string[]
connectionParameters Anslutningsparametrar objekt
beskrivning Beskrivning av anpassat API sträng
displayName Visningsnamnet sträng
iconUri Ikonens URI sträng
runtimeUrls Url:er för körning string[]
swagger JSON-representationen av swagger
wsdlDefinition WSDL-definitionen WsdlDefinition

ApiResourceDefinitions

Name Beskrivning Värde
modifiedSwaggerUrl Den ändrade swagger-URL:en sträng
originalSwaggerUrl Den ursprungliga swagger-URL:en sträng

ApiResourceBackendService

Name Beskrivning Värde
serviceUrl Tjänstens URL sträng

WsdlDefinition

Name Beskrivning Värde
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng
innehåll WSDL-innehållet sträng
importMethod WSDL-importmetoden "NotSpecified"
"SoapPassThrough"
"SoapToRest"
tjänst Tjänsten med namn och slutpunktsnamn WsdlService
url WSDL-URL:en sträng

WsdlService

Name Beskrivning Värde
endpointQualifiedNames Lista över slutpunkternas kvalificerade namn string[]
qualifiedName Tjänstens kvalificerade namn sträng (krävs)