Api Version Set - Get

Servicio:

API Management

Versión de la API:

2024-05-01

Obtiene los detalles del conjunto de versiones de api especificado por su 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 identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador del conjunto de versiones de api. Debe ser único en la instancia actual del servicio API Management.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ApiVersionSetContract	Obtiene la entidad conjunto de versiones de API especificada. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementGetApiVersionSet

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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"
  }
}

Definiciones

Nombre	Description
ApiVersionSetContract	Detalles del contrato del conjunto de versiones de API.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP.

ApiVersionSetContract

Object

Detalles del contrato del conjunto de versiones de API.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.description	string	Descripción del conjunto de versiones de API.
properties.displayName	string minLength: 1 maxLength: 100	Nombre del conjunto de versiones de API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query.
properties.versioningScheme	versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

versioningScheme

Enumeración

Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP.

Valor	Description
Header	La versión de LA API se pasa en un encabezado HTTP.
Query	La versión de LA API se pasa en un parámetro de consulta.
Segment	La versión de la API se pasa en un segmento de ruta de acceso.