Gateway - Generate Token

Service:

API Management

API Version:

2022-08-01

Mendapatkan Token Otorisasi Akses Bersama untuk gateway.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2022-08-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
gatewayId	path	True	string	Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
expiry	True	string	Waktu Kedaluwarsa Token. Waktu kedaluwarsa token maksimum diatur ke 30 hari. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
keyType	True	KeyType	Kunci yang akan digunakan untuk menghasilkan token gateway.

Respons

Nama	Jenis	Deskripsi
200 OK	GatewayTokenContract	Isi respons berisi token otorisasi untuk gateway.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementGatewayGenerateToken

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2022-08-01

{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Java

import com.azure.resourcemanager.apimanagement.models.GatewayTokenRequestContract;
import com.azure.resourcemanager.apimanagement.models.KeyType;
import java.time.OffsetDateTime;

/** Samples for Gateway GenerateToken. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayGenerateToken.json
     */
    /**
     * Sample code: ApiManagementGatewayGenerateToken.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGatewayGenerateToken(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .gateways()
            .generateTokenWithResponse(
                "rg1",
                "apimService1",
                "gw1",
                new GatewayTokenRequestContract()
                    .withKeyType(KeyType.PRIMARY)
                    .withExpiry(OffsetDateTime.parse("2020-04-21T00:44:24.2845269Z")),
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_gateway_generate_token.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gateway.generate_token(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
        parameters={"expiry": "2020-04-21T00:44:24.2845269Z", "keyType": "primary"},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayGenerateToken.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayGenerateToken.json
func ExampleGatewayClient_GenerateToken() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGatewayClient().GenerateToken(ctx, "rg1", "apimService1", "gw1", armapimanagement.GatewayTokenRequestContract{
		Expiry:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-21T00:44:24.284Z"); return t }()),
		KeyType: to.Ptr(armapimanagement.KeyTypePrimary),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GatewayTokenContract = armapimanagement.GatewayTokenContract{
	// 	Value: to.Ptr("gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the Shared Access Authorization Token for the gateway.
 *
 * @summary Gets the Shared Access Authorization Token for the gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGatewayGenerateToken.json
 */
async function apiManagementGatewayGenerateToken() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const parameters = {
    expiry: new Date("2020-04-21T00:44:24.2845269Z"),
    keyType: "primary",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.gateway.generateToken(
    resourceGroupName,
    serviceName,
    gatewayId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definisi

Nama	Deskripsi
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
GatewayTokenContract	Token akses gateway.
GatewayTokenRequestContract	Properti kontrak permintaan token gateway.
KeyType	Kunci sedang diregenerasi.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

GatewayTokenContract

Token akses gateway.

Nama	Jenis	Deskripsi
value	string	Nilai token Autentikasi Akses Bersama untuk Gateway.

GatewayTokenRequestContract

Properti kontrak permintaan token gateway.

Nama	Jenis	Nilai Default	Deskripsi
expiry	string		Waktu Kedaluwarsa Token. Waktu kedaluwarsa token maksimum diatur ke 30 hari. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
keyType	KeyType	primary	Kunci yang akan digunakan untuk menghasilkan token gateway.

KeyType

Kunci sedang diregenerasi.

Nama	Jenis	Deskripsi
primary	string
secondary	string