Gateway Hostname Configuration - Create Or Update
Crea una configuración de nombre de host de actualizaciones para una puerta de enlace.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado". |
hc
|
path | True |
string |
Identificador de configuración de nombre de host de puerta de enlace. Debe ser único en el ámbito de la entidad de puerta de enlace primaria. |
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. |
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 | Tipo | Description |
---|---|---|
properties.certificateId |
string |
Identificador de entidad de certificado que se usará para el establecimiento de la conexión TLS |
properties.hostname |
string |
Valor de nombre de host. Admite el nombre de dominio válido, el carácter comodín parcial o completo. |
properties.http2Enabled |
boolean |
Especifica si se admite HTTP/2.0. |
properties.negotiateClientCertificate |
boolean |
Determina si la puerta de enlace solicita el certificado de cliente |
properties.tls10Enabled |
boolean |
Especifica si se admite TLS 1.0. |
properties.tls11Enabled |
boolean |
Especifica si se admite TLS 1.1. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Los detalles de configuración del nombre de host de puerta de enlace se actualizaron correctamente. Headers ETag: string |
|
201 Created |
La nueva configuración de nombre de host de puerta de enlace 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
ApiManagementCreateGatewayHostnameConfiguration
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2022-08-01
{
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
"type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
"name": "default",
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
"type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
"name": "default",
"properties": {
"hostname": "*",
"certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"negotiateClientCertificate": false,
"tls10Enabled": false,
"tls11Enabled": false,
"http2Enabled": true
}
}
Definiciones
Nombre | Description |
---|---|
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Gateway |
Detalles de configuración del nombre de host de puerta de enlace. |
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. |
GatewayHostnameConfigurationContract
Detalles de configuración del nombre de host de puerta de enlace.
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.certificateId |
string |
Identificador de entidad de certificado que se usará para el establecimiento de la conexión TLS |
properties.hostname |
string |
Valor de nombre de host. Admite el nombre de dominio válido, el carácter comodín parcial o completo. |
properties.http2Enabled |
boolean |
Especifica si se admite HTTP/2.0. |
properties.negotiateClientCertificate |
boolean |
Determina si la puerta de enlace solicita el certificado de cliente |
properties.tls10Enabled |
boolean |
Especifica si se admite TLS 1.0. |
properties.tls11Enabled |
boolean |
Especifica si se admite TLS 1.1. |
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |