ApiManagementServiceResource interface
Eine einzelne API Management Dienstressource in "List" oder "Get response".
- Extends
Eigenschaften
additional |
Zusätzliche Rechenzentrumsstandorte des API Management-Diensts. |
api |
Versionseinschränkung der Steuerungsebenen-API 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. |
created |
Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: |
custom |
Benutzerdefinierte Eigenschaften des API Management-Diensts. |
developer |
DEveloper Portal-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
disable |
Die Eigenschaft ist nur für einen Api Management-Dienst gültig, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway in master Region zu deaktivieren. |
enable |
Eigenschaft, die nur für den Verbrauchs-SKU-Dienst verwendet werden soll. Dadurch wird erzwungen, dass bei jeder Anforderung an das Gateway ein Clientzertifikat angezeigt wird. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway. |
etag | ETag der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
gateway |
Gateway-URL des API Management-Diensts in der Standardregion. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
gateway |
Gateway-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
hostname |
Konfiguration des benutzerdefinierten Hostnamens des API Management-Diensts. |
identity | Verwaltete Dienstidentität des Api Management-Diensts. |
location | Ressourcenspeicherort |
management |
Verwaltungs-API-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
nat |
Die -Eigenschaft kann verwendet werden, um NAT Gateway für diesen API Management-Dienst zu aktivieren. |
notification |
Email Adresse, von der die Benachrichtigung gesendet wird. |
outbound |
Präfixe für ausgehende öffentliche IPV4-Adressen, die dem bereitgestellten NAT Gateway-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. |
platform |
Computeplattformversion, die den Dienst an diesem Speicherort ausführt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
portal |
Endpunkt-URL des API Management-Diensts des Herausgeberportals. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
private |
Liste der Privaten Endpunktverbindungen dieses Diensts. |
private |
Ip-Adressen mit privatem statischem Lastenausgleich des API Management-Diensts in der primären Region, die in einem internen Virtual Network bereitgestellt wird. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
provisioning |
Der aktuelle Bereitstellungsstatus des API Management Dienst, 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. |
public |
Öffentliche ip-Adressen mit statischem Lastenausgleich des API Management-Diensts in der primären Region. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
public |
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. |
public |
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". |
publisher |
Herausgeber-E-Mail. |
publisher |
Herausgebername. |
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. |
scm |
SCM-Endpunkt-URL des API Management-Diensts. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
sku | SKU-Eigenschaften des API Management-Diensts. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
target |
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. |
virtual |
Virtuelle Netzwerkkonfiguration des API Management-Diensts. |
virtual |
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. |
zones | Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss. |
Geerbte Eigenschaften
id | Ressourcen-ID HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
name | Name der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
tags | Ressourcentags. |
type | Der Ressourcentyp für API Management Ressource ist auf Microsoft.ApiManagement festgelegt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden. |
Details zur Eigenschaft
additionalLocations
Zusätzliche Rechenzentrumsstandorte des API Management-Diensts.
additionalLocations?: AdditionalLocation[]
Eigenschaftswert
apiVersionConstraint
Versionseinschränkung der Steuerungsebenen-API für den API Management-Dienst.
apiVersionConstraint?: ApiVersionConstraint
Eigenschaftswert
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
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.
Durch die Einstellung Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168
wird die TLS_RSA_WITH_3DES_EDE_CBC_SHA für alle TLS(1.0, 1.1 und 1.2) deaktiviert.
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 beim PATCH-Vorgang angeben, werden die Werte der ausgelassenen Eigenschaften auf die 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 jede der folgenden Verschlüsselungen mithilfe der 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 für interne Plattformkomponenten erforderlich sind: 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 ist nur für einen Api Management-Dienst gültig, 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 erzwungen, dass bei jeder Anforderung an das Gateway ein Clientzertifikat angezeigt wird. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway.
enableClientCertificate?: boolean
Eigenschaftswert
boolean
etag
ETag der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
etag?: string
Eigenschaftswert
string
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
identity
Verwaltete Dienstidentität des Api Management-Diensts.
identity?: ApiManagementServiceIdentity
Eigenschaftswert
location
Ressourcenspeicherort
location: string
Eigenschaftswert
string
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 bereitgestellten NAT Gateway-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
Computeplattformversion, 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
Endpunkt-URL des API Management-Diensts des Herausgeberportals. 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
privateIPAddresses
Ip-Adressen mit privatem statischem Lastenausgleich des API Management-Diensts in der primären Region, die in einem internen Virtual Network bereitgestellt wird. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar. 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 Dienst, 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 ip-Adressen mit statischem Lastenausgleich des API Management-Diensts in der primären Region. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar. 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
publisherEmail
Herausgeber-E-Mail.
publisherEmail: string
Eigenschaftswert
string
publisherName
Herausgebername.
publisherName: 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
sku
SKU-Eigenschaften des API Management-Diensts.
sku: ApiManagementServiceSkuProperties
Eigenschaftswert
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
systemData?: SystemData
Eigenschaftswert
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
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
zones
Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.
zones?: string[]
Eigenschaftswert
string[]
Geerbte Eigenschaftsdetails
id
Ressourcen-ID HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
id?: string
Eigenschaftswert
string
Geerbt vonApimResource.id
name
Name der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
name?: string
Eigenschaftswert
string
Geerbt vonApimResource.name
tags
Ressourcentags.
tags?: {[propertyName: string]: string}
Eigenschaftswert
{[propertyName: string]: string}
Geerbt vonApimResource.tags
type
Der Ressourcentyp für API Management Ressource ist auf Microsoft.ApiManagement festgelegt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
type?: string
Eigenschaftswert
string
Geerbt vonApimResource.type