Api Management Service - Restore

  • Referenz
Service:
API Management
API Version:
2021-08-01

Stellt eine Sicherung eines API Management Diensts wieder her, der mithilfe des ApiManagementService_Backup Vorgangs für den aktuellen Dienst erstellt wurde. Dies ist ein zeitauffälliger Vorgang, der einige Minuten dauern kann.

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

URI-Parameter

Name In Required Type Description
resourceGroupName
 path True
  • string

Der Name der Ressourcengruppe.
serviceName
 path True
  • string

Der Name des API Management Diensts.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True
  • string

Abonnementanmeldeinformationen, die Microsoft Azure Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version
 query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungstext

Name Required Type Description
backupName True
  • string

Der Name der Sicherungsdatei, die erstellt/abgerufen werden soll.
containerName True
  • string

Der Name des Blobcontainers (wird zum Platzieren/Abrufen der Sicherung verwendet).
storageAccount True
  • string

Der Name des Azure-Speicherkontos (wird zum Platzieren/Abrufen der Sicherung verwendet).
accessKey
  • string

Zugriffsschlüssel für das Speicherkonto Nur erforderlich, wenn accessType auf festgelegt AccessKey ist.
accessType

Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll.
clientId
  • string

Die Client-ID der vom Benutzer zugewiesenen verwalteten Identität. Nur erforderlich, wenn accessType auf festgelegt UserAssignedManagedIdentity ist.

Antworten

Name Type Description
200 OK

Die Sicherung wurde erfolgreich auf dem API Management-Dienst wiederhergestellt.
202 Accepted

Akzeptiert: Der Location-Header enthält die URL, unter der der Status des Vorgangs mit langer Ausführungslaufzeit überprüft werden kann.
Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identität Ihres Benutzerkontos annehmen

Beispiele

