Apis - Get
Obtiene los detalles de la API especificada por su identificador.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
api
|
path | True |
string |
Identificador de revisión de API. Debe ser único en la instancia de servicio de API Management actual. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión. Regex pattern: |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
El cuerpo de la respuesta contiene la entidad de API especificada. Headers ETag: string |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Api |
Api |
ApiManagementGetApiContract
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
"type": "Microsoft.ApiManagement/service/apis",
"name": "57d1f7558aa04f15146d9d8a",
"properties": {
"displayName": "Service",
"apiRevision": "1",
"serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
"path": "schulte",
"protocols": [
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key"
},
"type": "soap",
"isCurrent": true,
"isOnline": true
}
}
ApiManagementGetApiRevisionContract
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
"type": "Microsoft.ApiManagement/service/apis",
"name": "echo-api;rev=3",
"properties": {
"displayName": "Service",
"apiRevision": "3",
"serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
"path": "schulte",
"protocols": [
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key"
},
"apiRevisionDescription": "fixed bug in contract"
}
}
Definiciones
Nombre | Description |
---|---|
Api |
Información de contacto de API |
Api |
Detalles de la API. |
Api |
Información de licencia de API |
Api |
Tipo de API. |
Api |
Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas |
Authentication |
Configuración de autenticación de API. |
bearer |
Cómo enviar el token al servidor. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
OAuth2Authentication |
Detalles de la configuración de autenticación de OAuth2 de API. |
Open |
Detalles de la configuración de autenticación de OAuth2 de API. |
Protocol |
Describe en qué protocolos se pueden invocar las operaciones en esta API. |
Subscription |
Detalles de los nombres de parámetro de clave de suscripción. |
versioning |
Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. |
ApiContactInformation
Información de contacto de API
Nombre | Tipo | Description |
---|---|---|
string |
Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico. |
|
name |
string |
El nombre de identificación de la persona o organización de contacto |
url |
string |
Dirección URL que apunta a la información de contacto. DEBE tener el formato de una dirección URL. |
ApiContract
Detalles de la API.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso. |
properties.apiRevision |
string |
Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión predeterminada 1. |
properties.apiRevisionDescription |
string |
Descripción de la revisión de la API. |
properties.apiVersion |
string |
Indica el identificador de versión de la API si la API tiene versiones |
properties.apiVersionDescription |
string |
Descripción de la versión de la API. |
properties.apiVersionSet |
Detalles del conjunto de versiones |
|
properties.apiVersionSetId |
string |
Identificador de recurso para apiVersionSet relacionado. |
properties.authenticationSettings |
Recopilación de la configuración de autenticación incluida en esta API. |
|
properties.contact |
Información de contacto de la API. |
|
properties.description |
string |
Descripción de la API. Puede incluir etiquetas de formato HTML. |
properties.displayName |
string |
Nombre de la API. Debe tener entre 1 y 300 caracteres. |
properties.isCurrent |
boolean |
Indica si la revisión de API es la revisión de API actual. |
properties.isOnline |
boolean |
Indica si se puede acceder a la revisión de la API a través de la puerta de enlace. |
properties.license |
Información de licencia de la API. |
|
properties.path |
string |
Dirección URL relativa que identifica de forma única esta API y todas las rutas de acceso a sus recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API que se especificó durante la creación de la instancia de servicio para formar una dirección URL pública para esta API. |
properties.protocols |
Protocol[] |
Describe en qué protocolos se pueden invocar las operaciones en esta API. |
properties.serviceUrl |
string |
Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres de longitud. |
properties.sourceApiId |
string |
Identificador de API de la API de origen. |
properties.subscriptionKeyParameterNames |
Protocolos sobre los que está disponible la API. |
|
properties.subscriptionRequired |
boolean |
Especifica si se requiere una api o una suscripción de producto para acceder a la API. |
properties.termsOfServiceUrl |
string |
Dirección URL a los Términos de servicio de la API. DEBE tener el formato de una dirección URL. |
properties.type |
Tipo de API. |
|
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ApiLicenseInformation
Información de licencia de API
Nombre | Tipo | Description |
---|---|---|
name |
string |
Nombre de licencia usado para la API |
url |
string |
Dirección URL de la licencia usada para la API. DEBE tener el formato de una dirección URL. |
ApiType
Tipo de API.
Nombre | Tipo | Description |
---|---|---|
graphql |
string |
|
http |
string |
|
soap |
string |
|
websocket |
string |
ApiVersionSetContractDetails
Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas
Nombre | Tipo | Description |
---|---|---|
description |
string |
Descripción del conjunto de versiones de API. |
id |
string |
Identificador del conjunto de versiones de API existente. Omita este valor para crear un nuevo conjunto de versiones. |
name |
string |
Nombre para mostrar del conjunto de versiones de la API. |
versionHeaderName |
string |
Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido |
versionQueryName |
string |
Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido |
versioningScheme |
Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. |
AuthenticationSettingsContract
Configuración de autenticación de API.
Nombre | Tipo | Description |
---|---|---|
oAuth2 |
Configuración de autenticación de OAuth2 |
|
oAuth2AuthenticationSettings |
Colección de la configuración de autenticación de OAuth2 incluida en esta API. |
|
openid |
Configuración de autenticación de OpenID Connect |
|
openidAuthenticationSettings |
Recopilación de la configuración de autenticación de Open ID Connect incluida en esta API. |
bearerTokenSendingMethods
Cómo enviar el token al servidor.
Nombre | Tipo | Description |
---|---|---|
authorizationHeader |
string |
El token de acceso se transmitirá en el encabezado de autorización mediante el esquema de portador. |
query |
string |
El token de acceso se transmitirá como parámetros de consulta. |
ErrorFieldContract
Contrato de campo de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error de nivel de propiedad. |
message |
string |
Representación legible del error de nivel de propiedad. |
target |
string |
Nombre de propiedad. |
ErrorResponse
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error.code |
string |
Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta. |
error.details |
La lista de campos no válidos que se envían en la solicitud, en caso de error de validación. |
|
error.message |
string |
Representación legible del error. |
OAuth2AuthenticationSettingsContract
Detalles de la configuración de autenticación de OAuth2 de API.
Nombre | Tipo | Description |
---|---|---|
authorizationServerId |
string |
Identificador del servidor de autorización de OAuth. |
scope |
string |
ámbito de operaciones. |
OpenIdAuthenticationSettingsContract
Detalles de la configuración de autenticación de OAuth2 de API.
Nombre | Tipo | Description |
---|---|---|
bearerTokenSendingMethods |
Cómo enviar el token al servidor. |
|
openidProviderId |
string |
Identificador del servidor de autorización de OAuth. |
Protocol
Describe en qué protocolos se pueden invocar las operaciones en esta API.
Nombre | Tipo | Description |
---|---|---|
http |
string |
|
https |
string |
|
ws |
string |
|
wss |
string |
SubscriptionKeyParameterNamesContract
Detalles de los nombres de parámetro de clave de suscripción.
Nombre | Tipo | Description |
---|---|---|
header |
string |
Nombre del encabezado de clave de suscripción. |
query |
string |
Nombre del parámetro de la cadena de consulta de clave de suscripción. |
versioningScheme
Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.
Nombre | Tipo | Description |
---|---|---|
Header |
string |
La versión de la API se pasa en un encabezado HTTP. |
Query |
string |
La versión de la API se pasa en un parámetro de consulta. |
Segment |
string |
La versión de la API se pasa en un segmento de ruta de acceso. |