Udostępnij przez


Uwierzytelnianie i autoryzacja

Każde żądanie do narzędzia foundry musi zawierać nagłówek uwierzytelniania. Ten nagłówek przechodzi wzdłuż klucza zasobu lub tokenu uwierzytelniania, który służy do weryfikowania subskrypcji dla usługi lub grupy usług. W tym artykule możesz zapoznać się ze sposobami uwierzytelniania żądania i wymagań dla każdego z nich.

Nagłówki

Zasubskrybuj usługę Translator lub wiele usług w narzędziu Foundry Tools i użyj klucza (dostępnego w witrynie Azure Portal), aby się uwierzytelnić.

Istnieją trzy nagłówki, których można użyć do uwierzytelniania subskrypcji. W tej tabeli opisano sposób użycia poszczególnych elementów:

Nagłówki Opis
Ocp-Apim —Subscription-Key Jeśli przekazujesz klucz tajny, użyj subskrypcji narzędzi Foundry Tools.
Wartość to klucz tajny platformy Azure dla twojej subskrypcji w usłudze Translator.
Autoryzacja Jeśli przekazujesz token uwierzytelniania, użyj subskrypcji narzędzi Foundry Tools.
Wartość to token elementu nośnego: Bearer <token>.
Ocp-Apim —Subscription-Region Używaj z wieloma usługami i regionalnymi zasobami translatora.
Wartość jest regionem zasobu z wieloma usługami lub regionalnymi translatorami. Ta wartość jest opcjonalna w przypadku korzystania z globalnego zasobu translatora.

Klucz tajny

Pierwszą opcją jest uwierzytelnienie przy użyciu nagłówka Ocp-Apim-Subscription-Key . Ocp-Apim-Subscription-Key: <YOUR_SECRET_KEY> Dodaj nagłówek do żądania.

Uwierzytelnianie za pomocą zasobu globalnego

Jeśli używasz globalnego zasobu translatora, musisz dołączyć jeden nagłówek, aby wywołać usługę Translator.

Nagłówki Opis
Ocp-Apim —Subscription-Key Wartość to klucz tajny platformy Azure dla twojej subskrypcji w usłudze Translator.

Oto przykładowe żądanie wywołania usługi Translator przy użyciu globalnego zasobu translatora

// Pass secret key using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
    -H "Ocp-Apim-Subscription-Key:<your-key>" \
    -H "Content-Type: application/json" \
    -d "[{'Text':'Hello, what is your name?'}]"

Uwierzytelnianie przy użyciu zasobu regionalnego

Jeśli używasz zasobu regionalnego translatora, istnieją dwa nagłówki, które należy wywołać w usłudze Translator.

Nagłówki Opis
Ocp-Apim —Subscription-Key Wartość to klucz tajny platformy Azure dla twojej subskrypcji w usłudze Translator.
Ocp-Apim —Subscription-Region Wartość jest regionem zasobu translatora.

Oto przykładowe żądanie wywołania usługi Translator przy użyciu regionalnego zasobu translatora

// Pass secret key and region using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
    -H "Ocp-Apim-Subscription-Key:<your-key>" \
    -H "Ocp-Apim-Subscription-Region:<your-region>" \
    -H "Content-Type: application/json" \
    -d "[{'Text':'Hello, what is your name?'}]"

Uwierzytelnianie przy użyciu zasobu z wieloma usługami

Zasób z wieloma usługami umożliwia użycie pojedynczego klucza interfejsu API do uwierzytelniania żądań dla wielu usług.

W przypadku korzystania z klucza tajnego z wieloma usługami należy dołączyć dwa nagłówki uwierzytelniania do żądania. Istnieją dwa nagłówki, które należy wywołać w usłudze Translator.

Nagłówki Opis
Ocp-Apim —Subscription-Key Wartość to klucz tajny platformy Azure dla zasobu z wieloma usługami.
Ocp-Apim —Subscription-Region Wartość jest regionem zasobu z wieloma usługami.

Region jest wymagany dla subskrypcji interfejsu API tekstu wielu usług. Wybrany region jest jedynym regionem, którego można użyć do tłumaczenia tekstu podczas korzystania z klucza wielosłużowego. Musi to być ten sam region, który został wybrany podczas tworzenia konta subskrypcji z wieloma usługami za pośrednictwem witryny Azure Portal.

