Udostępnij za pośrednictwem

ApiManagementServiceBaseProperties interface

  • Odwołanie
Pakiet:
@azure/arm-apimanagement

Podstawowe właściwości opisu zasobu usługi API Management.

Właściwości

additionalLocations

Dodatkowe lokalizacje centrum danych usługi API Management.
apiVersionConstraint

Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management.
certificates

Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, to 10.
createdAtUtc

Tworzenie daty UTC usługi API Management. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
customProperties

Właściwości niestandardowe usługi API Management.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich protokołów TLS(1.0, 1.1 i 1.2).
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1 na potrzeby komunikacji z zapleczami.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 na potrzeby komunikacji z zapleczami.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 może służyć do włączania protokołu HTTP2 w usłudze API Management.
Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest wtedy True , gdy usługa została utworzona w dniu lub przed 1 kwietnia 2018 r. i False w inny sposób. Wartość domyślna ustawienia Http2 to False.

Można wyłączyć dowolne z następujących szyfrów przy użyciu ustawień Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Na przykład :Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false. Wartość domyślna to true dla nich.
Uwaga: nie można wyłączyć następujących szyfrów, ponieważ są one wymagane przez wewnętrzne składniki platformy: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
developerPortalUrl

Adres URL punktu końcowego portalu DEveloper usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
disableGateway

Właściwość jest prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym.
enableClientCertificate

Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to przedstawienie certyfikatu klienta na każdym żądaniu do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie.
gatewayRegionalUrl

Adres URL bramy usługi API Management w regionie domyślnym. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
gatewayUrl

Adres URL bramy usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
hostnameConfigurations

Niestandardowa konfiguracja nazwy hosta usługi API Management.
managementApiUrl

Adres URL punktu końcowego interfejsu API zarządzania usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
natGatewayState

Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.
notificationSenderEmail

Email adres, z którego zostanie wysłane powiadomienie.
outboundPublicIPAddresses

Wychodzące prefiksy publicznych adresów IPV4 skojarzone z wdrożonym usługą bramy translatora adresów sieciowych. Dostępne tylko dla jednostki SKU Premium na platformie stv2. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
platformVersion

Wersja platformy obliczeniowej z uruchomioną usługą w tej lokalizacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
portalUrl

Adres URL punktu końcowego portalu wydawcy usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
privateEndpointConnections

Lista połączeń prywatnego punktu końcowego tej usługi.
privateIPAddresses

Prywatne statyczne adresy IP usługi API Management w regionie podstawowym, które są wdrażane w wewnętrznym Virtual Network. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
provisioningState

Bieżący stan aprowizacji usługi API Management, który może być jednym z następujących elementów: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
publicIPAddresses

Publiczne statyczne adresy IP usługi API Management w regionie podstawowym. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
publicIpAddressId

Publiczny adres IP jednostki SKU w wersji 4, który ma być skojarzony z usługą wdrożona Virtual Network w regionie. Obsługiwane tylko w przypadku jednostek SKU developer i Premium wdrażanych w Virtual Network.
publicNetworkAccess

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są metodą wyłącznego dostępu. Wartość domyślna to "Włączone"
restore

Cofanie usuwania usługi Api Management, jeśli została wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane.
scmUrl

Adres URL punktu końcowego SCM usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
targetProvisioningState

Stan aprowizacji usługi API Management, która jest objęta długotrwałą operacją uruchomioną w usłudze. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
virtualNetworkConfiguration

Konfiguracja sieci wirtualnej usługi API Management.
virtualNetworkType

Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnego Virtual Network, zewnętrzne oznacza, że wdrożenie API Management jest skonfigurowane wewnątrz Virtual Network mającego punkt końcowy dostępny z Internetu, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane wewnątrz Virtual Network tylko z punktem końcowym dostępnym w intranecie.

Szczegóły właściwości

additionalLocations

Dodatkowe lokalizacje centrum danych usługi API Management.

additionalLocations?: AdditionalLocation[]

Wartość właściwości

AdditionalLocation[]

apiVersionConstraint

Ograniczenie wersji interfejsu API płaszczyzny sterowania dla usługi API Management.

apiVersionConstraint?: ApiVersionConstraint

Wartość właściwości

ApiVersionConstraint

certificates

Lista certyfikatów, które należy zainstalować w usłudze API Management. Maksymalna obsługiwana liczba obsługiwanych certyfikatów, które można zainstalować, to 10.

certificates?: CertificateConfiguration[]

Wartość właściwości

CertificateConfiguration[]

createdAtUtc

Tworzenie daty UTC usługi API Management. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ zgodnie z normą ISO 8601. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

createdAtUtc?: Date

Wartość właściwości

Date

customProperties

Właściwości niestandardowe usługi API Management.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 spowoduje wyłączenie TLS_RSA_WITH_3DES_EDE_CBC_SHA szyfrowania dla wszystkich protokołów TLS(1.0, 1.1 i 1.2).
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 w usłudze API Management.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 może służyć do wyłączania tylko protokołu TLS 1.1 na potrzeby komunikacji z zapleczami.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 może służyć do wyłączania protokołu TLS 1.0 na potrzeby komunikacji z zapleczami.
Ustawienie Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 może służyć do włączania protokołu HTTP2 w usłudze API Management.
Nie określono żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości pominiętych do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna jest wtedy True , gdy usługa została utworzona w dniu lub przed 1 kwietnia 2018 r. i False w inny sposób. Wartość domyślna ustawienia Http2 to False.

