Freigeben über

ApiManagementServiceBaseProperties interface

  • Referenz
Paket:
@azure/arm-apimanagement

Basiseigenschaften einer API Management Dienstressourcenbeschreibung.

Eigenschaften

additionalLocations

Zusätzliche Rechenzentrumsstandorte des API Management-Diensts.
apiVersionConstraint

Apis-Versionseinschränkung der Steuerungsebene für den API Management-Dienst.
certificates

Liste der Zertifikate, die im API Management-Dienst installiert werden müssen. Die maximale Anzahl von unterstützten Zertifikaten, die installiert werden können, beträgt 10.
createdAtUtc

Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
customProperties

Benutzerdefinierte Eigenschaften des API Management-Diensts.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 deaktiviert die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2).
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kann verwendet werden, um TLS 1.0 für einen API Management-Dienst zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 für die Kommunikation mit Back-Ends zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kann verwendet werden, um TLS 1.0 für die Kommunikation mit Back-Ends zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kann verwendet werden, um das HTTP2-Protokoll für einen API Management-Dienst zu aktivieren.
Wenn Sie keine dieser Eigenschaften im PATCH-Vorgang angeben, werden die Werte ausgelassener Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 ist True der Standardwert, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und False andernfalls. Der Standardwert der Http2-Einstellung ist False.

Sie können eine der folgenden Verschlüsselungen mithilfe von Einstellungen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]deaktivieren: 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_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Beispiel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. Der Standardwert ist true für sie.
Hinweis: Die folgenden Verschlüsselungen können nicht deaktiviert werden, da sie von internen Plattformkomponenten benötigt werden: 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

DEveloper Portal-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
disableGateway

Die Eigenschaft gilt nur für einen Api Management-Dienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway in master Region zu deaktivieren.
enableClientCertificate

Eigenschaft, die nur für den Verbrauchs-SKU-Dienst verwendet werden soll. Dadurch wird ein Clientzertifikat erzwungen, das bei jeder Anforderung an das Gateway angezeigt wird. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
gatewayRegionalUrl

Gateway-URL des API Management-Diensts in der Standardregion. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
gatewayUrl

Gateway-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
hostnameConfigurations

Konfiguration des benutzerdefinierten Hostnamens des API Management-Diensts.
managementApiUrl

Verwaltungs-API-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
natGatewayState

Die Eigenschaft kann verwendet werden, um NAT Gateway für diesen API Management Dienst zu aktivieren.
notificationSenderEmail

Email Adresse, von der die Benachrichtigung gesendet wird.
outboundPublicIPAddresses

Präfixe für ausgehende öffentliche IPV4-Adressen, die dem von NAT Gateway bereitgestellten Dienst zugeordnet sind. Nur für Premium-SKU auf stv2-Plattform verfügbar. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
platformVersion

Compute Platform Version, die den Dienst an diesem Speicherort ausführt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
portalUrl

Herausgeberportalendpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
privateEndpointConnections

Liste der Privaten Endpunktverbindungen dieses Diensts.
privateIPAddresses

Private statische IP-Adressen des API Management-Diensts in der primären Region, die in einer internen Virtual Network bereitgestellt wird. Verfügbar nur für die Basic-, Standard-, Premium- und Isolierte SKU. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
provisioningState

Der aktuelle Bereitstellungsstatus des API Management Diensts, der wie folgt aussehen kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
publicIPAddresses

Öffentliche statische LASTENausgleichs-IP-Adressen des API Management-Diensts in der primären Region. Verfügbar nur für die Basic-, Standard-, Premium- und Isolierte SKU. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
publicIpAddressId

Public Standard SKU IP V4-basierte IP-Adresse, die Virtual Network bereitgestellten Dienst in der Region zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die in Virtual Network bereitgestellt wird.
publicNetworkAccess

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API Management-Dienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Aktiviert" oder "Deaktiviert" sein. Bei "Disabled" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Enabled".
restore

Wiederherstellen des Api Management-Diensts, wenn er zuvor vorläufig gelöscht wurde. Wenn dieses Flag angegeben und auf True festgelegt ist, werden alle anderen Eigenschaften ignoriert.
scmUrl

SCM-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
targetProvisioningState

Der Bereitstellungsstatus des API Management Diensts, auf den der für den Dienst gestartete Vorgang mit langer Ausführungszeit ausgerichtet ist. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
virtualNetworkConfiguration

Virtuelle Netzwerkkonfiguration des API Management-Diensts.
virtualNetworkType

Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management-Dienst nicht Teil eines Virtual Network ist. Extern bedeutet, dass die API Management Bereitstellung innerhalb einer Virtual Network eingerichtet ist, die über einen Endpunkt mit Internetzugriff verfügt, und Intern bedeutet, dass API Management die Bereitstellung wird in einem Virtual Network eingerichtet, der nur über einen Intranetendpunkt verfügt.

Details zur Eigenschaft

additionalLocations

Zusätzliche Rechenzentrumsstandorte des API Management-Diensts.

additionalLocations?: AdditionalLocation[]

Eigenschaftswert

AdditionalLocation[]

apiVersionConstraint

Apis-Versionseinschränkung der Steuerungsebene für den API Management-Dienst.

apiVersionConstraint?: ApiVersionConstraint

Eigenschaftswert

ApiVersionConstraint

certificates

Liste der Zertifikate, die im API Management-Dienst installiert werden müssen. Die maximale Anzahl von unterstützten Zertifikaten, die installiert werden können, beträgt 10.

certificates?: CertificateConfiguration[]

Eigenschaftswert

CertificateConfiguration[]

createdAtUtc

Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

createdAtUtc?: Date

Eigenschaftswert

Date

customProperties