Jeśli przekażesz klucz tajny w ciągu zapytania przy użyciu parametru Subscription-Key, musisz określić region z parametrem Subscription-Regionzapytania .

Uwierzytelnianie przy użyciu tokenu dostępu

Alternatywnie możesz wymienić klucz tajny dla tokenu dostępu. Ten token jest dołączany do każdego żądania jako nagłówka Authorization . Aby uzyskać token autoryzacji, prześlij POST żądanie do następującego adresu URL:

Typ zasobu Adres URL usługi uwierzytelniania
Światowy https://api.cognitive.microsoft.com/sts/v1.0/issueToken
Regionalne lub wieloasłużowe https://<your-region>.api.cognitive.microsoft.com/sts/v1.0/issueToken

Oto przykładowe żądania uzyskania tokenu podanego klucza tajnego dla zasobu globalnego:

// Pass secret key using header
curl --header 'Ocp-Apim-Subscription-Key: <your-key>' --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken'

// Pass secret key using query string parameter
curl --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken?Subscription-Key=<your-key>'

Oto przykładowe żądania uzyskania tokenu podanego klucza tajnego dla zasobu regionalnego znajdującego się w regionie Środkowe stany USA:

// Pass secret key using header
curl --header "Ocp-Apim-Subscription-Key: <your-key>" --data "" "https://centralus.api.cognitive.microsoft.com/sts/v1.0/issueToken"

// Pass secret key using query string parameter
curl --data "" "https://centralus.api.cognitive.microsoft.com/sts/v1.0/issueToken?Subscription-Key=<your-key>"

Pomyślne żądanie zwraca zakodowany token dostępu jako zwykły tekst w treści odpowiedzi. Prawidłowy token jest przekazywany do usługi Translator jako token elementu nośnego w autoryzacji.

Authorization: Bearer <Base64-access_token>

Token uwierzytelniania jest ważny przez 10 minut. Token powinien być ponownie używany podczas wykonywania wielu wywołań do usługi Translator. Jeśli jednak program wysyła żądania do usługi Translator przez dłuższy czas, program musi zażądać nowego tokenu dostępu w regularnych odstępach czasu (na przykład co 8 minut).

Uwierzytelnianie przy użyciu identyfikatora Entra firmy Microsoft

Usługa Translator w wersji 3.0 obsługuje uwierzytelnianie firmy Microsoft, oparte na chmurze rozwiązanie do zarządzania tożsamościami i dostępem firmy Microsoft. Nagłówki autoryzacji umożliwiają usłudze Translator sprawdzenie, czy klient żądający ma autoryzację do korzystania z zasobu i do ukończenia żądania.

Wymagania wstępne

Nagłówki identyfikatora Entra firmy Microsoft

Nagłówek Wartość
Autoryzacja Wartość to token elementu nośnego dostępu wygenerowany przez identyfikator Entra firmy Microsoft.
  • Token elementu nośnego zapewnia dowód uwierzytelniania i weryfikuje autoryzację klienta do korzystania z zasobu.
  • Token uwierzytelniania jest ważny przez 10 minut i powinien być ponownie używany podczas wykonywania wielu wywołań w usłudze Translator.
  • ZobaczPrzykładowe żądanie: 2. Uzyskiwanie tokenu
Ocp-Apim —Subscription-Region Wartość jest regionem zasobu translatora.
  • Ta wartość jest opcjonalna, jeśli zasób jest globalny.
Ocp-Apim-ResourceId Wartość to identyfikator zasobu dla wystąpienia zasobu usługi Translator.
  • Identyfikator zasobu można znaleźć w witrynie Azure Portal na stronie Właściwości zasobu usługi Translator →.
  • Format identyfikatora zasobu:
    /subscriptions/</>resourceGroups/<resourceGroupName>/providers/Microsoft.CognitiveServices/accounts/<resourceName>/
Strona właściwości usługi Translator — Witryna Azure Portal

Zrzut ekranu: strona właściwości usługi Translator w witrynie Azure Portal.

Ważne

Przypisz rolę użytkownika usług Cognitive Services do jednostki usługi. Przypisując tę rolę, udzielasz jednostce usługi dostępu do zasobu usługi Translator.

