Udostępnij za pośrednictwem

Microsoft.ApiManagement service/apis 2016-07-07

  • Artykuł

Definicja zasobu Bicep

Typ zasobu usługi/interfejsu API 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.ApiManagement/service/apis, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Wartości właściwości

AuthenticationSettingsContract

Nazwa Opis Wartość
oAuth2 Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nazwa Opis Wartość
authenticationSettings Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. AuthenticationSettingsContract
opis Opis interfejsu API. Może zawierać tagi formatowania HTML. struna
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
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
ś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. struna

Ograniczenia:
Maksymalna długość = (wymagana)
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" (wymagane)
serviceUrl Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
subscriptionKeyParameterNames Protokoły, za pośrednictwem których udostępniono interfejs API. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/interfejsu API 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.ApiManagement/service/apis, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Wartości właściwości

AuthenticationSettingsContract

Nazwa Opis Wartość
oAuth2 Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2016-07-07'
authenticationSettings Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. AuthenticationSettingsContract
opis Opis interfejsu API. Może zawierać tagi formatowania HTML. struna
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
ś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. struna

Ograniczenia:
Maksymalna długość = (wymagana)
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" (wymagane)
serviceUrl Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
subscriptionKeyParameterNames Protokoły, za pośrednictwem których udostępniono interfejs API. SubscriptionKeyParameterNamesContract
typ Typ zasobu "Microsoft.ApiManagement/service/apis"

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

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@2016-07-07"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Wartości właściwości

AuthenticationSettingsContract

Nazwa Opis Wartość
oAuth2 Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nazwa Opis Wartość
authenticationSettings Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API. AuthenticationSettingsContract
opis Opis interfejsu API. Może zawierać tagi formatowania HTML. struna
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
ś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. struna

Ograniczenia:
Maksymalna długość = (wymagana)
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" (wymagane)
serviceUrl Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 1 (wymagana)
subscriptionKeyParameterNames Protokoły, za pośrednictwem których udostępniono interfejs API. SubscriptionKeyParameterNamesContract
typ Typ zasobu "Microsoft.ApiManagement/service/apis@2016-07-07"

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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