Udostępnij za pośrednictwem

Bezpośrednie zarządzanie API Management interfejsu API REST

  • Artykuł

Usługa Azure API Management udostępnia bezpośredni interfejs API REST zarządzania do wykonywania operacji na wybranych jednostkach, takich jak użytkownicy, grupy, produkty i subskrypcje. Interfejs API zarządzania bezpośredniego może pominąć pewne limity interfejsu API opartego na usłudze Azure Resource Manager, takie jak ograniczanie żądań.

Ważne

W tej sekcji opisano sposób uzyskiwania dostępu do bezpośredniego zarządzania API Management interfejsu API REST. Ten interfejs API ma inny mechanizm uwierzytelniania niż usługa Azure Resource Manager i używa innego podstawowego adresu URL.

Włączanie dostępu do interfejsu API REST zarządzania bezpośredniego

Aby można było pomyślnie wykonać wywołania, należy udzielić dostępu do bezpośredniego zarządzania API Management interfejsu API REST.

  1. Przejdź do wystąpienia usługi Azure API Management w Azure Portal.

  2. Wybierz pozycję Interfejs API zarządzania w sekcji Wdrażanie i infrastruktura w menu po lewej stronie.

    Wybierz pozycję Interfejs API zarządzania w Azure Portal

  3. W obszarze Włącz interfejs API REST API Management wybierz pozycję Tak.

    Ważne

    Jeśli opcja Włącz API Management interfejsu API REST nie zostanie wybrana, wywołania interfejsu API REST dla tego wystąpienia usługi nie powiedzą się.

    Włączanie interfejsu API API Management w Azure Portal

Domyślny typ nośnika

Domyślnym typem nośnika dla żądań i odpowiedzi jest application/json. W przypadku zauważyć, że niektóre operacje obsługują inne typy zawartości. Jeśli dla określonej operacji nie wymieniono żadnego dodatkowego typu zawartości, typ nośnika to application/json.

Authentication

Każdemu żądaniu do interfejsu API REST API Management musi towarzyszyć Authorization nagłówek zawierający prawidłowy token dostępu współdzielonego, jak pokazano w poniższym przykładzie.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Ten token dostępu można wygenerować programowo lub z poziomu portalu wydawcy API Management. Aby uzyskać instrukcje dotyczące generowania i pobierania tokenu dostępu, zobacz Aby ręcznie utworzyć token dostępu i Aby programowo utworzyć token dostępu.

Podstawowy adres URL

Podstawowy adres URL bezpośredniego zarządzania API Management interfejsu API REST jest zgodny z następującym szablonem.

https://{servicename}.management.azure-api.net

Ten szablon zawiera następujący parametr.

  • {serviceName} to nazwa usługi określona podczas tworzenia usługi, na przykład https://contosoapi.management.azure-api.net.

Wszystkie adresy URL zwracane przez interfejs API REST API Management są powiązane z tym podstawowym adresem URL, a wszystkie żądania do interfejsu API REST muszą używać tego podstawowego szablonu adresu URL.

Parametr zapytania wersji

Wszystkie operacje oczekują parametru api-version zapytania z wartością w formacie YYYY-MM-DD, na przykład 2021-08-01.

Uwaga

W okresie obowiązywania wersji zapoznawczej interfejsu API -preview REST API Management jest dołączany do parametru zapytania wersji, na przykład 2021-04-01-preview.

Jeśli ten parametr zapytania nie zostanie przekazany w ciągu zapytania żądania, serwer zwróci kod 400 Bad Requeststanu . Aby uzyskać listę obsługiwanych wersji, zobacz dokumentację interfejsu API REST API Management.

Następne kroki