Przykłady

Korzystanie z globalnego punktu końcowego

// Using headers, pass a bearer token generated by Azure AD, resource ID, and the region.

curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
    -H "Authorization: Bearer <Base64-access_token>"\
    -H "Ocp-Apim-ResourceId: <Resource ID>" \
    -H "Ocp-Apim-Subscription-Region: <your-region>" \
    -H "Content-Type: application/json" \
    -data-raw "[{'Text':'Hello, friend.'}]"

Korzystanie z niestandardowego punktu końcowego

// Using headers, pass a bearer token generated by Azure AD.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
    -H "Authorization: Bearer <Base64-access_token>"\
    -H "Content-Type: application/json" \
    -data-raw "[{'Text':'Hello, friend.'}]"

Przykłady użycia tożsamości zarządzanych

Usługa Translator w wersji 3.0 obsługuje również autoryzowanie dostępu do tożsamości zarządzanych. Jeśli tożsamość zarządzana jest włączona dla zasobu translatora, możesz przekazać token elementu nośnego wygenerowany przez tożsamość zarządzaną w nagłówku żądania.

Za pomocą globalnego punktu końcowego

// Using headers, pass a bearer token generated either by Azure AD or Managed Identities, resource ID, and the region.

curl -X POST https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es \
    -H "Authorization: Bearer <Base64-access_token>"\
    -H "Ocp-Apim-ResourceId: <Resource ID>" \
    -H "Ocp-Apim-Subscription-Region: <your-region>" \
    -H "Content-Type: application/json" \
    -data-raw "[{'Text':'Hello, friend.'}]"

Za pomocą niestandardowego punktu końcowego

//Using headers, pass a bearer token generated by Managed Identities.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
    -H "Authorization: Bearer <Base64-access_token>"\
    -H "Content-Type: application/json" \
    -data-raw "[{'Text':'Hello, friend.'}]"

Obsługa sieci wirtualnej

Usługa Translator jest teraz dostępna z funkcjami usługi Virtual Network (VNET) we wszystkich regionach chmury publicznej platformy Azure. Aby włączyć sieć wirtualną, zobaczKonfigurowanie sieci wirtualnych narzędzi foundry.

Po włączeniu tej funkcji należy wywołać usługę Translator przy użyciu niestandardowego punktu końcowego. Nie można użyć globalnego punktu końcowego translatora ("api.cognitive.microsofttranslator.com") i nie można uwierzytelnić się przy użyciu tokenu dostępu.

Niestandardowy punkt końcowy można znaleźć po utworzeniu zasobu translatora i umożliwieniu dostępu z wybranych sieci i prywatnych punktów końcowych.

  1. Przejdź do zasobu usługi Translator w witrynie Azure Portal.

  2. Wybierz pozycję Sieć w sekcji Zarządzanie zasobami.

  3. Na karcie Zapory i sieci wirtualne wybierz pozycję Wybrane sieci i prywatne punkty końcowe.

    Zrzut ekranu przedstawiający ustawienie sieci wirtualnej w witrynie Azure Portal.

  4. Wybierz pozycję Zapisz, aby zastosować zmiany.

  5. Wybierz pozycję Klucze i punkt końcowy w sekcji Zarządzanie zasobami .

  6. Wybierz kartę Sieć wirtualna .

  7. Na liście znajdują się punkty końcowe tłumaczenia tekstu i tłumaczenia dokumentów.

    Zrzut ekranu przedstawiający punkt końcowy sieci wirtualnej.

Nagłówki Opis
Ocp-Apim —Subscription-Key Wartość to klucz tajny platformy Azure dla twojej subskrypcji w usłudze Translator.
Ocp-Apim —Subscription-Region Wartość jest regionem zasobu translatora. Ta wartość jest opcjonalna, jeśli zasób jest global

Oto przykładowe żądanie wywołania usługi Translator przy użyciu niestandardowego punktu końcowego

// Pass secret key and region using headers
curl -X POST "https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es" \
    -H "Ocp-Apim-Subscription-Key:<your-key>" \
    -H "Ocp-Apim-Subscription-Region:<your-region>" \
    -H "Content-Type: application/json" \
    -d "[{'Text':'Hello, what is your name?'}]"