Api Revision - List By Service

Serviço:

API Management

Versão da API:

2021-08-01

Lista todas as revisões de uma API.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/revisions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiId	path	True	string	Identificador de API. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.
$filter	query		string	| Campo | Utilização | Operadores suportados | Funções suportadas | |-------------|-------------|-------------|-------------| | apiRevision | filtro | ge, le, eq, ne, gt, lt | subcadeia, contém, começa com, termina com |
$skip	query		integer int32	Número de registos a ignorar.
$top	query		integer int32	Número de registos a devolver.

Respostas

Name	Tipo	Description
200 OK	ApiRevisionCollection	A operação devolve uma lista de detalhes de revisão.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementListApiRevisions

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/revisions?api-version=2021-08-01

Java

import com.azure.core.util.Context;

/** Samples for ApiRevision ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiRevisions.json
     */
    /**
     * Sample code: ApiManagementListApiRevisions.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApiRevisions(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiRevisions()
            .listByService("rg1", "apimService1", "57d2ef278aa04f0888cba3f3", null, null, null, 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_api_revisions.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_revision.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d2ef278aa04f0888cba3f3",
    )
    for item in response:
        print(item)


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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiRevisions.json
func ExampleAPIRevisionClient_NewListByServicePager() {
	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)
	}
	pager := clientFactory.NewAPIRevisionClient().NewListByServicePager("rg1", "apimService1", "57d2ef278aa04f0888cba3f3", &armapimanagement.APIRevisionClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APIRevisionCollection = armapimanagement.APIRevisionCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.APIRevisionContract{
		// 		{
		// 			APIID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1"),
		// 			APIRevision: to.Ptr("1"),
		// 			CreatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T22:21:20.467Z"); return t}()),
		// 			IsCurrent: to.Ptr(true),
		// 			IsOnline: to.Ptr(true),
		// 			UpdatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T22:21:20.467Z"); return t}()),
		// 	}},
		// }
	}
}

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 Lists all revisions of an API.
 *
 * @summary Lists all revisions of an API.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiRevisions.json
 */
async function apiManagementListApiRevisions() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d2ef278aa04f0888cba3f3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiRevision.listByService(resourceGroupName, serviceName, apiId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiRevisions.json
// this example is just showing the usage of "ApiRevision_ListByService" 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 ApiResource created on azure
// for more information of creating ApiResource, please refer to the document of ApiResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "57d2ef278aa04f0888cba3f3";
ResourceIdentifier apiResourceId = ApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ApiResource api = client.GetApiResource(apiResourceId);

// invoke the operation and iterate over the result
await foreach (ApiRevisionContract item in api.GetApiRevisionsByServiceAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1",
      "apiRevision": "1",
      "createdDateTime": "2018-02-01T22:21:20.467Z",
      "updatedDateTime": "2018-02-01T22:21:20.467Z",
      "isOnline": true,
      "isCurrent": true
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definições

Name	Description
ApiRevisionCollection	Representação da lista de Revisão da API Paginada.
ApiRevisionContract	Resumo dos metadados de revisão.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.

ApiRevisionCollection

Representação da lista de Revisão da API Paginada.

Name	Tipo	Description
count	integer	Número total de contagem de registos em todas as páginas.
nextLink	string	Ligação da página seguinte, se existir.
value	ApiRevisionContract[]	Valores de página.

ApiRevisionContract

Resumo dos metadados de revisão.

Name	Tipo	Description
apiId	string	Identificador da Revisão da API.
apiRevision	string	Número de revisão da API.
createdDateTime	string	A hora em que a Revisão da API foi criada. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ, conforme especificado pela norma ISO 8601.
description	string	Descrição da Revisão da API.
isCurrent	boolean	Indica se a revisão da API está acessível através do gateway.
isOnline	boolean	Indica se a revisão da API é a revisão atual da API.
privateUrl	string	URL do gateway para aceder à Revisão da API não atual.
updatedDateTime	string	A hora em que a Revisão da API foi atualizada. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ, conforme especificado pela norma ISO 8601.

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.