Udostępnij za pośrednictwem

ApiManagementServiceUpdateProperties interface

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

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

Rozszerzenie
ApiManagementServiceBaseProperties

Właściwości

publisherEmail

Adres e-mail wydawcy.
publisherName

Nazwa wydawcy.

Właściwości dziedziczone

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 certyfikatów, które można zainstalować, wynosi 10.
createdAtUtc

Data utworzenia czasu 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 zapleczem.
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.
Nieokreślenie żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna to True , jeśli usługa została utworzona w dniu 1 kwietnia 2018 r False . lub wcześniej. 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_SHA256:false . Wartość domyślna jest true dla nich.
Uwaga: Nie można wyłączyć następujących szyfrów, ponieważ są one wymagane przez składniki platformy wewnętrznej: 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 prezentowanie certyfikatu klienta dla każdego żądania 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

Prefiksy publicznych adresów IPV4 dla ruchu wychodzącego 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 standardowy adres IP jednostki SKU w wersji 4, który ma być skojarzony z Virtual Network wdrożona usługa w regionie. Obsługiwane tylko w przypadku jednostki SKU developer i Premium wdrażanej w Virtual Network.
publicNetworkAccess

Niezależnie od tego, 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ść "Wyłączone", 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 zostanie 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 internetowy punkt końcowy, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane w Virtual Network tylko w punkcie końcowym dostępnym w intranecie.

Szczegóły właściwości

publisherEmail

Adres e-mail wydawcy.

publisherEmail?: string

Wartość właściwości

string

publisherName

Nazwa wydawcy.

publisherName?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

additionalLocations

Dodatkowe lokalizacje centrum danych usługi API Management.

additionalLocations?: AdditionalLocation[]

Wartość właściwości

AdditionalLocation[]

Dziedziczone zapiManagementServiceBaseProperties.additionalLocations

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Wartość właściwości

ApiVersionConstraint

Dziedziczone zapiManagementServiceBaseProperties.apiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Wartość właściwości

CertificateConfiguration[]

Dziedziczone zapiManagementServiceBaseProperties.certificates

createdAtUtc

Data utworzenia czasu 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

Dziedziczone zapiManagementServiceBaseProperties.createdAtUtc

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 zapleczem.
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.
Nieokreślenie żadnej z tych właściwości operacji PATCH spowoduje zresetowanie wartości właściwości do ich wartości domyślnych. Dla wszystkich ustawień z wyjątkiem Http2 wartość domyślna to True , jeśli usługa została utworzona w dniu 1 kwietnia 2018 r False . lub wcześniej. 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_SHA256:false . Wartość domyślna jest true dla nich.
Uwaga: Nie można wyłączyć następujących szyfrów, ponieważ są one wymagane przez składniki platformy wewnętrznej: 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}

Dziedziczone zapiManagementServiceBaseProperties.customProperties

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

Dziedziczone zapiManagementServiceBaseProperties.developerPortalUrl

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

Dziedziczone zapiManagementServiceBaseProperties.disableGateway

enableClientCertificate

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

enableClientCertificate?: boolean

Wartość właściwości

boolean

Dziedziczone zapiManagementServiceBaseProperties.enableClientCertificate

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

Dziedziczone zapiManagementServiceBaseProperties.gatewayRegionalUrl

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

Dziedziczone zelementu ApiManagementServiceBaseProperties.gatewayUrl

hostnameConfigurations

Niestandardowa konfiguracja nazwy hosta usługi API Management.

hostnameConfigurations?: HostnameConfiguration[]

Wartość właściwości

HostnameConfiguration[]

Dziedziczone zapiManagementServiceBaseProperties.hostnameConfigurations

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

Dziedziczone zelementu ApiManagementServiceBaseProperties.managementApiUrl

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

Dziedziczone zapiManagementServiceBaseProperties.natGatewayState

notificationSenderEmail

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

notificationSenderEmail?: string

Wartość właściwości

string

Dziedziczone zapiManagementServiceBaseProperties.notificationSenderEmail

outboundPublicIPAddresses

Prefiksy publicznych adresów IPV4 dla ruchu wychodzącego 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[]

Dziedziczone zapiManagementServiceBaseProperties.outboundPublicIPAddresses

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

Dziedziczone z klasyApiManagementServiceBaseProperties.platformVersion

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

Dziedziczone zelementu ApiManagementServiceBaseProperties.portalUrl

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Wartość właściwości

RemotePrivateEndpointConnectionWrapper[]

Dziedziczone zelementu ApiManagementServiceBaseProperties.privateEndpointConnections

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[]

Dziedziczone zelementu ApiManagementServiceBaseProperties.privateIPAddresses

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

Dziedziczone zelementu ApiManagementServiceBaseProperties.provisioningState

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[]

Dziedziczone zelementu ApiManagementServiceBaseProperties.publicIPAddresses

publicIpAddressId

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

publicIpAddressId?: string

Wartość właściwości

string

Dziedziczone zelementu ApiManagementServiceBaseProperties.publicIpAddressId

publicNetworkAccess

Niezależnie od tego, 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ść "Wyłączone", prywatne punkty końcowe są metodą wyłącznego dostępu. Wartość domyślna to "Włączone"

publicNetworkAccess?: string

Wartość właściwości

string

Dziedziczone zklasy ApiManagementServiceBaseProperties.publicNetworkAccess

restore

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

restore?: boolean

Wartość właściwości

boolean

Dziedziczone zelementu ApiManagementServiceBaseProperties.restore

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

Dziedziczone zelementu ApiManagementServiceBaseProperties.scmUrl

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

Dziedziczone z klasyApiManagementServiceBaseProperties.targetProvisioningState

virtualNetworkConfiguration

Konfiguracja sieci wirtualnej usługi API Management.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Wartość właściwości

VirtualNetworkConfiguration

Dziedziczone zklasy ApiManagementServiceBaseProperties.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 internetowy punkt końcowy, a wewnętrzny oznacza, że API Management wdrożenie jest konfigurowane w Virtual Network tylko w punkcie końcowym dostępnym w intranecie.

virtualNetworkType?: string

Wartość właściwości

string

Dziedziczone zklasy ApiManagementServiceBaseProperties.virtualNetworkType