Microsoft.ApiManagement — usługa/produkty

  • Artykuł

Definicja zasobu Bicep

Typ zasobu usługi/produktów można wdrożyć przy użyciu operacji docelowych:

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

Format zasobu

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

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Wartości właściwości

usługa/produkty

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)

Limit znaków: 1–80

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery i kończy się alfanumeryczną.
Nadrzędny W pliku 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.		 Symboliczna nazwa zasobu typu: usługa
properties Właściwości kontraktu jednostki produktu. ProductContractProperties

ProductContractProperties

Nazwa Opis Wartość
approvalRequired czy zatwierdzenie subskrypcji jest wymagane. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. bool
description (opis) Opis produktu. Może zawierać tagi formatowania HTML. ciąg
displayName Nazwa produktu. ciąg (wymagany)
stan niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. "notPublished"
"opublikowane"
subscriptionRequired Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie. Jeśli to prawda, produkt jest określany jako "chroniony", a prawidłowy klucz subskrypcji jest wymagany, aby żądanie do interfejsu API zawartego w produkcie zakończyło się powodzeniem. Jeśli wartość false, produkt jest określany jako "otwarty" i żądania do interfejsu API zawartego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość jest prawdziwa. bool
subscriptionsLimit Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pominięto, aby zezwolić na nieograniczoną liczbę subskrypcji użytkownika. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. int
Warunki Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą prezentowani i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji. ciąg

Szablony szybkiego startu

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

Template Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych za pomocą szablonu

Wdróż na platformie Azure		 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

Wdróż na platformie Azure		 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/produktów można wdrożyć przy użyciu operacji docelowych:

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

Format zasobu

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

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Wartości właściwości

usługa/produkty

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.ApiManagement/service/products"
apiVersion Wersja interfejsu API zasobów "2023-05-01-preview"
name 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ę alfanumeryczną.
properties Właściwości kontraktu jednostki produktu. ProductContractProperties

ProductContractProperties

Nazwa Opis Wartość
approvalRequired czy zatwierdzenie subskrypcji jest wymagane. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. bool
description (opis) Opis produktu. Może zawierać tagi formatowania HTML. ciąg
displayName Nazwa produktu. ciąg (wymagany)
stan niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. "notPublished"
"opublikowane"
subscriptionRequired Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie. Jeśli to prawda, produkt jest określany jako "chroniony", a prawidłowy klucz subskrypcji jest wymagany, aby żądanie do interfejsu API zawartego w produkcie zakończyło się powodzeniem. Jeśli wartość false, produkt jest określany jako "otwarty" i żądania do interfejsu API zawartego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość jest prawdziwa. bool
subscriptionsLimit Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pominięto, aby zezwolić na nieograniczoną liczbę subskrypcji użytkownika. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. int
Warunki Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą prezentowani i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji. ciąg

Szablony szybkiego startu

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

Template Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych za pomocą szablonu

Wdróż na platformie Azure		 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

Wdróż na platformie Azure		 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/produktów 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 dziennik zmian.

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Wartości właściwości

usługa/produkty

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name Nazwa zasobu ciąg (wymagany)

Limit znaków: 1–80

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery i kończy się alfanumeryczną.
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługa
properties Właściwości kontraktu jednostki produktu. ProductContractProperties

ProductContractProperties

Nazwa Opis Wartość
approvalRequired czy zatwierdzenie subskrypcji jest wymagane. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. bool
description (opis) Opis produktu. Może zawierać tagi formatowania HTML. ciąg
displayName Nazwa produktu. ciąg (wymagany)
stan czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu dla deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublikowany. "notPublished"
"opublikowany"
subscriptionRequired Określa, czy do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie jest wymagana subskrypcja produktu. Jeśli to prawda, produkt jest określany jako "chroniony", a prawidłowy klucz subskrypcji jest wymagany, aby żądanie do interfejsu API zawartego w produkcie zakończyło się pomyślnie. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API zawartego w produkcie można wykonać bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że jest to wartość true. bool
subscriptionsLimit Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pomiń, aby zezwolić na nieograniczoną liczbę subskrypcji na użytkownika. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false. int
Warunki Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt zostaną przedstawini i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji. ciąg