Gateway Hostname Configuration - List By Service

  • Referencia
Service:
API Management
API Version:
2022-08-01

Muestra la colección de configuraciones de nombre de host para la puerta de enlace especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
gatewayId
 path True

string

Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio de API Management actual. No debe tener el valor "administrado".
resourceGroupName
 path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName
 path True

string

Nombre del servicio API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 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.
$filter
 query

string

| Campo | Uso | Operadores admitidos | Funciones admitidas |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| nombre de host | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

Número de registros que se van a omitir.
$top
 query

integer

int32

Número de registros que se va a devolver.

Respuestas

Nombre Tipo Description
200 OK

GatewayHostnameConfigurationCollection

Colección de entidades de configuración de nombre de host.
Other Status Codes

ErrorResponse

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

ApiManagementListGatewayHostnameConfigurations

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "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
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/hostname1",
      "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
      "name": "default",
      "properties": {
        "hostname": "foo.bar.com",
        "certificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert2",
        "negotiateClientCertificate": true
      }
    }
  ],
  "nextLink": ""
}

Definiciones

Nombre Description
ErrorFieldContract

Contrato de campo de error.
ErrorResponse

Respuesta de error.
GatewayHostnameConfigurationCollection

Representación de la lista de configuración de nombre de host de puerta de enlace paginada.
GatewayHostnameConfigurationContract

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

ErrorFieldContract[]

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.

GatewayHostnameConfigurationCollection

Representación de la lista de configuración de nombre de host de puerta de enlace paginada.

Nombre Tipo Description
nextLink

string

Vínculo de página siguiente, si existe.
value

GatewayHostnameConfigurationContract[]

Valores de página.

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 la 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"