Można wyłączyć dowolne z następujących szyfrów przy użyciu ustawień Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Na przykład :Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256false. Wartość domyślna to true dla nich.
Uwaga: nie można wyłączyć następujących szyfrów, ponieważ są one wymagane przez wewnętrzne składniki platformy: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

customProperties?: {[propertyName: string]: string}

Wartość właściwości

{[propertyName: string]: string}

developerPortalUrl

Adres URL punktu końcowego portalu DEveloper usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

developerPortalUrl?: string

Wartość właściwości

string

disableGateway

Właściwość jest prawidłowa tylko dla usługi Api Management wdrożonej w wielu lokalizacjach. Może to służyć do wyłączania bramy w regionie głównym.

disableGateway?: boolean

Wartość właściwości

boolean

enableClientCertificate

Właściwość przeznaczona tylko do użycia w przypadku usługi SKU Zużycie. Wymusza to przedstawienie certyfikatu klienta na każdym żądaniu do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie.

enableClientCertificate?: boolean

Wartość właściwości

boolean

gatewayRegionalUrl

Adres URL bramy usługi API Management w regionie domyślnym. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

gatewayRegionalUrl?: string

Wartość właściwości

string

gatewayUrl

Adres URL bramy usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

gatewayUrl?: string

Wartość właściwości

string

hostnameConfigurations

Niestandardowa konfiguracja nazwy hosta usługi API Management.

hostnameConfigurations?: HostnameConfiguration[]

Wartość właściwości

HostnameConfiguration[]

managementApiUrl

Adres URL punktu końcowego interfejsu API zarządzania usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

managementApiUrl?: string

Wartość właściwości

string

natGatewayState

Właściwość może służyć do włączania bramy translatora adresów sieciowych dla tej usługi API Management.

natGatewayState?: string

Wartość właściwości

string

notificationSenderEmail

Email adres, z którego zostanie wysłane powiadomienie.

notificationSenderEmail?: string

Wartość właściwości

string

outboundPublicIPAddresses

Wychodzące prefiksy publicznych adresów IPV4 skojarzone z wdrożonym usługą bramy translatora adresów sieciowych. Dostępne tylko dla jednostki SKU Premium na platformie stv2. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

outboundPublicIPAddresses?: string[]

Wartość właściwości

string[]

platformVersion

Wersja platformy obliczeniowej z uruchomioną usługą w tej lokalizacji. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

platformVersion?: string

Wartość właściwości

string

portalUrl

Adres URL punktu końcowego portalu wydawcy usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

portalUrl?: string

Wartość właściwości

string

privateEndpointConnections

Lista połączeń prywatnego punktu końcowego tej usługi.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Wartość właściwości

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Prywatne statyczne adresy IP usługi API Management w regionie podstawowym, które są wdrażane w wewnętrznym Virtual Network. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

privateIPAddresses?: string[]

Wartość właściwości

string[]

provisioningState

Bieżący stan aprowizacji usługi API Management, który może być jednym z następujących elementów: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

provisioningState?: string

Wartość właściwości

string

publicIPAddresses

Publiczne statyczne adresy IP usługi API Management w regionie podstawowym. Dostępne tylko dla jednostek SKU w warstwie Podstawowa, Standardowa, Premium i Izolowana. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

publicIPAddresses?: string[]

Wartość właściwości

string[]

publicIpAddressId

Publiczny adres IP jednostki SKU w wersji 4, który ma być skojarzony z usługą wdrożona Virtual Network w regionie. Obsługiwane tylko w przypadku jednostek SKU developer i Premium wdrażanych w Virtual Network.

publicIpAddressId?: string

Wartość właściwości

string

publicNetworkAccess

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Wartość jest opcjonalna, ale jeśli została przekazana, musi mieć wartość "Włączone" lub "Wyłączone". Jeśli wartość jest wyłączona, prywatne punkty końcowe są metodą wyłącznego dostępu. Wartość domyślna to "Włączone"

publicNetworkAccess?: string

Wartość właściwości

string

restore

Cofanie usuwania usługi Api Management, jeśli została wcześniej usunięta nietrwale. Jeśli ta flaga jest określona i ustawiona na True, wszystkie inne właściwości zostaną zignorowane.

restore?: boolean

Wartość właściwości

boolean

scmUrl

Adres URL punktu końcowego SCM usługi API Management. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

scmUrl?: string

Wartość właściwości

string

targetProvisioningState

Stan aprowizacji usługi API Management, która jest objęta długotrwałą operacją uruchomioną w usłudze. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

targetProvisioningState?: string

Wartość właściwości

string

virtualNetworkConfiguration

Konfiguracja sieci wirtualnej usługi API Management.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Wartość właściwości

VirtualNetworkConfiguration

virtualNetworkType

Typ sieci VPN, w której należy skonfigurować usługę API Management. Brak (wartość domyślna) oznacza, że usługa API Management nie jest częścią żadnego Virtual Network, zewnętrzne oznacza, że wdrożenie API Management jest skonfigurowane wewnątrz Virtual Network mającego punkt końcowy dostępny z Internetu, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane wewnątrz Virtual Network tylko z punktem końcowym dostępnym w intranecie.

virtualNetworkType?: string

Wartość właściwości

string