POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi/exportSpecification?api-version=2024-03-01
/**
* Samples for ApiDefinitions ExportSpecification.
*/
public final class Main {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/
* ApiDefinitions_ExportSpecification.json
*/
/**
* Sample code: ApiDefinitions_ExportSpecification.
*
* @param manager Entry point to ApiCenterManager.
*/
public static void apiDefinitionsExportSpecification(com.azure.resourcemanager.apicenter.ApiCenterManager manager) {
manager.apiDefinitions().exportSpecification("contoso-resources", "contoso", "default", "echo-api",
"2023-01-01", "openapi", 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.apicenter import ApiCenterMgmtClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apicenter
# USAGE
python api_definitions_export_specification.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 = ApiCenterMgmtClient(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.api_definitions.begin_export_specification(
resource_group_name="contoso-resources",
service_name="contoso",
workspace_name="default",
api_name="echo-api",
version_name="2023-01-01",
definition_name="openapi",
).result()
print(response)
# x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.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 armapicenter_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json
func ExampleAPIDefinitionsClient_BeginExportSpecification() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapicenter.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewAPIDefinitionsClient().BeginExportSpecification(ctx, "contoso-resources", "contoso", "default", "echo-api", "2023-01-01", "openapi", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %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.APISpecExportResult = armapicenter.APISpecExportResult{
// Format: to.Ptr(armapicenter.APISpecExportResultFormatInline),
// Value: to.Ptr("{ ... }"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AzureAPICenter } = require("@azure/arm-apicenter");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Exports the API specification.
*
* @summary Exports the API specification.
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json
*/
async function apiDefinitionsExportSpecification() {
const subscriptionId =
process.env["APICENTER_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const resourceGroupName = process.env["APICENTER_RESOURCE_GROUP"] || "contoso-resources";
const serviceName = "contoso";
const workspaceName = "default";
const apiName = "echo-api";
const versionName = "2023-01-01";
const definitionName = "openapi";
const credential = new DefaultAzureCredential();
const client = new AzureAPICenter(credential, subscriptionId);
const result = await client.apiDefinitions.beginExportSpecificationAndWait(
resourceGroupName,
serviceName,
workspaceName,
apiName,
versionName,
definitionName,
);
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiCenter.Models;
using Azure.ResourceManager.ApiCenter;
// Generated from example definition: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/ApiDefinitions_ExportSpecification.json
// this example is just showing the usage of "ApiDefinitions_ExportSpecification" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ApiCenterApiDefinitionResource created on azure
// for more information of creating ApiCenterApiDefinitionResource, please refer to the document of ApiCenterApiDefinitionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso-resources";
string serviceName = "contoso";
string workspaceName = "default";
string apiName = "echo-api";
string versionName = "2023-01-01";
string definitionName = "openapi";
ResourceIdentifier apiCenterApiDefinitionResourceId = ApiCenterApiDefinitionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, workspaceName, apiName, versionName, definitionName);
ApiCenterApiDefinitionResource apiCenterApiDefinition = client.GetApiCenterApiDefinitionResource(apiCenterApiDefinitionResourceId);
// invoke the operation
ArmOperation<ApiSpecExportResult> lro = await apiCenterApiDefinition.ExportSpecificationAsync(WaitUntil.Completed);
ApiSpecExportResult result = lro.Value;
Console.WriteLine($"Succeeded: {result}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue