Microsoft.ApiManagement — usługa/interfejsy API

Artykuł
07/24/2024

Definicja zasobu Bicep

Typ zasobu usługi/interfejsu API można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          bearerTokenSendingMethods: [
            'string'
          ]
          openidProviderId: 'string'
        }
      ]
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Wartości właściwości

usługa/interfejsy API

Nazwa	Opis	Wartość
nazwa	Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep.	ciąg (wymagany) Limit znaków: 1–80 Prawidłowe znaki: Alfanumeryczne i łączniki. Zacznij od litery i kończy się znakiem alfanumerycznym.
rodzic	W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.	Nazwa symboliczna zasobu typu: usługi
Właściwości	Jednostka interfejsu API tworzy właściwości aktualizacji.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nazwa	Opis	Wartość
apiRevision	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100
apiRevisionDescription	Opis poprawki interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiType	Typ interfejsu API do utworzenia. * `http` tworzy interfejs API REST * `soap` tworzy interfejs API przekazywania protokołu SOAP * `websocket` tworzy interfejs API protokołu WebSocket * `graphql` tworzy interfejs API GraphQL. Nowe typy można dodawać w przyszłości.	"graphql" "grpc" '`http`' "odata" "mydło" "websocket"
apiVersion	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji	struna Ograniczenia: Maksymalna długość = 100
apiVersionDescription	Opis wersji interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiVersionSet	Szczegóły zestawu wersji	ApiVersionSetContractDetails
apiVersionSetId	Identyfikator zasobu powiązanego elementu ApiVersionSet.	struna
authenticationSettings	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.	AuthenticationSettingsContract
kontakt	Informacje kontaktowe dotyczące interfejsu API.	ApiContactInformation
opis	Opis interfejsu API. Może zawierać tagi formatowania HTML.	struna
displayName	Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 300
format	Format zawartości, w której jest importowany interfejs API. Nowe formaty można dodawać w przyszłości	"graphql-link" "grpc" "grpc-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.	Bool
licencja	Informacje o licencji dla interfejsu API.	ApiLicenseInformation
ścieżka	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.	ciąg (wymagany) Ograniczenia: Maksymalna długość = 400
Protokołów	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.	Tablica ciągów zawierająca dowolną z: '`http`' '`https`' "ws" "wss"
serviceUrl	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.	struna Ograniczenia: Maksymalna długość = 2000
sourceApiId	Identyfikator interfejsu API źródłowego interfejsu API.	struna
subscriptionKeyParameterNames	Protokoły, za pośrednictwem których udostępniono interfejs API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.	Bool
termsOfServiceUrl	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.	struna
translateRequiredQueryParameters	Strategia tłumaczenia wymaganych parametrów zapytania na szablony. Domyślnie ma wartość "template". Możliwe wartości: "template", "query"	"zapytanie" "template"
typ	Typ interfejsu API.	"graphql" "grpc" '`http`' "odata" "mydło" "websocket"
wartość	Wartość zawartości podczas importowania interfejsu API.	struna
wsdlSelector	Kryteria ograniczania importu WSDL do podzestawu dokumentu.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nazwa	Opis	Wartość
opis	Opis zestawu wersji interfejsu API.	struna
id	Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji.	struna
nazwa	Wyświetlana nazwa zestawu wersji interfejsu API.	struna
versionHeaderName	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na `header`.	struna
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.	"Nagłówek" "Zapytanie" "Segment"
versionQueryName	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość `query`.	struna

AuthenticationSettingsContract

Nazwa	Opis	Wartość
oAuth2	Ustawienia uwierzytelniania OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Kolekcja ustawień uwierzytelniania OAuth2 uwzględnionych w tym interfejsie API.	OAuth2AuthenticationSettingsContract[]
openid	Ustawienia uwierzytelniania OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Kolekcja ustawień uwierzytelniania programu Open ID Connect uwzględnionych w tym interfejsie API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nazwa	Opis	Wartość
authorizationServerId	Identyfikator serwera autoryzacji OAuth.	struna
zakres	zakres operacji.	struna

OpenIdAuthenticationSettingsContract

Nazwa	Opis	Wartość
bearerTokenSendingMethods	Jak wysłać token do serwera.	Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie"
openidProviderId	Identyfikator serwera autoryzacji OAuth.	struna

