Apis - Get

Serviço:

API Center

Versão da API:

2024-03-01

Retorna detalhes da API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName}?api-version=2024-03-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome da API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome do serviço do Centro de API do Azure.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
workspaceName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z0-9-]{3,90}$	O nome do espaço de trabalho.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	Api	A operação do Azure foi concluída com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Apis_Get

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api?api-version=2024-03-01

Java

/**
 * Samples for Apis Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json
     */
    /**
     * Sample code: Apis_Get.
     * 
     * @param manager Entry point to ApiCenterManager.
     */
    public static void apisGet(com.azure.resourcemanager.apicenter.ApiCenterManager manager) {
        manager.apis().getWithResponse("contoso-resources", "contoso", "default", "echo-api",
            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 azure.identity import DefaultAzureCredential
from azure.mgmt.apicenter import ApiCenterMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apicenter
# USAGE
    python apis_get.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.apis.get(
        resource_group_name="contoso-resources",
        service_name="contoso",
        workspace_name="default",
        api_name="echo-api",
    )
    print(response)


# x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.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 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/Apis_Get.json
func ExampleApisClient_Get() {
	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)
	}
	res, err := clientFactory.NewApisClient().Get(ctx, "contoso-resources", "contoso", "default", "echo-api", 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.API = armapicenter.API{
	// 	Name: to.Ptr("public"),
	// 	Type: to.Ptr("Microsoft.ApiCenter/services/apis"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api"),
	// 	SystemData: &armapicenter.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-03T18:27:09.128Z"); return t}()),
	// 	},
	// 	Properties: &armapicenter.APIProperties{
	// 		Description: to.Ptr("A simple HTTP request/response service."),
	// 		CustomProperties: map[string]any{
	// 			"author": "John Doe",
	// 		},
	// 		ExternalDocumentation: []*armapicenter.ExternalDocumentation{
	// 			{
	// 				Title: to.Ptr("Onboarding docs"),
	// 				URL: to.Ptr("https://docs.contoso.com"),
	// 		}},
	// 		Kind: to.Ptr(armapicenter.APIKindRest),
	// 		License: &armapicenter.License{
	// 			URL: to.Ptr("https://contoso.com/license"),
	// 		},
	// 		LifecycleStage: to.Ptr(armapicenter.LifecycleStageDesign),
	// 		TermsOfService: &armapicenter.TermsOfService{
	// 			URL: to.Ptr("https://contoso.com/terms-of-service"),
	// 		},
	// 		Title: to.Ptr("Echo API"),
	// 	},
	// }
}

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 { AzureAPICenter } = require("@azure/arm-apicenter");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns details of the API.
 *
 * @summary Returns details of the API.
 * x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json
 */
async function apisGet() {
  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 credential = new DefaultAzureCredential();
  const client = new AzureAPICenter(credential, subscriptionId);
  const result = await client.apis.get(resourceGroupName, serviceName, workspaceName, apiName);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiCenter;

// Generated from example definition: specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/examples/Apis_Get.json
// this example is just showing the usage of "Apis_Get" 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 ApiCenterApiResource created on azure
// for more information of creating ApiCenterApiResource, please refer to the document of ApiCenterApiResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso-resources";
string serviceName = "contoso";
string workspaceName = "default";
string apiName = "echo-api";
ResourceIdentifier apiCenterApiResourceId = ApiCenterApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, workspaceName, apiName);
ApiCenterApiResource apiCenterApi = client.GetApiCenterApiResource(apiCenterApiResourceId);

// invoke the operation
ApiCenterApiResource result = await apiCenterApi.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiCenterApiData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:

200

{
  "type": "Microsoft.ApiCenter/services/apis",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/workspaces/default/apis/echo-api",
  "name": "public",
  "systemData": {
    "createdAt": "2023-07-03T18:27:09.128871Z",
    "lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
  },
  "properties": {
    "title": "Echo API",
    "description": "A simple HTTP request/response service.",
    "lifecycleStage": "design",
    "kind": "rest",
    "termsOfService": {
      "url": "https://contoso.com/terms-of-service"
    },
    "license": {
      "url": "https://contoso.com/license"
    },
    "externalDocumentation": [
      {
        "title": "Onboarding docs",
        "url": "https://docs.contoso.com"
      }
    ],
    "customProperties": {
      "author": "John Doe"
    }
  }
}

Definições

Nome	Description
Api	Entidade de API.
ApiKind	O tipo da API
Contact	Informações de contato
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExternalDocumentation	Documentação externa adicional para a API.
License	As informações de licença da API.
LifecycleStage	O estágio do ciclo de vida de desenvolvimento de API
systemData	Metadados relativos à criação e última modificação do recurso.
TermsOfService	Termos de serviço para a API.

Api

Objeto

Entidade de API.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.contacts	Contact[]	O conjunto de contatos
properties.customProperties	object	Propriedades personalizadas Os metadados personalizados definidos para entidades de catálogo de API.
properties.description	string maxLength: 1000	Descrição da API.
properties.externalDocumentation	ExternalDocumentation[]	O conjunto de documentação externa
properties.kind	ApiKind	Tipo de API. Por exemplo, REST ou GraphQL.
properties.license	License	As informações de licença da API.
properties.lifecycleStage	LifecycleStage	Estágio atual do ciclo de vida da API.
properties.summary	string maxLength: 200	Breve descrição da API.
properties.termsOfService	TermsOfService	Termos de serviço para a API.
properties.title	string minLength: 1 maxLength: 50	Título da API.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ApiKind

Enumeração

O tipo da API

Valor	Description
rest	Uma API de Transferência de Estado Representacional
graphql	Uma API de linguagem de consulta do Graph
grpc	Uma API gRPC
soap	Uma API SOAP
webhook	Gancho da Web
websocket	Soquete da Web

Contact

Objeto

Informações de contato

Nome	Tipo	Description
email	string maxLength: 100	Endereço de email do contato.
name	string maxLength: 100	Nome do contato.
url	string (uri) maxLength: 200	URL do contato.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExternalDocumentation

Objeto

Documentação externa adicional para a API.

Nome	Tipo	Description
description	string maxLength: 500	Descrição da documentação.
title	string maxLength: 50	Título da documentação.
url	string (uri) maxLength: 200	URL apontando para a documentação.

License

Objeto

As informações de licença da API.

Nome	Tipo	Description
identifier	string (uri) maxLength: 50	Informações de licença SPDX para a API. O campo identificador é mutuamente exclusivo do campo URL.
name	string maxLength: 100	Nome da licença.
url	string (uri) maxLength: 200	URL apontando para os detalhes da licença. O campo URL é mutuamente exclusivo do campo identificador.

LifecycleStage

Enumeração

O estágio do ciclo de vida de desenvolvimento de API

Valor	Description
design	estágio de design
development	estágio de desenvolvimento
testing	estágio de teste
preview	Na pré-visualização
production	Em produção
deprecated	estágio preterido
retired	Estágio desativado

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TermsOfService

Objeto

Termos de serviço para a API.

Nome	Tipo	Description
url	string (uri) maxLength: 200	URL apontando para os termos de serviço.