Workspace Api - Update

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Actualiza la API especificada del área de trabajo en una instancia del servicio API Management.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.
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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador del área de trabajo. 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.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.
properties.apiRevisionDescription	string maxLength: 256	Descripción de la revisión de API.
properties.apiVersion	string maxLength: 100	Indica el identificador de versión de la API si la API tiene versiones
properties.apiVersionDescription	string maxLength: 256	Descripción de la versión de la API.
properties.apiVersionSetId	string	Identificador de recurso para apiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Colección de opciones de configuración de autenticación incluidas en esta API.
properties.contact	ApiContactInformation	Información de contacto de la API.
properties.description	string	Descripción de la API. Puede incluir etiquetas de formato HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nombre de LA API.
properties.isCurrent	boolean	Indica si la revisión de API es la revisión de API actual.
properties.license	ApiLicenseInformation	Información de licencia de la API.
properties.path	string minLength: 0 maxLength: 400	Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada 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 de esta API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Dirección URL absoluta del servicio back-end que implementa esta API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre los que está disponible la API.
properties.subscriptionRequired	boolean	Especifica si se requiere una suscripción de API o Producto para acceder a la API.
properties.termsOfServiceUrl	string	Una dirección URL a los Términos del servicio para la API. DEBE estar en el formato de una dirección URL.
properties.type	ApiType	Tipo de API.

Respuestas

Nombre	Tipo	Description
200 OK	ApiContract	La API se actualizó correctamente. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

ApiContract

La API se actualizó correctamente.

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

ApiManagementUpdateWorkspaceApi

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api?api-version=2024-05-01


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Definiciones

Nombre	Description
ApiContactInformation	Información de contacto de API
ApiContract	Detalles de la API.
ApiLicenseInformation	Información de licencia de API
ApiType	Tipo de API.
ApiUpdateContract	Detalles del contrato de actualización de API.
ApiVersionSetContractDetails	Un conjunto de versiones de API contiene la configuración común de un conjunto de versiones de API relacionadas.
AuthenticationSettingsContract	Configuración de autenticación de API.
bearerTokenSendingMethods	Cómo enviar el token al servidor.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
OAuth2AuthenticationSettingsContract	Detalles de la configuración de autenticación de OAuth2 de API.
OpenIdAuthenticationSettingsContract	Detalles de la configuración de autenticación de OAuth2 de API.
Protocol	Describe en qué protocolos se pueden invocar las operaciones de esta API.
SubscriptionKeyParameterNamesContract	Detalles de los nombres de parámetro 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.

ApiContactInformation

Object

Información de contacto de API

Nombre	Tipo	Description
email	string	Dirección de correo electrónico de la persona o organización de contacto. DEBE estar en el formato de una dirección de correo electrónico.
name	string	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 estar en el formato de una dirección URL.

ApiContract

Object

Detalles de la 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.apiRevision	string minLength: 1 maxLength: 100	Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.
properties.apiRevisionDescription	string maxLength: 256	Descripción de la revisión de API.
properties.apiVersion	string maxLength: 100	Indica el identificador de versión de la API si la API tiene versiones
properties.apiVersionDescription	string maxLength: 256	Descripción de la versión de la API.
properties.apiVersionSet	ApiVersionSetContractDetails	Detalles del conjunto de versiones
properties.apiVersionSetId	string	Identificador de recurso para apiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Colección de opciones de configuración de autenticación incluidas en esta API.
properties.contact	ApiContactInformation	Información de contacto de la API.
properties.description	string	Descripción de la API. Puede incluir etiquetas de formato HTML.
properties.displayName	string minLength: 1 maxLength: 300	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 la revisión de API es accesible a través de la puerta de enlace.
properties.license	ApiLicenseInformation	Información de licencia de la API.
properties.path	string minLength: 0 maxLength: 400	Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada 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 de esta API.
properties.provisioningState	string	Estado de aprovisionamiento
properties.serviceUrl	string minLength: 0 maxLength: 2000	Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.
properties.sourceApiId	string	Identificador de API de la API de origen.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre los que está disponible la API.
properties.subscriptionRequired	boolean	Especifica si se requiere una suscripción de API o Producto para acceder a la API.
properties.termsOfServiceUrl	string	Una dirección URL a los Términos del servicio para la API. DEBE estar en el formato de una dirección URL.
properties.type	ApiType	Tipo de API.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

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 estar en el formato de una dirección URL.

ApiType

Enumeración

Tipo de API.

Valor	Description
graphql
grpc
http
odata
soap
websocket

ApiUpdateContract

Object

Detalles del contrato de actualización de API.

Nombre	Tipo	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.
properties.apiRevisionDescription	string maxLength: 256	Descripción de la revisión de API.
properties.apiVersion	string maxLength: 100	Indica el identificador de versión de la API si la API tiene versiones
properties.apiVersionDescription	string maxLength: 256	Descripción de la versión de la API.
properties.apiVersionSetId	string	Identificador de recurso para apiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Colección de opciones de configuración de autenticación incluidas en esta API.
properties.contact	ApiContactInformation	Información de contacto de la API.
properties.description	string	Descripción de la API. Puede incluir etiquetas de formato HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nombre de LA API.
properties.isCurrent	boolean	Indica si la revisión de API es la revisión de API actual.
properties.isOnline	boolean	Indica si la revisión de API es accesible a través de la puerta de enlace.
properties.license	ApiLicenseInformation	Información de licencia de la API.
properties.path	string minLength: 0 maxLength: 400	Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada 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 de esta API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Dirección URL absoluta del servicio back-end que implementa esta API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre los que está disponible la API.
properties.subscriptionRequired	boolean	Especifica si se requiere una suscripción de API o Producto para acceder a la API.
properties.termsOfServiceUrl	string	Una dirección URL a los Términos del servicio para la API. DEBE estar en el formato de una dirección URL.
properties.type	ApiType	Tipo de API.

ApiVersionSetContractDetails

Object

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 API si versioningScheme está establecido en `header`.
versionQueryName	string	Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en `query`.
versioningScheme	versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP.

AuthenticationSettingsContract

Object

Configuración de autenticación de API.

Nombre	Tipo	Description
oAuth2	OAuth2AuthenticationSettingsContract	Configuración de autenticación de OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Colección de la configuración de autenticación de OAuth2 incluida en esta API.
openid	OpenIdAuthenticationSettingsContract	Configuración de autenticación de OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Colección de la configuración de autenticación de Open ID Connect incluida en esta API.

bearerTokenSendingMethods

Enumeración

Cómo enviar el token al servidor.

Valor	Description
authorizationHeader	El token de acceso se transmitirá en el encabezado de autorización mediante el esquema de portador
query	El token de acceso se transmitirá como parámetros de consulta.

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.

OAuth2AuthenticationSettingsContract

Object

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

Object

Detalles de la configuración de autenticación de OAuth2 de API.

Nombre	Tipo	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Cómo enviar el token al servidor.
openidProviderId	string	Identificador del servidor de autorización de OAuth.

Protocol

Enumeración

Describe en qué protocolos se pueden invocar las operaciones de esta API.

Valor	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Detalles de los nombres de parámetro 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

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.

Compartir a través de

Workspace Api - Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementUpdateWorkspaceApi

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

Recursos adicionales