Freigeben über

Api Management Service - MigrateToStv2

  • Referenz
Dienst:
API Management
API-Version:
2022-08-01

Aktualisiert einen API Management-Dienst auf die Stv2-Plattform. Weitere Informationen finden Sie unter https://aka.ms/apim-migrate-stv2. Diese Änderung kann nicht rückgängig gemacht werden. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2?api-version=2022-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
 path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName
 path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Hierbei handelt es sich um die ID des Zielabonnements.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

ApiManagementServiceResource

Der Dienst wurde erfolgreich migriert.
202 Accepted

Migrationsanforderung gesendet.

Header

location: string
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementMigrateService

Beispielanforderung

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/migrateToStv2?api-version=2022-08-01

Beispiel für eine Antwort

Statuscode:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {},
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definitionen

Name Beschreibung
AdditionalLocation

Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.
ApiManagementServiceIdentity

Identitätseigenschaften der Api Management-Dienstressource.
ApiManagementServiceResource

Eine einzelne API Management Dienstressource in Liste oder Antwort abrufen.
ApiManagementServiceSkuProperties

API Management SKU-Eigenschaften der Dienstressource.
ApimIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
ApiVersionConstraint

Versionseinschränkung der Steuerungsebenen-API für den API Management-Dienst.
ArmIdWrapper

Ein Wrapper für eine ARM-Ressourcen-ID
CertificateConfiguration

Zertifikatkonfiguration, die aus nicht vertrauenswürdigen Zwischen- und Stammzertifikaten besteht.
CertificateInformation

SSL-Zertifikatinformationen.
CertificateSource

Zertifikatquelle.
CertificateStatus

Zertifikatstatus.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
ErrorFieldContract

Fehler Feldvertrag.
ErrorResponse

Fehlerantwort.
HostnameConfiguration

Konfiguration des benutzerdefinierten Hostnamens.
HostnameType

Hostnamentyp.
NatGatewayState

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

Computeplattformversion, die den Dienst ausführt.
PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.
PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.
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".
RemotePrivateEndpointConnectionWrapper

Verbindungsressource des privaten Remoteendpunkts.
SkuType

Name der SKU.
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
UserIdentityProperties
VirtualNetworkConfiguration

Konfiguration eines virtuellen Netzwerks, in dem API Management Dienst bereitgestellt wird.
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.

AdditionalLocation

Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.

Name Typ Standardwert Beschreibung
disableGateway

boolean

False

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 an diesem zusätzlichen Speicherort zu deaktivieren.
gatewayRegionalUrl

string

Gateway-URL des API Management-Diensts in der Region.
location

string

Der Standortname der zusätzlichen Region unter den Azure-Rechenzentrumsregionen.
natGatewayState

NatGatewayState

Disabled

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

string[]

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.
platformVersion

PlatformVersion

Computeplattformversion, die den Dienst ausführt.
privateIPAddresses

string[]

Private statische LASTENausgleichs-IP-Adressen des API Management Diensts, der in einem internen Virtual Network an einem bestimmten zusätzlichen Speicherort bereitgestellt wird. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
publicIPAddresses

string[]

Öffentliche ip-Adressen mit statischem Lastenausgleich des API Management-Diensts am zusätzlichen Standort. Nur für Basic-, Standard-, Premium- und Isolierte SKU verfügbar.
publicIpAddressId

string

Öffentliche Standard-SKU IP V4-basierte IP-Adresse, die Virtual Network bereitgestellten Dienst am Standort zugeordnet werden soll. Wird nur für Premium-SKU unterstützt, die in Virtual Network bereitgestellt wird.
sku

ApiManagementServiceSkuProperties

SKU-Eigenschaften des API Management-Diensts.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Konfiguration des virtuellen Netzwerks für den Standort.
zones

string[]

Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.

ApiManagementServiceIdentity

Identitätseigenschaften der Api Management-Dienstressource.

Name Typ Beschreibung
principalId

string

Die Prinzipal-ID der Identität.
tenantId

string

Die Clientmandanten-ID der Identität.
type

ApimIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
userAssignedIdentities

<string,  UserIdentityProperties>

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs in der Form "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Eine einzelne API Management Dienstressource in Liste oder Antwort abrufen.

Name Typ Standardwert Beschreibung
etag

string

ETag der Ressource.
id

string

Ressourcen-ID
identity

ApiManagementServiceIdentity

Verwaltete Dienstidentität des Api Management-Diensts.
location

string

Ressourcenspeicherort
name

string

Name der Ressource.
properties.additionalLocations

AdditionalLocation[]

Zusätzliche Rechenzentrumsstandorte des API Management-Diensts.
properties.apiVersionConstraint

ApiVersionConstraint

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

CertificateConfiguration[]

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.
properties.createdAtUtc

