Udostępnij za pośrednictwem

Product - Get

  • Odwołanie
Usługa:
API Management
Wersja interfejsu API:
2022-08-01

Pobiera szczegóły produktu określonego przez jego identyfikator.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2022-08-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
productId
 path True

string

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName
 path True

string

Nazwa usługi API Management.

Wzorzec wyrażenia regularnego: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

ProductContract

Treść odpowiedzi zawiera określoną jednostkę Product.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementGetProduct

Przykładowe żądanie

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited?api-version=2022-08-01

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "unlimited",
  "properties": {
    "displayName": "Unlimited",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.
ErrorResponse

Odpowiedź na błąd.
ProductContract

Szczegóły produktu.
ProductState

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.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.
message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details

ErrorFieldContract[]

Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji.
error.message

string

Czytelna dla człowieka reprezentacja błędu.

ProductContract

Szczegóły produktu.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.approvalRequired

boolean

czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, co umożliwi 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.
properties.description

string

Opis produktu. Może zawierać tagi formatowania HTML.
properties.displayName

string

Nazwa produktu.
properties.state

ProductState

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.
properties.subscriptionRequired

boolean

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.
properties.subscriptionsLimit

integer

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.
properties.terms

string

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.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ProductState

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.

Nazwa Typ Opis
notPublished

string

published

string