Api Version Set - Create Or Update
Crea o actualiza un conjunto de versiones de API
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
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. |
version
|
path | True |
string |
Identificador del conjunto de versiones de api. Debe ser único en la instancia de servicio API Management actual. Regex pattern: |
api-version
|
query | True |
string |
Versión de API que se usará para la 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 necesario al actualizar una entidad. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
properties.displayName | True |
string |
Nombre del conjunto de versiones de API |
properties.versioningScheme | True |
Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP. |
|
properties.description |
string |
Descripción del conjunto de versiones de API. |
|
properties.versionHeaderName |
string |
Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido |
|
properties.versionQueryName |
string |
Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
El conjunto de versiones de api se actualizó correctamente. Headers ETag: string |
|
201 Created |
El conjunto de versiones de api se creó correctamente. 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
ApiManagementCreateApiVersionSet
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1?api-version=2022-08-01
{
"properties": {
"displayName": "api set 1",
"versioningScheme": "Segment",
"description": "Version configuration"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
"type": "Microsoft.ApiManagement/service/api-version-sets",
"name": "api1",
"properties": {
"displayName": "api set 1",
"versioningScheme": "Segment",
"description": "Version configuration"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/api1",
"type": "Microsoft.ApiManagement/service/api-version-sets",
"name": "api1",
"properties": {
"displayName": "api set 1",
"versioningScheme": "Segment",
"description": "Version configuration"
}
}
Definiciones
Nombre | Description |
---|---|
Api |
Detalles del contrato del conjunto de versiones de LA API. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
versioning |
Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP. |
ApiVersionSetContract
Detalles del contrato del conjunto de versiones 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.description |
string |
Descripción del conjunto de versiones de API. |
properties.displayName |
string |
Nombre del conjunto de versiones de API |
properties.versionHeaderName |
string |
Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido |
properties.versionQueryName |
string |
Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en |
properties.versioningScheme |
Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP. |
|
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
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. |
versioningScheme
Valor que determina dónde se ubicará el identificador de la versión de 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. |