Microsoft.Web customApis 2016-06-01

Definizione di risorsa Bicep

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

customApis

Nome Descrizione valore
name Nome della risorsa stringa (obbligatorio)
posizione Posizione risorsa string
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere Tag nei modelli
etag Resource ETag string
properties Proprietà dell'API personalizzata CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Nome Descrizione valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API 'NotSpecified'
'Rest'
'Soap'
backendService Servizio back-end dell'API ApiResourceBackendService
brandColor Colore del marchio string
capabilities Funzionalità api personalizzate string[]
connectionParameters Parametri di connessione object
description Descrizione dell'API personalizzata string
displayName Nome visualizzato string
iconUri URI dell'icona string
runtimeUrls URL di runtime string[]
swagger Rappresentazione JSON dello swagger Per Bicep, è possibile usare la funzione any().
wsdlDefinition Definizione WSDL WsdlDefinition

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato string
originalSwaggerUrl URL swagger originale string

ApiResourceBackendService

Nome Descrizione Valore
serviceUrl URL del servizio string

WsdlDefinition

Nome Descrizione Valore
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string

WsdlService

Nome Descrizione valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint string[]
qualifiedName Nome completo del servizio stringa (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il codice JSON seguente al modello.

{
  "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"
    }
  }
}

Valori delle proprietà

customApis

Nome Descrizione valore
tipo Tipo di risorsa 'Microsoft.Web/customApis'
apiVersion Versione dell'API della risorsa '2016-06-01'
name Nome della risorsa stringa (obbligatorio)
posizione Posizione risorsa string
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere Tag nei modelli
etag Resource ETag string
properties Proprietà dell'API personalizzata CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Nome Descrizione valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API 'NotSpecified'
'Rest'
'Soap'
backendService Servizio back-end dell'API ApiResourceBackendService
brandColor Colore del marchio string
capabilities Funzionalità api personalizzate string[]
connectionParameters Parametri di connessione object
description Descrizione dell'API personalizzata string
displayName Nome visualizzato string
iconUri URI dell'icona string
runtimeUrls URL di runtime string[]
swagger Rappresentazione JSON dello swagger
wsdlDefinition Definizione WSDL WsdlDefinition

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato string
originalSwaggerUrl URL swagger originale string

ApiResourceBackendService

Nome Descrizione valore
serviceUrl URL del servizio string

WsdlDefinition

Nome Descrizione valore
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL 'NotSpecified'
'SoapPassThrough'
'SoapToRest'
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string

WsdlService

Nome Descrizione Valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint string[]
qualifiedName Nome completo del servizio stringa (obbligatorio)

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il codice Terraform seguente al modello.

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"
  })
}

Valori delle proprietà

customApis

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.Web/customApis@2016-06-01"
name Nome della risorsa stringa (obbligatorio)
posizione Posizione risorsa string
parent_id Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatorio)
tags Tag delle risorse Dizionario di nomi e valori di tag.
etag Resource ETag string
properties Proprietà dell'API personalizzata CustomApiPropertiesDefinition

CustomApiPropertiesDefinition

Nome Descrizione Valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API "NotSpecified"
"Rest"
"Soap"
backendService Servizio back-end dell'API ApiResourceBackendService
brandColor Colore del marchio string
capabilities Funzionalità api personalizzate string[]
connectionParameters Parametri di connessione object
description Descrizione dell'API personalizzata string
displayName Nome visualizzato string
iconUri URI dell'icona string
runtimeUrls URL di runtime string[]
swagger Rappresentazione JSON dello swagger
wsdlDefinition Definizione WSDL WsdlDefinition

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato string
originalSwaggerUrl URL swagger originale string

ApiResourceBackendService

Nome Descrizione Valore
serviceUrl URL del servizio string

WsdlDefinition

Nome Descrizione Valore
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL "NotSpecified"
"SoapPassThrough"
"SoapToRest"
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string
contenuto Contenuto WSDL string
importMethod Metodo di importazione WSDL "NotSpecified"
"SoapPassThrough"
"SoapToRest"
service Servizio con nomi di nome ed endpoint WsdlService
url The WSDL URL string

WsdlService

Nome Descrizione valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint string[]
qualifiedName Nome completo del servizio stringa (obbligatorio)