string

Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
properties.customProperties

object

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
properties.developerPortalUrl

string

DEveloper Portal-Endpunkt-URL des API Management-Diensts.
properties.disableGateway

boolean

False

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.
properties.enableClientCertificate

boolean

False

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.
properties.gatewayRegionalUrl

string

Gateway-URL des API Management-Diensts in der Standardregion.
properties.gatewayUrl

string

Gateway-URL des API Management-Diensts.
properties.hostnameConfigurations

HostnameConfiguration[]

Konfiguration des benutzerdefinierten Hostnamens des API Management-Diensts.
properties.managementApiUrl

string

Verwaltungs-API-Endpunkt-URL des API Management-Diensts.
properties.natGatewayState

NatGatewayState

Disabled

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

string

Email Adresse, von der die Benachrichtigung gesendet wird.
properties.outboundPublicIPAddresses

string[]

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.
properties.platformVersion

PlatformVersion

Compute Platform Version, die den Dienst an diesem Speicherort ausführt.
properties.portalUrl

string

Herausgeberportalendpunkt-URL des API Management-Diensts.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Liste der Privaten Endpunktverbindungen dieses Diensts.
properties.privateIPAddresses

string[]

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.
properties.provisioningState

string

Der aktuelle Bereitstellungsstatus des API Management Diensts, der wie folgt aussehen kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses

string[]

Ö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.
properties.publicIpAddressId

string

Öffentliche 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 werden.
properties.publicNetworkAccess

PublicNetworkAccess

Gibt an, ob für diesen API Management Dienst der Zugriff auf öffentliche Endpunkte zulässig ist oder nicht. Der Wert ist optional, muss aber bei Übergabe "Aktiviert" oder "Deaktiviert" sein. Bei "Deaktiviert" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Aktiviert".
properties.publisherEmail

string

Herausgeber-E-Mail.
properties.publisherName

string

Name des Herausgebers.
properties.restore

boolean

False

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.
properties.scmUrl

string

SCM-Endpunkt-URL des API Management-Diensts.
properties.targetProvisioningState

string

Der Bereitstellungsstatus des API Management Diensts, der auf den für den Dienst gestarteten Vorgang mit langer Ausführung ausgerichtet ist.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Virtuelle Netzwerkkonfiguration des API Management-Diensts.
properties.virtualNetworkType

VirtualNetworkType

None

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 eines Virtual Network mit einem Endpunkt mit Internetzugriff eingerichtet ist, und Intern bedeutet, dass API Management Die Bereitstellung wird in einer Virtual Network eingerichtet, die nur einen intranetorientierten Endpunkt aufweist.
sku

ApiManagementServiceSkuProperties

SKU-Eigenschaften des API Management-Diensts.
systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
tags

object

Ressourcentags.
type

string

Der Ressourcentyp für API Management Ressource ist auf Microsoft.ApiManagement festgelegt.
zones

string[]

Eine Liste von Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.

ApiManagementServiceSkuProperties

API Management SKU-Eigenschaften der Dienstressource.

Name Typ Beschreibung
capacity

integer

Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Für Verbrauch muss die SKU-Kapazität als 0 angegeben werden.
name

SkuType

Name der Sku.

ApimIdentityType

Der Identitätstyp, der für die Ressource verwendet wird. Der Typ „SystemAssigned, UserAssigned“ umfasst sowohl eine implizit erstellte Identität als auch einen Satz von Benutzern zugewiesener Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.

Name Typ Beschreibung
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

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

Name Typ Beschreibung
minApiVersion

string

Beschränken Sie die API-Aufrufe der Steuerungsebene an API Management Dienst, deren Version gleich oder höher ist.

ArmIdWrapper

Ein Wrapper für eine ARM-Ressourcen-ID

Name Typ Beschreibung
id

string

CertificateConfiguration

Zertifikatkonfiguration, die aus nicht vertrauenswürdigen Zwischen- und Stammzertifikaten besteht.

Name Typ Beschreibung
certificate

CertificateInformation

Zertifikatinformationen.
certificatePassword

string

Zertifikatkennwort.
encodedCertificate

string

Base64-codiertes Zertifikat.
storeName enum:
  • CertificateAuthority
  • Root

Der Zertifikatspeicherort System.Security.Cryptography.x509certificates.StoreName. Nur Root und CertificateAuthority sind gültige Speicherorte.

CertificateInformation

SSL-Zertifikatinformationen.

Name Typ Beschreibung
expiry

string

Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.
subject

string

Betreff des Zertifikats.
thumbprint

string

Fingerabdruck des Zertifikats

CertificateSource

Zertifikatquelle.

Name Typ Beschreibung
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Zertifikatstatus.

Name Typ Beschreibung
Completed

string

Failed

string

InProgress

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Fehler Feldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.
message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message