ApiManagementRestoreService

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2021-08-01
Request Body
{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Sample Response

Status code:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definitionen

AccessType

Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll.
AdditionalLocation

Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.
ApiManagementServiceBackupRestoreParameters

Parameter, die für die Sicherung/Wiederherstellung eines API Management Dienstvorgangs bereitgestellt werden.
ApiManagementServiceIdentity

Identitätseigenschaften der Api Management-Dienstressource.
ApiManagementServiceResource

Eine einzelne API Management Dienstressource in "List" oder "Get response".
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-APIs 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

Fehlerfeldvertrag.
ErrorResponse

Fehlerantwort.
HostnameConfiguration

Benutzerdefinierte Hostnamenkonfiguration.
HostnameType

Hostname-Typ.
PlatformVersion

Computeplattformversion, auf der der Dienst ausgeführt wird.
PrivateEndpointServiceConnectionStatus

Der Verbindungsstatus des privaten Endpunkts.
PrivateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstverbraucher und dem Anbieter.
PublicNetworkAccess

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

Verbindungsressource für private Remoteendpunkte.
SkuType

Name der SKU.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.
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 einer Virtual Network ist, extern bedeutet, dass die API Management Bereitstellung in einem Virtual Network mit einem Endpunkt mit Internetverkn; und Intern bedeutet, dass API Management Bereitstellung in einem Virtual Network nur über einen Endpunkt mit Intranetverkn. eingerichtet wird.

AccessType

Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll.

Name Type Description
AccessKey
  • string

Verwenden Sie den Zugriffsschlüssel.
SystemAssignedManagedIdentity
  • string

Verwenden Sie vom System zugewiesene verwaltete Identität.
UserAssignedManagedIdentity
  • string

Verwenden Sie vom Benutzer zugewiesene verwaltete Identität.

AdditionalLocation

Beschreibung eines zusätzlichen API Management Ressourcenspeicherorts.

Name Type Description
disableGateway
  • boolean

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

Computeplattformversion, auf der der Dienst ausgeführt wird.
privateIPAddresses
  • string[]

Private statische IP-Adressen mit Lastenausgleich 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 statische IP-Adressen mit Lastenausgleich des API Management-Diensts am zusätzlichen Speicherort. Nur für Basic, Standard, Premium und Isolierte SKU verfügbar.
publicIpAddressId
  • string

IP V4-basierte IP-Adresse der öffentlichen Standard-SKU, 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

SKU-Eigenschaften des API Management-Diensts.
virtualNetworkConfiguration

Konfiguration des virtuellen Netzwerks für den Standort.
zones
  • string[]

Eine Liste von Verfügbarkeitszonen, die anführen, woher die Ressource stammen muss.

ApiManagementServiceBackupRestoreParameters

Parameter, die für die Sicherung/Wiederherstellung eines API Management Dienstvorgangs bereitgestellt werden.

Name Type Description
accessKey
  • string

Zugriffsschlüssel für das Speicherkonto Nur erforderlich, wenn accessType auf festgelegt AccessKey ist.
accessType

Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll.
backupName
  • string

Der Name der Sicherungsdatei, die erstellt/abgerufen werden soll.
clientId
  • string

Die Client-ID der vom Benutzer zugewiesenen verwalteten Identität. Nur erforderlich, wenn accessType auf festgelegt UserAssignedManagedIdentity ist.
containerName
  • string

Der Name des Blobcontainers (wird zum Platzieren/Abrufen der Sicherung verwendet).
storageAccount
  • string

Der Name des Azure-Speicherkontos (wird zum Platzieren/Abrufen der Sicherung verwendet).

ApiManagementServiceIdentity

Identitätseigenschaften der Api Management-Dienstressource.

Name Type Description
principalId
  • string

Die Prinzipal-ID der Identität.
tenantId
  • string

Die Clientmandanten-ID der Identität.
type

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

Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Schlüsselverweise des Benutzeridentitätswörterbuchs sind ARM-Ressourcen-IDs im Folgenden: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Eine einzelne API Management Dienstressource in "List" oder "Get response".

Name Type Description
etag
  • string

ETag der Ressource.
id
  • string

Ressourcen-ID
identity

Verwaltete Dienstidentität des API Management-Diensts.
location
  • string

Ressourcenspeicherort
name
  • string

Name der Ressource.
properties.additionalLocations

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

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

Liste der Zertifikate, die im API Management-Dienst installiert werden müssen. Die maximal unterstützten Zertifikate, die installiert werden können, sind 10.
properties.createdAtUtc
  • string

UTC-Erstellungsdatum des API Management-Diensts. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß iso 8601-Standard.
properties.customProperties
  • object

Benutzerdefinierte Eigenschaften des API Management-Diensts.
Durch festlegen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wird die Verschlüsselung 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 nicht angegebenen Eigenschaften auf ihre Standardwerte zurückgesetzt. Für alle Einstellungen mit Ausnahme von Http2 ist der Standardwert True , 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 nächsten 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 nächsten Verschlüsselungen können nicht deaktiviert werden, da sie für interne Azure CloudService-Komponenten erforderlich sind: 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,TLS_RSA_WITH_AES_256_GCM_SHA384
properties.developerPortalUrl
  • string

Endpunkt-URL des DEveloper-Portals des API Management-Diensts.
properties.disableGateway
  • boolean

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 der Masterregion zu deaktivieren.
properties.enableClientCertificate
  • boolean

Eigenschaft, die nur für den Verbrauchs-SKU-Dienst verwendet werden soll. Dadurch wird erzwungen, dass für jede Anforderung an das Gateway ein Clientzertifikat 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

Benutzerdefinierte Hostnamenkonfiguration des API Management-Diensts.
properties.managementApiUrl
  • string

Verwaltungs-API Endpunkt-URL des API Management-Diensts.
properties.notificationSenderEmail
  • string

E-Mail-Adresse, von der die Benachrichtigung gesendet wird.
properties.platformVersion

Computeplattformversion, die den Dienst an diesem Speicherort ausführt.
properties.portalUrl
  • string

Publisher Portalendpunkt-URL des API Management-Diensts.
properties.privateEndpointConnections

Liste der Privaten Endpunktverbindungen dieses Diensts.
properties.privateIPAddresses
  • string[]

Private statische IP-Adressen mit 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.
properties.provisioningState
  • string

Der aktuelle Bereitstellungsstatus des API Management Diensts kann einer der folgenden sein: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses
  • string[]

Öffentliche statische IP-Adressen mit Lastenausgleich des API Management-Diensts in der primären Region. Nur für Basic, Standard, Premium und Isolierte SKU verfügbar.
properties.publicIpAddressId
  • string

IP V4-basierte IP-Adresse der öffentlichen Standard-SKU, 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.
properties.publicNetworkAccess

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

Publisher E-Mail.
properties.publisherName
  • string

Publisher Name.
properties.restore
  • boolean

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, für den der zeitauffällige Vorgang gilt, der für den Dienst gestartet wurde.
properties.virtualNetworkConfiguration

Konfiguration des virtuellen Netzwerks des API Management-Diensts.
properties.virtualNetworkType

Der VPN-Typ, in dem API Management Dienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API Management Dienst nicht Teil einer Virtual Network ist, extern bedeutet, dass die API Management Bereitstellung in einem Virtual Network mit einem Endpunkt mit Internetverkn; und Intern bedeutet, dass API Management Bereitstellung in einem Virtual Network nur über einen Endpunkt mit Intranetverkn. eingerichtet wird.
sku

SKU-Eigenschaften des API Management-Diensts.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.
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 anführen, woher die Ressource stammen muss.

ApiManagementServiceSkuProperties

API Management SKU-Eigenschaften der Dienstressource.

Name Type Description
capacity
  • integer

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

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 Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

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

Name Type Description
minApiVersion
  • string

Beschränken Sie API-Aufrufe auf Steuerungsebene an API Management Dienst mit einer Version, die größer oder gleich diesem Wert ist.

ArmIdWrapper

Ein Wrapper für eine ARM-Ressourcen-ID

Name Type Description
id
  • string

CertificateConfiguration

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

Name Type Description
certificate

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 Type Description
expiry
  • string

Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß iso 8601-Standard.
subject
  • string

Antragsteller des Zertifikats.
thumbprint
  • string

Fingerabdruck des Zertifikats

CertificateSource

Zertifikatquelle.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

Zertifikatstatus.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.
message
  • string

Lesbare Darstellung von Fehlern auf Eigenschaftsebene.
target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

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

Die Liste ungültiger Felder, die bei einem Validierungsfehler in der Anforderung gesendet werden.
error.message
  • string

Lesbare Darstellung des Fehlers.

HostnameConfiguration

Benutzerdefinierte Hostnamenkonfiguration.

Name Type Description
certificate

Zertifikatinformationen.
certificatePassword
  • string

Zertifikatkennwort.
certificateSource

Zertifikatquelle.
certificateStatus

Zertifikatstatus.
defaultSslBinding
  • boolean

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

Base64-codiertes Zertifikat.
hostName
  • string

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

Client-ID der vom System oder Benutzer zugewiesenen verwalteten Identität, wie von Azure AD generiert, die ÜBER GET-Zugriff auf keyVault verfügt, der das SSL-Zertifikat enthält.
keyVaultId
  • string

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

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

Hostname-Typ.

HostnameType

Hostname-Typ.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

Computeplattformversion, auf der der Dienst ausgeführt wird.

Name Type Description
mtv1
  • string

Plattform, auf der der Dienst auf plattformübergreifender Version 1 ausgeführt wird.
stv1
  • string

Plattform, auf der der Dienst auf der Einzelinstanzplattform V1 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

Der Verbindungsstatus des privaten Endpunkts.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstverbraucher und dem Anbieter.

Name Type Description
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

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, muss jedoch , wenn er übergeben wird, "Enabled" oder "Disabled" sein. Bei "Disabled" sind private Endpunkte die exklusive Zugriffsmethode. Der Standardwert ist "Enabled".

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

Verbindungsressource für private Remoteendpunkte.

Name Type Description
id
  • string

Id der Verbindungsressource des privaten Endpunkts
name
  • string

Verbindungsname des privaten Endpunkts
properties.groupIds
  • string[]

Alle Gruppen-IDs.
properties.privateEndpoint

Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState

Eine Auflistung von Informationen über den Zustand der Verbindung zwischen dem Dienstverbraucher und dem Anbieter.
properties.provisioningState
  • string

Der Bereitstellungsstatus der Verbindungsressource des privaten Endpunkts.
type
  • string

Verbindungsressourcentyp des privaten Endpunkts

SkuType

Name der SKU.

Name Type Description
Basic
  • string

Grundlegende SKU von Api Management.
Consumption
  • string

Nutzungs-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 zur Erstellung und letzten Änderung der Ressource.

Name Type Description
createdAt
  • string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy
  • string

Die Identität, die die Ressource erstellt hat.
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

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

UserIdentityProperties

Name Type Description
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 Type Description
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. Erwarten Sie 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 einer Virtual Network ist, extern bedeutet, dass die API Management Bereitstellung in einem Virtual Network mit einem Endpunkt mit Internetverkn; und Intern bedeutet, dass API Management Bereitstellung in einem Virtual Network nur über einen Endpunkt mit Intranetverkn. eingerichtet wird.

Name Type Description
External
  • string

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

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

Der Dienst ist nicht Teil einer Virtual Network.