Workspace Api - Create Or Update
Crea una API especificada existente o actualiza la API existente del área de trabajo en una instancia del servicio API Management.
PUT 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 |
---|---|---|---|---|
api
|
path | True |
string minLength: 1maxLength: 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. |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Nombre del servicio API Management. |
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
workspace
|
path | True |
string minLength: 1maxLength: 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 |
string |
ETag de la entidad. No es necesario al crear una entidad, pero es necesaria al actualizar una entidad. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties.path | True |
string minLength: 0maxLength: 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. |
apiRevision |
string minLength: 1maxLength: 100 |
Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada. |
|
apiRevisionDescription |
string maxLength: 256 |
Descripción de la revisión de API. |
|
apiVersion |
string maxLength: 100 |
Indica el identificador de versión de la API si la API tiene versiones |
|
apiVersionDescription |
string maxLength: 256 |
Descripción de la versión de la API. |
|
apiVersionSetId |
string |
Identificador de recurso para apiVersionSet relacionado. |
|
authenticationSettings |
Colección de opciones de configuración de autenticación incluidas en esta API. |
||
contact |
Información de contacto de la API. |
||
description |
string |
Descripción de la API. Puede incluir etiquetas de formato HTML. |
|
isCurrent |
boolean |
Indica si la revisión de API es la revisión de API actual. |
|
license |
Información de licencia de la API. |
||
properties.apiType |
Tipo de API que se va a crear.
|
||
properties.apiVersionSet |
Detalles del conjunto de versiones |
||
properties.displayName |
string minLength: 1maxLength: 300 |
Nombre de LA API. Debe tener entre 1 y 300 caracteres. |
|
properties.format |
Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro |
||
properties.protocols |
Protocol[] |
Describe en qué protocolos se pueden invocar las operaciones de esta API. |
|
properties.serviceUrl |
string minLength: 0maxLength: 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.translateRequiredQueryParameters |
Estrategia de traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query' |
||
properties.value |
string |
Valor de contenido al importar una API. |
|
properties.wsdlSelector |
Criterios para limitar la importación de WSDL a un subconjunto del documento. |
||
subscriptionKeyParameterNames |
Protocolos sobre los que está disponible la API. |
||
subscriptionRequired |
boolean |
Especifica si se requiere una suscripción de API o Producto para acceder a la API. |
|
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. |
|
type |
Tipo de API. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La API se actualizó correctamente. Encabezados
|
|
201 Created |
La API se creó correctamente. Encabezados
|
|
Other Status Codes |
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
ApiManagementCreateWorkspaceApi
Solicitud de ejemplo
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-05-01
{
"properties": {
"description": "apidescription5200",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
},
"subscriptionKeyParameterNames": {
"header": "header4520",
"query": "query3037"
},
"displayName": "apiname1463",
"serviceUrl": "http://newechoapi.cloudapp.net/api",
"path": "newapiPath",
"protocols": [
"https",
"http"
]
}
}
Respuesta de muestra
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419",
"type": "Microsoft.ApiManagement/service/workspaces/apis",
"name": "apiid9419",
"properties": {
"displayName": "apiname1463",
"apiRevision": "1",
"description": "apidescription5200",
"serviceUrl": "http://newechoapi.cloudapp.net/api",
"path": "newapiPath",
"protocols": [
"http",
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
]
},
"subscriptionKeyParameterNames": {
"header": "header4520",
"query": "query3037"
},
"isCurrent": true,
"isOnline": true,
"provisioningState": "InProgress"
}
}
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/tempgroup?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/apiid9419",
"type": "Microsoft.ApiManagement/service/workspaces/apis",
"name": "apiid9419",
"properties": {
"displayName": "apiname1463",
"apiRevision": "1",
"description": "apidescription5200",
"serviceUrl": "http://newechoapi.cloudapp.net/api",
"path": "newapiPath",
"protocols": [
"http",
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
]
},
"subscriptionKeyParameterNames": {
"header": "header4520",
"query": "query3037"
},
"isCurrent": true,
"isOnline": true,
"provisioningState": "InProgress"
}
}
Definiciones
Nombre | Description |
---|---|
Api |
Información de contacto de API |
Api |
Detalles de la API. |
Api |
API Create or Update Parameters (Creación o actualización de parámetros de 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. |
Content |
Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del 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 de esta API. |
Soap |
Tipo de API que se va a crear.
|
Subscription |
Detalles de los nombres de parámetro clave de suscripción. |
Translate |
Estrategia de traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query' |
versioning |
Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP. |
Wsdl |
Criterios para limitar la importación de WSDL a un subconjunto del documento. |
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 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
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: 1maxLength: 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 |
Detalles del conjunto de versiones |
|
properties.apiVersionSetId |
string |
Identificador de recurso para apiVersionSet relacionado. |
properties.authenticationSettings |
Colección de opciones de configuración de autenticación incluidas 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 minLength: 1maxLength: 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 |
Información de licencia de la API. |
|
properties.path |
string minLength: 0maxLength: 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: 0maxLength: 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 |
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 |
Tipo de API. |
|
type |
string |
Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ApiCreateOrUpdateParameter
API Create or Update Parameters (Creación o actualización de parámetros de API).
Nombre | Tipo | Description |
---|---|---|
apiRevision |
string minLength: 1maxLength: 100 |
Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada. |
apiRevisionDescription |
string maxLength: 256 |
Descripción de la revisión de API. |
apiVersion |
string maxLength: 100 |
Indica el identificador de versión de la API si la API tiene versiones |
apiVersionDescription |
string maxLength: 256 |
Descripción de la versión de la API. |
apiVersionSetId |
string |
Identificador de recurso para apiVersionSet relacionado. |
authenticationSettings |
Colección de opciones de configuración de autenticación incluidas en esta API. |
|
contact |
Información de contacto de la API. |
|
description |
string |
Descripción de la API. Puede incluir etiquetas de formato HTML. |
isCurrent |
boolean |
Indica si la revisión de API es la revisión de API actual. |
isOnline |
boolean |
Indica si la revisión de API es accesible a través de la puerta de enlace. |
license |
Información de licencia de la API. |
|
properties.apiType |
Tipo de API que se va a crear.
|
|
properties.apiVersionSet |
Detalles del conjunto de versiones |
|
properties.displayName |
string minLength: 1maxLength: 300 |
Nombre de LA API. Debe tener entre 1 y 300 caracteres. |
properties.format |
Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro |
|
properties.path |
string minLength: 0maxLength: 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: 0maxLength: 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.translateRequiredQueryParameters |
Estrategia de traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query' |
|
properties.value |
string |
Valor de contenido al importar una API. |
properties.wsdlSelector |
Criterios para limitar la importación de WSDL a un subconjunto del documento. |
|
subscriptionKeyParameterNames |
Protocolos sobre los que está disponible la API. |
|
subscriptionRequired |
boolean |
Especifica si se requiere una suscripción de API o Producto para acceder a la API. |
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. |
type |
Tipo de API. |
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 estar en el formato de una dirección URL. |
ApiType
Tipo de API.
Valor | Description |
---|---|
graphql | |
grpc | |
http | |
odata | |
soap | |
websocket |
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 API si versioningScheme está establecido en |
versionQueryName |
string |
Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en |
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 |
Colección de la configuración de autenticación de Open ID Connect incluida en esta API. |
bearerTokenSendingMethods
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. |
ContentFormat
Formato del contenido en el que se va a importar la API. Se pueden agregar nuevos formatos en el futuro
Valor | Description |
---|---|
graphql-link |
El punto de conexión de GraphQL API hospedado en una dirección de Internet accesible públicamente. |
grpc |
El contenido está insertado y el tipo de contenido es un archivo protobuf gRPC. |
grpc-link |
El archivo protobuf gRPC se hospeda en una dirección de Internet accesible públicamente. |
odata |
El contenido está insertado y el tipo de contenido es un documento XML de OData. |
odata-link |
Documento de metadatos de OData hospedado en una dirección de Internet accesible públicamente. |
openapi |
El contenido está insertado y el tipo de contenido es un documento YAML de OpenAPI 3.0. |
openapi+json |
El contenido está insertado y el tipo de contenido es un documento JSON de OpenAPI 3.0. |
openapi+json-link |
El documento JSON de OpenAPI 3.0 se hospeda en una dirección de Internet accesible públicamente. |
openapi-link |
El documento YAML de OpenAPI 3.0 se hospeda en una dirección de Internet accesible públicamente. |
swagger-json |
El contenido está insertado y el tipo de contenido es un documento JSON de OpenAPI 2.0. |
swagger-link-json |
El documento JSON de OpenAPI 2.0 se hospeda en una dirección de Internet accesible públicamente. |
wadl-link-json |
El documento WADL se hospeda en una dirección de Internet accesible públicamente. |
wadl-xml |
El contenido está insertado y el tipo de contenido es un documento WADL. |
wsdl |
El contenido está insertado y el documento es un documento WSDL/Soap. |
wsdl-link |
El documento WSDL se hospeda en una dirección de Internet accesible públicamente. |
ErrorAdditionalInfo
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
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de 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 de esta API.
Valor | Description |
---|---|
http | |
https | |
ws | |
wss |
SoapApiType
Tipo de API que se va a crear.
-
http
crea una API REST -
soap
crea una API de paso a través de SOAP -
websocket
crea la API de websocket -
graphql
crea GraphQL API. Se pueden agregar nuevos tipos en el futuro.
Valor | Description |
---|---|
graphql |
Importa la API que tiene un front-end de GraphQL. |
grpc |
Importa la API que tiene un front-end gRPC. |
http |
Importa una API SOAP que tiene un front-end RESTful. |
odata |
Importa la API que tiene un front-end de OData. |
soap |
Importa la API SOAP que tiene un front-end SOAP. |
websocket |
Importa la API que tiene un front-end de Websocket. |
SubscriptionKeyParameterNamesContract
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. |
TranslateRequiredQueryParametersConduct
Estrategia de traducir los parámetros de consulta necesarios a los de plantilla. De forma predeterminada, tiene el valor "template". Valores posibles: 'template', 'query'
Valor | Description |
---|---|
query |
Deja los parámetros de consulta necesarios a medida que no están (no se realiza ninguna traducción). |
template |
Convierte los parámetros de consulta necesarios en los de plantilla. Es un valor predeterminado. |
versioningScheme
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. |
WsdlSelector
Criterios para limitar la importación de WSDL a un subconjunto del documento.
Nombre | Tipo | Description |
---|---|---|
wsdlEndpointName |
string |
Nombre de endpoint(port) que se va a importar desde WSDL |
wsdlServiceName |
string |
Nombre del servicio que se va a importar desde WSDL |