ApiContactInformation

Nazwa	Opis	Wartość
E-mail	Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail	struna
nazwa	Nazwa identyfikująca osoby kontaktowej/organizacji	struna
adres URL	Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL	struna

ApiLicenseInformation

Nazwa	Opis	Wartość
nazwa	Nazwa licencji używana dla interfejsu API	struna
adres URL	Adres URL licencji używanej dla interfejsu API. MUSI być w formacie adresu URL	struna

SubscriptionKeyParameterNamesContract

Nazwa	Opis	Wartość
nagłówek	Nazwa nagłówka klucza subskrypcji.	struna
zapytanie	Nazwa parametru ciągu zapytania klucza subskrypcji.	struna

ApiCreateOrUpdatePropertiesWsdlSelector

Nazwa	Opis	Wartość
wsdlEndpointName	Nazwa punktu końcowego (portu) do zaimportowania z WSDL	struna
wsdlServiceName	Nazwa usługi do zaimportowania z WSDL	struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych przy użyciu szablonu wdrażanie	Ten szablon przedstawia sposób tworzenia usługi API Management i konfigurowania jednostek podrzędnych
tworzenie usługi Azure Front Door przed usługą Azure API Management wdrażanie	W tym przykładzie pokazano, jak używać usługi Azure Front Door jako globalnego modułu równoważenia obciążenia przed usługą Azure API Management.

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/interfejsu API można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

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

Format zasobu

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "bearerTokenSendingMethods": [ "string" ],
          "openidProviderId": "string"
        }
      ]
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Wartości właściwości

usługa/interfejsy API

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.ApiManagement/service/apis"
apiVersion	Wersja interfejsu API zasobów	"2023-09-01-preview"
nazwa	Nazwa zasobu Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.	ciąg (wymagany) Limit znaków: 1–80 Prawidłowe znaki: Alfanumeryczne i łączniki. Zacznij od litery i kończy się znakiem alfanumerycznym.
Właściwości	Jednostka interfejsu API tworzy właściwości aktualizacji.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nazwa	Opis	Wartość
apiRevision	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100
apiRevisionDescription	Opis poprawki interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiType	Typ interfejsu API do utworzenia. * `http` tworzy interfejs API REST * `soap` tworzy interfejs API przekazywania protokołu SOAP * `websocket` tworzy interfejs API protokołu WebSocket * `graphql` tworzy interfejs API GraphQL. Nowe typy można dodawać w przyszłości.	"graphql" "grpc" '`http`' "odata" "mydło" "websocket"
apiVersion	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji	struna Ograniczenia: Maksymalna długość = 100
apiVersionDescription	Opis wersji interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiVersionSet	Szczegóły zestawu wersji	ApiVersionSetContractDetails
apiVersionSetId	Identyfikator zasobu powiązanego elementu ApiVersionSet.	struna
authenticationSettings	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.	AuthenticationSettingsContract
kontakt	Informacje kontaktowe dotyczące interfejsu API.	ApiContactInformation
opis	Opis interfejsu API. Może zawierać tagi formatowania HTML.	struna
displayName	Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 300
format	Format zawartości, w której jest importowany interfejs API. Nowe formaty można dodawać w przyszłości	"graphql-link" "grpc" "grpc-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.	Bool
licencja	Informacje o licencji dla interfejsu API.	ApiLicenseInformation
ścieżka	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.	ciąg (wymagany) Ograniczenia: Maksymalna długość = 400
Protokołów	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.	Tablica ciągów zawierająca dowolną z: '`http`' '`https`' "ws" "wss"
serviceUrl	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.	struna Ograniczenia: Maksymalna długość = 2000
sourceApiId	Identyfikator interfejsu API źródłowego interfejsu API.	struna
subscriptionKeyParameterNames	Protokoły, za pośrednictwem których udostępniono interfejs API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.	Bool
termsOfServiceUrl	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.	struna
translateRequiredQueryParameters	Strategia tłumaczenia wymaganych parametrów zapytania na szablony. Domyślnie ma wartość "template". Możliwe wartości: "template", "query"	"zapytanie" "template"
typ	Typ interfejsu API.	"graphql" "grpc" '`http`' "odata" "mydło" "websocket"
wartość	Wartość zawartości podczas importowania interfejsu API.	struna
wsdlSelector	Kryteria ograniczania importu WSDL do podzestawu dokumentu.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nazwa	Opis	Wartość
opis	Opis zestawu wersji interfejsu API.	struna
id	Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji.	struna
nazwa	Wyświetlana nazwa zestawu wersji interfejsu API.	struna
versionHeaderName	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na `header`.	struna
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.	"Nagłówek" "Zapytanie" "Segment"
versionQueryName	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość `query`.	struna

