Udostępnij przez

Gateway Hostname Configuration - Create Or Update

Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Tworzy konfigurację nazwy hosta aktualizacji dla bramy.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/hostnameConfigurations/{hcId}?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
gatewayId
 path True

string

minLength: 1
maxLength: 80

Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
hcId
 path True

string

minLength: 1
maxLength: 80

Identyfikator konfiguracji nazwy hosta bramy. Musi być unikatowa w zakresie nadrzędnej jednostki bramy.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nazwa usługi API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa Typ Opis
properties.certificateId

string

Identyfikator jednostki certyfikatu, która będzie używana do ustanowienia połączenia TLS
properties.hostname

string

Wartość nazwy hosta. Obsługuje prawidłową nazwę domeny, częściowe lub pełne symbole wieloznaczne
properties.http2Enabled

boolean

Określa, czy protokół HTTP/2.0 jest obsługiwany
properties.negotiateClientCertificate

boolean

Określa, czy brama żąda certyfikatu klienta
properties.tls10Enabled

boolean

Określa, czy protokół TLS 1.0 jest obsługiwany
properties.tls11Enabled

boolean

Określa, czy protokół TLS 1.1 jest obsługiwany

Odpowiedzi

Nazwa Typ Opis
200 OK

GatewayHostnameConfigurationContract

Szczegóły konfiguracji nazwy hosta bramy zostały pomyślnie zaktualizowane.

Nagłówki

ETag: string
201 Created

GatewayHostnameConfigurationContract

Nowa konfiguracja nazwy hosta bramy została pomyślnie utworzona.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementCreateGatewayHostnameConfiguration

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default?api-version=2024-05-01

{
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Przykładowa odpowiedź

Kod stanu:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}
Kod stanu:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/hostnameConfigurations/default",
  "type": "Microsoft.ApiManagement/service/gateways/hostnameConfigurations",
  "name": "default",
  "properties": {
    "hostname": "*",
    "certificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
    "negotiateClientCertificate": false,
    "tls10Enabled": false,
    "tls11Enabled": false,
    "http2Enabled": true
  }
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
GatewayHostnameConfigurationContract

Szczegóły konfiguracji nazwy hosta bramy.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

GatewayHostnameConfigurationContract

Objekt

Szczegóły konfiguracji nazwy hosta bramy.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.certificateId

string

Identyfikator jednostki certyfikatu, która będzie używana do ustanowienia połączenia TLS
properties.hostname

string

Wartość nazwy hosta. Obsługuje prawidłową nazwę domeny, częściowe lub pełne symbole wieloznaczne
properties.http2Enabled

boolean

Określa, czy protokół HTTP/2.0 jest obsługiwany
properties.negotiateClientCertificate

boolean

Określa, czy brama żąda certyfikatu klienta
properties.tls10Enabled

boolean

Określa, czy protokół TLS 1.0 jest obsługiwany
properties.tls11Enabled

boolean

Określa, czy protokół TLS 1.1 jest obsługiwany
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"