Niestandardowe interfejsy API Microsoft.Web

Definicja zasobu Bicep

Typ zasobu customApis można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Web/customApis, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiDefinitions: {
      modifiedSwaggerUrl: 'string'
      originalSwaggerUrl: 'string'
    }
    apiType: 'string'
    backendService: {
      serviceUrl: 'string'
    }
    brandColor: 'string'
    capabilities: [
      'string'
    ]
    connectionParameters: {
      {customized property}: {
        oAuthSettings: {
          clientId: 'string'
          clientSecret: 'string'
          customParameters: {
            {customized property}: {
              options: any(...)
              uiDefinition: any(...)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(...)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(...)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Microsoft.Web/customApis

Nazwa Opis Wartość
Znacznik ETAG Zasób ETag ciąg
lokalizacja Lokalizacja zasobu ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości niestandardowego interfejsu API CustomApiPropertiesDefinition
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

ApiOAuthSettings

Nazwa Opis Wartość
clientId (identyfikator klienta) Identyfikator klienta dostawcy zasobów ciąg
tajemnica klienta Klucz tajny klienta wymagany do uwierzytelniania OAuth ciąg
customParameters (parametry standardowe) Klucz parametrów OAuth to nazwa parametru ApiOAuthSettingsCustomParameters
identityProvider (dostawca tożsamości) Dostawca tożsamości ciąg
Właściwości Właściwości tylko do odczytu dla tego ustawienia oauth. jakikolwiek
Adres URL przekierowania Adres URL ciąg
Zakresów Zakresy OAuth ciąg znakowy[]

ApiOAuthSettingsCustomParameters

Nazwa Opis Wartość

Parametr ApiOAuthSettingsParameter

Nazwa Opis Wartość
Opcje Opcje dostępne dla tego parametru jakikolwiek
uiDefinition Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę jakikolwiek
wartość Wartość ustawienia ciąg

ApiResourceBackendService

Nazwa Opis Wartość
serviceUrl (adres url usługi) Adres URL usługi ciąg

Definicje ApiResourceDefinitions

Nazwa Opis Wartość
modifiedSwaggerUrl Zmodyfikowany adres URL programu Swagger ciąg
originalSwaggerUrl Oryginalny adres URL programu Swagger ciąg

Parametr połączenia

Nazwa Opis Wartość
oAuthSettings (Ustawienia uwierzytelniania) Ustawienia protokołu OAuth dla dostawcy połączenia ApiOAuthSettings
typ Typ parametru "tablica"
"bool"
"połączenie"
"int"
"oauthSetting"
"object"
"secureobject"
"securestring"
"ciąg"

CustomApiPropertiesDefinition

Nazwa Opis Wartość
apiDefinitions (Definicje api) Definicje interfejsu API apiResourceDefinitions
apiType (typ interfejsu) Typ interfejsu API "NotSpecified"
"Rest"
"Soap"
backendService (usługa backendService) Usługa zaplecza interfejsu API apiResourceBackendService
markaKolor Kolor marki ciąg
Możliwości Możliwości niestandardowego interfejsu API ciąg znakowy[]
connectionParameters (parametry połączenia) Parametry połączenia CustomApiPropertiesDefinitionConnectionParameters
opis Niestandardowy opis interfejsu API ciąg
nazwa wyświetlana Nazwa wyświetlana ciąg
iconUri (identyfikator iconUri) Identyfikator URI ikony ciąg
runtimeUrls (adresy url środowiska uruchomieniowego) Adresy URL środowiska uruchomieniowego ciąg znakowy[]
Puszyć Reprezentacja JSON struktury Swagger jakikolwiek
wsdlDefinition (definicja wsdl) Definicja WSDL WsdlDefinition (Definicja wsdl)

CustomApiPropertiesDefinitionConnectionParameters

Nazwa Opis Wartość

Słownik tagów

Nazwa Opis Wartość

WsdlDefinition (Definicja wsdl)

Nazwa Opis Wartość
zawartość Zawartość WSDL ciąg
importMethod (metoda importu) Metoda importu WSDL "NotSpecified"
"SoapPassThrough"
"SoapToRest"
usługa Usługa o nazwach i nazwach punktów końcowych Serwis WSDL
adres URL Adres URL języka WSDL ciąg

Serwis WSDL

Nazwa Opis Wartość
endpointQualifiedNames (nazwy kwalifikowane) Lista kwalifikowanych nazw punktów końcowych ciąg znakowy[]
kwalifikowanaNazwa_ Kwalifikowana nazwa usługi ciąg (wymagany)

Definicja zasobu szablonu usługi ARM

Typ zasobu customApis można wdrożyć przy użyciu operacji docelowych:

Przykłady użycia

Format zasobu

Aby utworzyć zasób Microsoft.Web/customApis, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "apiDefinitions": {
      "modifiedSwaggerUrl": "string",
      "originalSwaggerUrl": "string"
    },
    "apiType": "string",
    "backendService": {
      "serviceUrl": "string"
    },
    "brandColor": "string",
    "capabilities": [ "string" ],
    "connectionParameters": {
      "{customized property}": {
        "oAuthSettings": {
          "clientId": "string",
          "clientSecret": "string",
          "customParameters": {
            "{customized property}": {
              "options": {},
              "uiDefinition": {},
              "value": "string"
            }
          },
          "identityProvider": "string",
          "properties": {},
          "redirectUrl": "string",
          "scopes": [ "string" ]
        },
        "type": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "runtimeUrls": [ "string" ],
    "swagger": {},
    "wsdlDefinition": {
      "content": "string",
      "importMethod": "string",
      "service": {
        "endpointQualifiedNames": [ "string" ],
        "qualifiedName": "string"
      },
      "url": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Microsoft.Web/customApis

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2016-06-01'
Znacznik ETAG Zasób ETag ciąg
lokalizacja Lokalizacja zasobu ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości niestandardowego interfejsu API CustomApiPropertiesDefinition
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Web/customApis"

ApiOAuthSettings

Nazwa Opis Wartość
clientId (identyfikator klienta) Identyfikator klienta dostawcy zasobów ciąg
tajemnica klienta Klucz tajny klienta wymagany do uwierzytelniania OAuth ciąg
customParameters (parametry standardowe) Klucz parametrów OAuth to nazwa parametru ApiOAuthSettingsCustomParameters
identityProvider (dostawca tożsamości) Dostawca tożsamości ciąg
Właściwości Właściwości tylko do odczytu dla tego ustawienia oauth. jakikolwiek
Adres URL przekierowania Adres URL ciąg
Zakresów Zakresy OAuth ciąg znakowy[]

ApiOAuthSettingsCustomParameters

Nazwa Opis Wartość

Parametr ApiOAuthSettingsParameter

Nazwa Opis Wartość
Opcje Opcje dostępne dla tego parametru jakikolwiek
uiDefinition Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę jakikolwiek
wartość Wartość ustawienia ciąg

ApiResourceBackendService

Nazwa Opis Wartość
serviceUrl (adres url usługi) Adres URL usługi ciąg

Definicje ApiResourceDefinitions

Nazwa Opis Wartość
modifiedSwaggerUrl Zmodyfikowany adres URL programu Swagger ciąg
originalSwaggerUrl Oryginalny adres URL programu Swagger ciąg

Parametr połączenia

Nazwa Opis Wartość
oAuthSettings (Ustawienia uwierzytelniania) Ustawienia protokołu OAuth dla dostawcy połączenia ApiOAuthSettings
typ Typ parametru "tablica"
"bool"
"połączenie"
"int"
"oauthSetting"
"object"
"secureobject"
"securestring"
"ciąg"

CustomApiPropertiesDefinition

Nazwa Opis Wartość
apiDefinitions (Definicje api) Definicje interfejsu API apiResourceDefinitions
apiType (typ interfejsu) Typ interfejsu API "NotSpecified"
"Rest"
"Soap"
backendService (usługa backendService) Usługa zaplecza interfejsu API apiResourceBackendService
markaKolor Kolor marki ciąg
Możliwości Możliwości niestandardowego interfejsu API ciąg znakowy[]
connectionParameters (parametry połączenia) Parametry połączenia CustomApiPropertiesDefinitionConnectionParameters
opis Niestandardowy opis interfejsu API ciąg
nazwa wyświetlana Nazwa wyświetlana ciąg
iconUri (identyfikator iconUri) Identyfikator URI ikony ciąg
runtimeUrls (adresy url środowiska uruchomieniowego) Adresy URL środowiska uruchomieniowego ciąg znakowy[]
Puszyć Reprezentacja JSON struktury Swagger jakikolwiek
wsdlDefinition (definicja wsdl) Definicja WSDL WsdlDefinition (Definicja wsdl)

CustomApiPropertiesDefinitionConnectionParameters

Nazwa Opis Wartość

Słownik tagów

Nazwa Opis Wartość

WsdlDefinition (Definicja wsdl)

Nazwa Opis Wartość
zawartość Zawartość WSDL ciąg
importMethod (metoda importu) Metoda importu WSDL "NotSpecified"
"SoapPassThrough"
"SoapToRest"
usługa Usługa o nazwach i nazwach punktów końcowych Serwis WSDL
adres URL Adres URL języka WSDL ciąg

Serwis WSDL

Nazwa Opis Wartość
endpointQualifiedNames (nazwy kwalifikowane) Lista kwalifikowanych nazw punktów końcowych ciąg znakowy[]
kwalifikowanaNazwa_ Kwalifikowana nazwa usługi ciąg (wymagany)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu customApis można wdrożyć przy użyciu operacji docelowych:

  • Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Web/customApis, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/customApis@2016-06-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      apiDefinitions = {
        modifiedSwaggerUrl = "string"
        originalSwaggerUrl = "string"
      }
      apiType = "string"
      backendService = {
        serviceUrl = "string"
      }
      brandColor = "string"
      capabilities = [
        "string"
      ]
      connectionParameters = {
        {customized property} = {
          oAuthSettings = {
            clientId = "string"
            clientSecret = "string"
            customParameters = {
              {customized property} = {
                options = ?
                uiDefinition = ?
                value = "string"
              }
            }
            identityProvider = "string"
            properties = ?
            redirectUrl = "string"
            scopes = [
              "string"
            ]
          }
          type = "string"
        }
      }
      description = "string"
      displayName = "string"
      iconUri = "string"
      runtimeUrls = [
        "string"
      ]
      swagger = ?
      wsdlDefinition = {
        content = "string"
        importMethod = "string"
        service = {
          endpointQualifiedNames = [
            "string"
          ]
          qualifiedName = "string"
        }
        url = "string"
      }
    }
  }
}

Wartości właściwości

Microsoft.Web/customApis

Nazwa Opis Wartość
Znacznik ETAG Zasób ETag ciąg
lokalizacja Lokalizacja zasobu ciąg
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości niestandardowego interfejsu API CustomApiPropertiesDefinition
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Web/customApis@2016-06-01"

ApiOAuthSettings

Nazwa Opis Wartość
clientId (identyfikator klienta) Identyfikator klienta dostawcy zasobów ciąg
tajemnica klienta Klucz tajny klienta wymagany do uwierzytelniania OAuth ciąg
customParameters (parametry standardowe) Klucz parametrów OAuth to nazwa parametru ApiOAuthSettingsCustomParameters
identityProvider (dostawca tożsamości) Dostawca tożsamości ciąg
Właściwości Właściwości tylko do odczytu dla tego ustawienia oauth. jakikolwiek
Adres URL przekierowania Adres URL ciąg
Zakresów Zakresy OAuth ciąg znakowy[]

ApiOAuthSettingsCustomParameters

Nazwa Opis Wartość

Parametr ApiOAuthSettingsParameter

Nazwa Opis Wartość
Opcje Opcje dostępne dla tego parametru jakikolwiek
uiDefinition Definicje interfejsu użytkownika na kulturę, ponieważ obiekt wywołujący może określić kulturę jakikolwiek
wartość Wartość ustawienia ciąg

ApiResourceBackendService

Nazwa Opis Wartość
serviceUrl (adres url usługi) Adres URL usługi ciąg

Definicje ApiResourceDefinitions

Nazwa Opis Wartość
modifiedSwaggerUrl Zmodyfikowany adres URL programu Swagger ciąg
originalSwaggerUrl Oryginalny adres URL programu Swagger ciąg

Parametr połączenia

Nazwa Opis Wartość
oAuthSettings (Ustawienia uwierzytelniania) Ustawienia protokołu OAuth dla dostawcy połączenia ApiOAuthSettings
typ Typ parametru "tablica"
"bool"
"połączenie"
"int"
"oauthSetting"
"object"
"secureobject"
"securestring"
"ciąg"

CustomApiPropertiesDefinition

Nazwa Opis Wartość
apiDefinitions (Definicje api) Definicje interfejsu API apiResourceDefinitions
apiType (typ interfejsu) Typ interfejsu API "NotSpecified"
"Rest"
"Soap"
backendService (usługa backendService) Usługa zaplecza interfejsu API apiResourceBackendService
markaKolor Kolor marki ciąg
Możliwości Możliwości niestandardowego interfejsu API ciąg znakowy[]
connectionParameters (parametry połączenia) Parametry połączenia CustomApiPropertiesDefinitionConnectionParameters
opis Niestandardowy opis interfejsu API ciąg
nazwa wyświetlana Nazwa wyświetlana ciąg
iconUri (identyfikator iconUri) Identyfikator URI ikony ciąg
runtimeUrls (adresy url środowiska uruchomieniowego) Adresy URL środowiska uruchomieniowego ciąg znakowy[]
Puszyć Reprezentacja JSON struktury Swagger jakikolwiek
wsdlDefinition (definicja wsdl) Definicja WSDL WsdlDefinition (Definicja wsdl)

CustomApiPropertiesDefinitionConnectionParameters

Nazwa Opis Wartość

Słownik tagów

Nazwa Opis Wartość

WsdlDefinition (Definicja wsdl)

Nazwa Opis Wartość
zawartość Zawartość WSDL ciąg
importMethod (metoda importu) Metoda importu WSDL "NotSpecified"
"SoapPassThrough"
"SoapToRest"
usługa Usługa o nazwach i nazwach punktów końcowych Serwis WSDL
adres URL Adres URL języka WSDL ciąg

Serwis WSDL

Nazwa Opis Wartość
endpointQualifiedNames (nazwy kwalifikowane) Lista kwalifikowanych nazw punktów końcowych ciąg znakowy[]
kwalifikowanaNazwa_ Kwalifikowana nazwa usługi ciąg (wymagany)