Api Version Set - Get

Serviço:

API Management

Versão da API:

2024-05-01

Obtém os detalhes do Conjunto de Versões da API especificado por seu identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador do Conjunto de Versões da API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
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	ApiVersionSetContract	Obtém a entidade especificada do Conjunto de Versões da API. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

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

ApiManagementGetApiVersionSet

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2024-05-01

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "vs1",
  "properties": {
    "displayName": "Version Set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definições

Nome	Description
ApiVersionSetContract	Detalhes do Contrato do Conjunto de Versões da API.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.

ApiVersionSetContract

Objeto

Detalhes do Contrato do Conjunto de Versões da API.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.description	string	Descrição do Conjunto de Versões da API.
properties.displayName	string minLength: 1 maxLength: 100	Nome do Conjunto de Versões da API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Nome do parâmetro de cabeçalho HTTP que indica a versão da API se o versioningScheme estiver definido como header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query.
properties.versioningScheme	versioningScheme	Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

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.

versioningScheme

Enumeração

Um valor que determina onde o identificador de versão da API estará localizado em uma solicitação HTTP.

Valor	Description
Segment	A versão da API é passada em um segmento de caminho.
Query	A versão da API é passada em um parâmetro de consulta.
Header	A versão da API é passada em um cabeçalho HTTP.