AuthenticationSettingsContract

Nazwa	Opis	Wartość
oAuth2	Ustawienia uwierzytelniania OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Kolekcja ustawień uwierzytelniania OAuth2 uwzględnionych w tym interfejsie API.	OAuth2AuthenticationSettingsContract[]
openid	Ustawienia uwierzytelniania OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Kolekcja ustawień uwierzytelniania programu Open ID Connect uwzględnionych w tym interfejsie API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nazwa	Opis	Wartość
authorizationServerId	Identyfikator serwera autoryzacji OAuth.	struna
zakres	zakres operacji.	struna

OpenIdAuthenticationSettingsContract

Nazwa	Opis	Wartość
bearerTokenSendingMethods	Jak wysłać token do serwera.	Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie"
openidProviderId	Identyfikator serwera autoryzacji OAuth.	struna

ApiContactInformation

Nazwa	Opis	Wartość
E-mail	Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail	struna
nazwa	Nazwa identyfikująca osoby kontaktowej/organizacji	struna
adres URL	Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL	struna

ApiLicenseInformation

Nazwa	Opis	Wartość
nazwa	Nazwa licencji używana dla interfejsu API	struna
adres URL	Adres URL licencji używanej dla interfejsu API. MUSI być w formacie adresu URL	struna

SubscriptionKeyParameterNamesContract

Nazwa	Opis	Wartość
nagłówek	Nazwa nagłówka klucza subskrypcji.	struna
zapytanie	Nazwa parametru ciągu zapytania klucza subskrypcji.	struna

ApiCreateOrUpdatePropertiesWsdlSelector

Nazwa	Opis	Wartość
wsdlEndpointName	Nazwa punktu końcowego (portu) do zaimportowania z WSDL	struna
wsdlServiceName	Nazwa usługi do zaimportowania z WSDL	struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych przy użyciu szablonu wdrażanie	Ten szablon przedstawia sposób tworzenia usługi API Management i konfigurowania jednostek podrzędnych
tworzenie usługi Azure Front Door przed usługą Azure API Management wdrażanie	W tym przykładzie pokazano, jak używać usługi Azure Front Door jako globalnego modułu równoważenia obciążenia przed usługą Azure API Management.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usługi/interfejsu API można wdrożyć przy użyciu operacji docelowych:

grupy zasobów

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            bearerTokenSendingMethods = [
              "string"
            ]
            openidProviderId = "string"
          }
        ]
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Wartości właściwości

usługa/interfejsy API