Benutzerdefinierte Eigenschaften des API Management-Diensts.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 deaktiviert die Verschlüsselung TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2).
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kann verwendet werden, um TLS 1.0 für einen API Management-Dienst zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kann verwendet werden, um nur TLS 1.1 für die Kommunikation mit Back-Ends zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kann verwendet werden, um TLS 1.0 für die Kommunikation mit Back-Ends zu deaktivieren.
Die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kann verwendet werden, um das HTTP2-Protokoll für einen API Management-Dienst zu aktivieren.
Wenn Sie keine dieser Eigenschaften im PATCH-Vorgang angeben, werden die Werte ausgelassener Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 ist True der Standardwert, wenn der Dienst am oder vor dem 1. April 2018 erstellt wurde und False andernfalls. Der Standardwert der Http2-Einstellung ist False.

Sie können eine der folgenden Verschlüsselungen mithilfe von Einstellungen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]deaktivieren: 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_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Beispiel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. Der Standardwert ist true für sie.
Hinweis: Die folgenden Verschlüsselungen können nicht deaktiviert werden, da sie von internen Plattformkomponenten benötigt werden: 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}

Eigenschaftswert

{[propertyName: string]: string}

developerPortalUrl

DEveloper Portal-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

developerPortalUrl?: string

Eigenschaftswert

string

disableGateway

Die Eigenschaft gilt nur für einen Api Management-Dienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway in master Region zu deaktivieren.

disableGateway?: boolean

Eigenschaftswert

boolean

enableClientCertificate

Eigenschaft, die nur für den Verbrauchs-SKU-Dienst verwendet werden soll. Dadurch wird ein Clientzertifikat erzwungen, das bei jeder Anforderung an das Gateway angezeigt wird. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.

enableClientCertificate?: boolean

Eigenschaftswert

boolean

gatewayRegionalUrl

Gateway-URL des API Management-Diensts in der Standardregion. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

gatewayRegionalUrl?: string

Eigenschaftswert

string

gatewayUrl

Gateway-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

gatewayUrl?: string

Eigenschaftswert

string

hostnameConfigurations

Konfiguration des benutzerdefinierten Hostnamens des API Management-Diensts.

hostnameConfigurations?: HostnameConfiguration[]

Eigenschaftswert

HostnameConfiguration[]

managementApiUrl

Verwaltungs-API-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

managementApiUrl?: string

Eigenschaftswert

string

natGatewayState

Die Eigenschaft kann verwendet werden, um NAT Gateway für diesen API Management Dienst zu aktivieren.

natGatewayState?: string

Eigenschaftswert

string

notificationSenderEmail

Email Adresse, von der die Benachrichtigung gesendet wird.

notificationSenderEmail?: string

Eigenschaftswert

string

outboundPublicIPAddresses

Präfixe für ausgehende öffentliche IPV4-Adressen, die dem von NAT Gateway bereitgestellten Dienst zugeordnet sind. Nur für Premium-SKU auf stv2-Plattform verfügbar. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

outboundPublicIPAddresses?: string[]

Eigenschaftswert

string[]

platformVersion

Compute Platform Version, die den Dienst an diesem Speicherort ausführt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

platformVersion?: string

Eigenschaftswert

string

portalUrl

Herausgeberportalendpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

portalUrl?: string

Eigenschaftswert

string

privateEndpointConnections

Liste der Privaten Endpunktverbindungen dieses Diensts.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Eigenschaftswert

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Private statische IP-Adressen des API Management-Diensts in der primären Region, die in einer internen Virtual Network bereitgestellt wird. Verfügbar nur für die Basic-, Standard-, Premium- und Isolierte SKU. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

privateIPAddresses?: string[]

Eigenschaftswert

string[]

provisioningState

Der aktuelle Bereitstellungsstatus des API Management Diensts, der wie folgt aussehen kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

publicIPAddresses

Öffentliche statische LASTENausgleichs-IP-Adressen des API Management-Diensts in der primären Region. Verfügbar nur für die Basic-, Standard-, Premium- und Isolierte SKU. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

publicIPAddresses?: string[]

Eigenschaftswert

string[]

publicIpAddressId

Public Standard SKU IP V4-basierte IP-Adresse, die Virtual Network bereitgestellten Dienst in der Region zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die in Virtual Network bereitgestellt wird.

publicIpAddressId?: string

Eigenschaftswert

string

publicNetworkAccess

Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API Management-Dienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss "Aktiviert" oder "Deaktiviert" sein. Bei "Disabled" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Enabled".

publicNetworkAccess?: string

Eigenschaftswert

string

restore

Wiederherstellen des Api Management-Diensts, wenn er zuvor vorläufig gelöscht wurde. Wenn dieses Flag angegeben und auf True festgelegt ist, werden alle anderen Eigenschaften ignoriert.

restore?: boolean

Eigenschaftswert

boolean

scmUrl

SCM-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

scmUrl?: string

Eigenschaftswert

string

targetProvisioningState

Der Bereitstellungsstatus des API Management Diensts, auf den der für den Dienst gestartete Vorgang mit langer Ausführungszeit ausgerichtet ist. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

targetProvisioningState?: string

Eigenschaftswert

string

virtualNetworkConfiguration

Virtuelle Netzwerkkonfiguration des API Management-Diensts.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Eigenschaftswert

VirtualNetworkConfiguration

virtualNetworkType

Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management-Dienst nicht Teil eines Virtual Network ist. Extern bedeutet, dass die API Management Bereitstellung innerhalb einer Virtual Network eingerichtet ist, die über einen Endpunkt mit Internetzugriff verfügt, und Intern bedeutet, dass API Management die Bereitstellung wird in einem Virtual Network eingerichtet, der nur über einen Intranetendpunkt verfügt.

virtualNetworkType?: string

Eigenschaftswert

string