Microsoft.ApiManagement — usługa/produkty
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definicja zasobu Bicep
Typ zasobu usługi/produktów 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/products, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/products@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Wartości właściwości
Microsoft.ApiManagement/service/products
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| 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 | Właściwości kontraktu jednostki produktu. | ProductContractProperties |
ProductContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| approvalRequired | czy jest wymagane zatwierdzenie subskrypcji. 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 |
| opis | Opis produktu. Może zawierać tagi formatowania HTML. | struna Ograniczenia: Maksymalna długość = |
| displayName | Nazwa produktu. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| stan | niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. | "notPublished" "opublikowany" |
| 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 powiodło się. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API uwzględnionego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość ma 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 użytkowników. 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ą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji. | struna |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi/produktów 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/products, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2024-06-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
Microsoft.ApiManagement/service/products
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2024-06-01-preview" |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| Właściwości | Właściwości kontraktu jednostki produktu. | ProductContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/products" |
ProductContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| approvalRequired | czy jest wymagane zatwierdzenie subskrypcji. 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 |
| opis | Opis produktu. Może zawierać tagi formatowania HTML. | struna Ograniczenia: Maksymalna długość = |
| displayName | Nazwa produktu. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| stan | niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. | "notPublished" "opublikowany" |
| 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 powiodło się. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API uwzględnionego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość ma 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 użytkowników. 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ą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji. | struna |
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 dziennika 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@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Wartości właściwości
Microsoft.ApiManagement/service/products
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Właściwości kontraktu jednostki produktu. | ProductContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/products@2024-06-01-preview" |
ProductContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| approvalRequired | czy jest wymagane zatwierdzenie subskrypcji. 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 |
| opis | Opis produktu. Może zawierać tagi formatowania HTML. | struna Ograniczenia: Maksymalna długość = |
| displayName | Nazwa produktu. | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 1 (wymagana) |
| stan | niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. | "notPublished" "opublikowany" |
| 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 powiodło się. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API uwzględnionego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość ma 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 użytkowników. 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ą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji. | struna |