Nazwa	Opis	Wartość
typ	Typ zasobu	"Microsoft.ApiManagement/service/apis@2023-09-01-preview"
nazwa	Nazwa zasobu	ciąg (wymagany) Limit znaków: 1–80 Prawidłowe znaki: Alfanumeryczne i łączniki. Zacznij od litery i kończy się znakiem alfanumerycznym.
parent_id	Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu.	Identyfikator zasobu typu: usługi
Właściwości	Jednostka interfejsu API tworzy właściwości aktualizacji.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nazwa	Opis	Wartość
apiRevision	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 100
apiRevisionDescription	Opis poprawki interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiType	Typ interfejsu API do utworzenia. * `http` tworzy interfejs API REST * `soap` tworzy interfejs API przekazywania protokołu SOAP * `websocket` tworzy interfejs API protokołu WebSocket * `graphql` tworzy interfejs API GraphQL. Nowe typy można dodawać w przyszłości.	"graphql" "grpc" "`http`" "odata" "mydło" "websocket"
apiVersion	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji	struna Ograniczenia: Maksymalna długość = 100
apiVersionDescription	Opis wersji interfejsu API.	struna Ograniczenia: Maksymalna długość = 256
apiVersionSet	Szczegóły zestawu wersji	ApiVersionSetContractDetails
apiVersionSetId	Identyfikator zasobu powiązanego elementu ApiVersionSet.	struna
authenticationSettings	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.	AuthenticationSettingsContract
kontakt	Informacje kontaktowe dotyczące interfejsu API.	ApiContactInformation
opis	Opis interfejsu API. Może zawierać tagi formatowania HTML.	struna
displayName	Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.	struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 300
format	Format zawartości, w której jest importowany interfejs API. Nowe formaty można dodawać w przyszłości	"graphql-link" "grpc" "grpc-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.	Bool
licencja	Informacje o licencji dla interfejsu API.	ApiLicenseInformation
ścieżka	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.	ciąg (wymagany) Ograniczenia: Maksymalna długość = 400
Protokołów	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.	Tablica ciągów zawierająca dowolną z: "`http`" "`https`" "ws" "wss"
serviceUrl	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.	struna Ograniczenia: Maksymalna długość = 2000
sourceApiId	Identyfikator interfejsu API źródłowego interfejsu API.	struna
subscriptionKeyParameterNames	Protokoły, za pośrednictwem których udostępniono interfejs API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.	Bool
termsOfServiceUrl	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.	struna
translateRequiredQueryParameters	Strategia tłumaczenia wymaganych parametrów zapytania na szablony. Domyślnie ma wartość "template". Możliwe wartości: "template", "query"	"zapytanie" "szablon"
typ	Typ interfejsu API.	"graphql" "grpc" "`http`" "odata" "mydło" "websocket"
wartość	Wartość zawartości podczas importowania interfejsu API.	struna
wsdlSelector	Kryteria ograniczania importu WSDL do podzestawu dokumentu.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nazwa	Opis	Wartość
opis	Opis zestawu wersji interfejsu API.	struna
id	Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji.	struna
nazwa	Wyświetlana nazwa zestawu wersji interfejsu API.	struna
versionHeaderName	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na `header`.	struna
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.	"Nagłówek" "Zapytanie" "Segment"
versionQueryName	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość `query`.	struna

AuthenticationSettingsContract

Nazwa	Opis	Wartość
oAuth2	Ustawienia uwierzytelniania OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Kolekcja ustawień uwierzytelniania OAuth2 uwzględnionych w tym interfejsie API.	OAuth2AuthenticationSettingsContract[]
openid	Ustawienia uwierzytelniania OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Kolekcja ustawień uwierzytelniania programu Open ID Connect uwzględnionych w tym interfejsie API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nazwa	Opis	Wartość
authorizationServerId	Identyfikator serwera autoryzacji OAuth.	struna
zakres	zakres operacji.	struna

OpenIdAuthenticationSettingsContract

Nazwa	Opis	Wartość
bearerTokenSendingMethods	Jak wysłać token do serwera.	Tablica ciągów zawierająca dowolną z: "authorizationHeader" "zapytanie"
openidProviderId	Identyfikator serwera autoryzacji OAuth.	struna

ApiContactInformation

Nazwa	Opis	Wartość
E-mail	Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail	struna
nazwa	Nazwa identyfikująca osoby kontaktowej/organizacji	struna
adres URL	Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL	struna

ApiLicenseInformation

Nazwa	Opis	Wartość
nazwa	Nazwa licencji używana dla interfejsu API	struna
adres URL	Adres URL licencji używanej dla interfejsu API. MUSI być w formacie adresu URL	struna

SubscriptionKeyParameterNamesContract

Nazwa	Opis	Wartość
nagłówek	Nazwa nagłówka klucza subskrypcji.	struna
zapytanie	Nazwa parametru ciągu zapytania klucza subskrypcji.	struna

ApiCreateOrUpdatePropertiesWsdlSelector

Nazwa	Opis	Wartość
wsdlEndpointName	Nazwa punktu końcowego (portu) do zaimportowania z WSDL	struna
wsdlServiceName	Nazwa usługi do zaimportowania z WSDL	struna

Udostępnij za pośrednictwem

Microsoft.ApiManagement — usługa/interfejsy API

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

usługa/interfejsy API

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Szablony szybkiego startu

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

usługa/interfejsy API

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Szablony szybkiego startu

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

usługa/interfejsy API

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Opinia

Dodatkowe zasoby