Api Export - Get

참조

Service:: API Management

API Version:: 2022-08-01

5분 동안 유효한 SAS 키를 사용하여 스토리지 Blob에 지정된 형식으로 식별자가 지정한 API의 세부 정보를 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?format={format}&export=true&api-version=2022-08-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiId	path	True	string	API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 가 있습니다. rev=n은 접미사로, 여기서 n은 수정 번호입니다. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string	API Management 서비스의 이름입니다. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
export	query	True	ExportApi	API 세부 정보를 내보내는 데 필요한 쿼리 매개 변수입니다.
format	query	True	ExportFormat	5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보낼 형식입니다.

응답

Name	형식	Description
200 OK	ApiExportResult	응답에는 전체 API 메타데이터 집합이 있는 스트림이 포함되며 작업 엔터티 배열이 포함된 API 엔터티가 포함됩니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementGetApiExportInOpenApi2dot0

ApiManagementGetApiExportInOpenApi3dot0

ApiManagementGetApiExportInOpenApi2dot0

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api?format=swagger-link&export=true&api-version=2022-08-01

import com.azure.resourcemanager.apimanagement.models.ExportApi;
import com.azure.resourcemanager.apimanagement.models.ExportFormat;

/** Samples for ApiExport Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json
     */
    /**
     * Sample code: ApiManagementGetApiExportInOpenApi2dot0.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiExportInOpenApi2dot0(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiExports()
            .getWithResponse(
                "rg1",
                "apimService1",
                "echo-api",
                ExportFormat.SWAGGER_LINK,
                ExportApi.TRUE,
                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

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_get_api_export_in_open_api2dot0.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.api_export.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api",
        format="swagger-link",
        export="true",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi2dot0.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

package armapimanagement_test

import (
	"context"
	"log"

	"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/ApiManagementGetApiExportInOpenApi2dot0.json
func ExampleAPIExportClient_Get_apiManagementGetApiExportInOpenApi2Dot0() {
	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.NewAPIExportClient().Get(ctx, "rg1", "apimService1", "echo-api", armapimanagement.ExportFormatSwagger, armapimanagement.ExportAPITrue, 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.APIExportResult = armapimanagement.APIExportResult{
	// 	ExportResultFormat: to.Ptr(armapimanagement.ExportResultFormatSwagger),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api"),
	// 	Value: &armapimanagement.APIExportResultValue{
	// 		Link: to.Ptr("https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?sv=2015-07-08&sr=b&sig=mxhLsFuOonu8EXIjyFPV%2FnDra0qTIoip7N7MuU%2BTFsA%3D&se=2019-04-10T22:41:31Z&sp=r"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
 *
 * @summary Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json
 */
async function apiManagementGetApiExportInOpenApi2Dot0() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api";
  const format = "swagger-link";
  const exportParam = "true";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiExport.get(
    resourceGroupName,
    serviceName,
    apiId,
    format,
    exportParam
  );
  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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
  "format": "swagger-link-json",
  "value": {
    "link": "https://apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore Extensive.json?sv=2015-07-08&sr=b&sig=mxhLsFuOonu8EXIjyFPV%2FnDra0qTIoip7N7MuU%2BTFsA%3D&se=2019-04-10T22:41:31Z&sp=r"
  }
}

ApiManagementGetApiExportInOpenApi3dot0

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676?format=openapi-link&export=true&api-version=2022-08-01

import com.azure.resourcemanager.apimanagement.models.ExportApi;
import com.azure.resourcemanager.apimanagement.models.ExportFormat;