string

Lesbare Darstellung des Fehlers.

HostnameConfiguration

Konfiguration des benutzerdefinierten Hostnamens.

Name Typ Standardwert Beschreibung
certificate

CertificateInformation

Zertifikatinformationen.
certificatePassword

string

Zertifikatkennwort.
certificateSource

CertificateSource

Zertifikatquelle.
certificateStatus

CertificateStatus

Zertifikatstatus.
defaultSslBinding

boolean

False

Geben Sie true an, um das diesem Hostnamen zugeordnete Zertifikat als Standard-SSL-Zertifikat einzurichten. Wenn ein Client den SNI-Header nicht sendet, wird dies das Zertifikat sein, das angefragt wird. Die Eigenschaft ist nützlich, wenn für einen Dienst mehrere benutzerdefinierte Hostnamen aktiviert sind und er sich für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wird nur auf den Hostnamentyp des Gateways angewendet.
encodedCertificate

string

Base64-codiertes Zertifikat.
hostName

string

Hostname, der für den Api Management-Dienst konfiguriert werden soll.
identityClientId

string

Client-Id für system- oder benutzerseitig zugewiesene verwaltete Identität, wie von Azure AD generiert, die GET-Zugriff auf den keyVault mit dem SSL-Zertifikat hat.
keyVaultId

string

URL zum KeyVault-Geheimnis, das das SSL-Zertifikat enthält. Wenn absolute URL mit Version angegeben wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der Api Management-Dienst mit aka.ms/apimmsi konfiguriert werden. Das Geheimnis sollte vom Typ application/x-pkcs12 sein.
negotiateClientCertificate

boolean

False

Geben Sie true an, um immer das Clientzertifikat für den Hostnamen auszuhandeln. Der Standardwert ist false.
type

HostnameType

Hostnamentyp.

HostnameType

Hostnamentyp.

Name Typ Beschreibung
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

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

Name Typ Beschreibung
Disabled

string

Nat Gateway ist für den Dienst deaktiviert.
Enabled

string

Nat Gateway ist für den Dienst aktiviert.

PlatformVersion

Computeplattformversion, die den Dienst ausführt.

Name Typ Beschreibung
mtv1

string

Plattform, auf der der Dienst auf mehrinstanzenfähiger V1-Plattform ausgeführt wird.
stv1

string

Plattform, auf der der Dienst auf der Einzelmandanten-V1-Plattform ausgeführt wird.
stv2

string

Plattform, auf der der Dienst auf der Einzelmandanten-V2-Plattform ausgeführt wird.
undetermined

string

Die Plattformversion kann nicht bestimmt werden, da die Computeplattform nicht bereitgestellt wird.

PrivateEndpointServiceConnectionStatus

Die verbindung mit dem privaten Endpunkt status.

Name Typ Beschreibung
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.

Name Typ Beschreibung
actionsRequired

string

Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Consumer erfordern.
description

string

Der Grund für die Genehmigung/Ablehnung der Verbindung.
status

PrivateEndpointServiceConnectionStatus

Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

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".

Name Typ Beschreibung
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Verbindungsressource des privaten Remoteendpunkts.

Name Typ Beschreibung
id

string

Verbindungsressourcen-ID des privaten Endpunkts
name

string

Verbindungsname des privaten Endpunkts
properties.groupIds

string[]

Alle Gruppen-IDs.
properties.privateEndpoint

ArmIdWrapper

Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Verbindungsstatus zwischen Dienstconsumer und Anbieter.
properties.provisioningState

string

Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.
type

string

Verbindungsressourcentyp für private Endpunkte

SkuType

Name der SKU.

Name Typ Beschreibung
Basic

string

Grundlegende SKU von Api Management.
Consumption

string

Verbrauchs-SKU von Api Management.
Developer

string

Entwickler-SKU von Api Management.
Isolated

string

Isolierte SKU von Api Management.
Premium

string

Premium-SKU von Api Management.
Standard

string

Standard-SKU von Api Management.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserIdentityProperties

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

VirtualNetworkConfiguration

Konfiguration eines virtuellen Netzwerks, in dem API Management Dienst bereitgestellt wird.

Name Typ Beschreibung
subnetResourceId

string

Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API Management Dienst bereitgestellt werden soll.
subnetname

string

Der Name des Teilnetzes.
vnetid

string

Die ID des virtuellen Netzwerks. Dies ist in der Regel eine GUID. Erwartet standardmäßig eine NULL-GUID.

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.

Name Typ Beschreibung
External

string

Der Dienst ist Teil von Virtual Network und über das Internet zugänglich.
Internal

string

Der Dienst ist Teil von Virtual Network und nur innerhalb des virtuellen Netzwerks zugänglich.
None

string

Der Dienst ist nicht Teil einer Virtual Network.