/** Samples for ApiExport Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi3dot0.json
     */
    /**
     * Sample code: ApiManagementGetApiExportInOpenApi3dot0.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiExportInOpenApi3dot0(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiExports()
            .getWithResponse(
                "rg1",
                "apimService1",
                "aid9676",
                ExportFormat.OPENAPI_LINK,
                ExportApi.TRUE,
                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

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_get_api_export_in_open_api3dot0.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.api_export.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="aid9676",
        format="openapi-link",
        export="true",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi3dot0.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

package armapimanagement_test

import (
	"context"
	"log"

	"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/ApiManagementGetApiExportInOpenApi3dot0.json
func ExampleAPIExportClient_Get_apiManagementGetApiExportInOpenApi3Dot0() {
	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.NewAPIExportClient().Get(ctx, "rg1", "apimService1", "aid9676", armapimanagement.ExportFormatOpenapi, armapimanagement.ExportAPITrue, 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.APIExportResult = armapimanagement.APIExportResult{
	// 	ExportResultFormat: to.Ptr(armapimanagement.ExportResultFormatOpenAPI),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676"),
	// 	Value: &armapimanagement.APIExportResultValue{
	// 		Link: to.Ptr("https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signature"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
 *
 * @summary Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiExportInOpenApi3dot0.json
 */
async function apiManagementGetApiExportInOpenApi3Dot0() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "aid9676";
  const format = "openapi-link";
  const exportParam = "true";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiExport.get(
    resourceGroupName,
    serviceName,
    apiId,
    format,
    exportParam
  );
  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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/aid9676",
  "format": "openapi-link",
  "value": {
    "link": "https: //apimgmtstkjpszxxxxxxx.blob.core.windows.net/api-export/Swagger Petstore.yaml?storage-sas-signature"
  }
}

정의

Name	Description
ApiExportResult	API 내보내기 결과입니다.
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.
ExportApi	API 세부 정보를 내보내는 데 필요한 쿼리 매개 변수입니다.
ExportFormat	5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보낼 형식입니다.
ExportResultFormat	5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보내는 형식입니다.
Value	내보낸 API 세부 정보의 스키마를 정의하는 개체입니다.

ApiExportResult

API 내보내기 결과입니다.

Name	형식	Description
format	ExportResultFormat	5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보내는 형식입니다.
id	string	내보낸 API의 ResourceId입니다.
value	Value	내보낸 API 세부 정보의 스키마를 정의하는 개체입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

ExportApi

API 세부 정보를 내보내는 데 필요한 쿼리 매개 변수입니다.

Name	형식	Description
true	string

ExportFormat

5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보낼 형식입니다.

Name	형식	Description
openapi+json-link	string	OpenAPI 3.0 사양의 API 정의를 JSON 문서로 Storage Blob으로 내보냅니다.
openapi-link	string	OpenAPI 3.0 사양의 API 정의를 YAML 문서로 스토리지 Blob으로 내보냅니다.
swagger-link	string	OpenAPI 2.0 사양의 API 정의를 JSON 문서로 스토리지 Blob으로 내보냅니다.
wadl-link	string	WADL 스키마의 Api 정의를 Storage Blob으로 내보냅니다.
wsdl-link	string	WSDL 스키마의 Api 정의를 Storage Blob으로 내보냅니다. 이는 형식의 API에 대해서만 지원됩니다. `soap`

ExportResultFormat

5분 동안 유효한 Sas 키를 사용하여 API 세부 정보를 스토리지 Blob으로 내보내는 형식입니다.

Name	형식	Description
openapi-link	string	OpenAPI 사양 3.0의 API 정의를 Storage Blob으로 내보냅니다.
swagger-link-json	string	API 정의는 OpenAPI 사양 2.0 형식으로 Storage Blob으로 내보내집니다.
wadl-link-json	string	WADL 스키마의 API 정의를 스토리지 Blob으로 내보냅니다.
wsdl-link+xml	string	API 정의는 WSDL 스키마에서 스토리지 Blob으로 내보내집니다. 이는 형식의 API에 대해서만 지원됩니다. `soap`

Value

내보낸 API 세부 정보의 스키마를 정의하는 개체입니다.

Name	형식	Description
link	string	내보내기 작업의 결과를 포함하는 Storage Blob에 연결합니다. Blob Uri는 5분 동안만 유효합니다.

Api Export - Get

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

ApiManagementGetApiExportInOpenApi2dot0

Sample Request

Sample Response

ApiManagementGetApiExportInOpenApi3dot0

Sample Request

Sample Response

정의

ApiExportResult

ErrorFieldContract

ErrorResponse

ExportApi

ExportFormat

ExportResultFormat

Value

추가 리소스