Api Management Service - Backup
Erstellt eine Sicherung des API-Verwaltungsdiensts für das angegebene Azure Storage-Konto. Dies ist ein lang ausgeführter Vorgang und kann mehrere Minuten dauern.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2024-05-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Der Name des API-Verwaltungsdiensts. |
subscription
|
path | True |
string (uuid) |
Die ID des Zielabonnements. Der Wert muss eine UUID sein. |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
backupName | True |
string |
Der Name der sicherungsdatei, die erstellt/abgerufen werden soll. |
containerName | True |
string |
Der Name des BLOB-Containers (wird verwendet, um die Sicherung zu platzieren/abzurufen). |
storageAccount | True |
string |
Der Name des Azure-Speicherkontos (wird zum Platzieren/Abrufen der Sicherung verwendet). |
accessKey |
string |
Zugriffsschlüssel für Speicherkonto. Nur erforderlich, wenn |
|
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 |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der API-Verwaltungsdienst wurde erfolgreich mit dem Speicherkonto gesichert. |
|
202 Accepted |
Akzeptiert: Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft werden kann. Header location: string |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Api |
Api |
Api |
ApiManagementBackupWithAccessKey
Beispielanforderung
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01
{
"storageAccount": "teststorageaccount",
"containerName": "backupContainer",
"backupName": "apimService1backup_2017_03_19",
"accessType": "AccessKey",
"accessKey": "**************************************************"
}
Beispiel für eine Antwort
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
},
{
"type": "ConfigurationApi",
"hostName": "configuration-api.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
}
}
ApiManagementBackupWithSystemManagedIdentity
Beispielanforderung
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01
{
"storageAccount": "contosorpstorage",
"containerName": "apim-backups",
"backupName": "backup5",
"accessType": "SystemAssignedManagedIdentity"
}
Beispiel für eine Antwort
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "apimService1"
},
"location": "Central US EUAP",
"etag": "AAAAAAAQM8o=",
"properties": {
"publisherEmail": "apimService1@corp.microsoft.com",
"publisherName": "MS",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2020-04-23T16:26:47.8637967Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
"certificateSource": "BuiltIn"
}
],
"publicIPAddresses": [
"52.XXXX.160.66"
],
"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,
"publicNetworkAccess": "Enabled",
"platformVersion": "stv1"
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
"tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
"principalId": "00000000-a100-4478-0000-d65d98118ba0",
"clientId": "00000000-a154-4830-0000-46a12da1a1e2"
},
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
"principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
"clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
}
}
},
"systemData": {
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
}
}
ApiManagementBackupWithUserAssignedManagedIdentity
Beispielanforderung
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01
{
"storageAccount": "contosorpstorage",
"containerName": "apim-backups",
"backupName": "backup5",
"accessType": "UserAssignedManagedIdentity",
"clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}
Beispiel für eine Antwort
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "apimService1"
},
"location": "Central US EUAP",
"etag": "AAAAAAAQM8o=",
"properties": {
"publisherEmail": "apimService1@corp.microsoft.com",
"publisherName": "MS",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2020-04-23T16:26:47.8637967Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
"certificateSource": "BuiltIn"
}
],
"publicIPAddresses": [
"52.XXXX.160.66"
],
"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,
"publicNetworkAccess": "Enabled",
"platformVersion": "stv1"
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
"tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
"principalId": "00000000-a100-4478-0000-d65d98118ba0",
"clientId": "00000000-a154-4830-0000-46a12da1a1e2"
},
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
"principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
"clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
}
}
},
"systemData": {
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
}
}
Definitionen
Name | Beschreibung |
---|---|
Access |
Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll. |
Additional |
Beschreibung eines zusätzlichen RESSOURCENspeicherorts für die API-Verwaltung. |
Api |
Parameter, die für die Sicherung/Wiederherstellung eines API-Verwaltungsdienstvorgangs bereitgestellt werden. |
Api |
Identitätseigenschaften der Api-Verwaltungsdienstressource. |
Api |
Eine einzelne API-Verwaltungsdienstressource in "List" oder "Get response". |
Api |
SKU-Eigenschaften des API-Verwaltungsdiensts. |
Apim |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. |
Api |
Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst. |
Arm |
Ein Wrapper für eine ARM-Ressourcen-ID |
Certificate |
Zertifikatkonfiguration, die aus nicht vertrauenswürdigen Zwischen- und Stammzertifikaten besteht. |
Certificate |
SSL-Zertifikatinformationen. |
Certificate |
Zertifikatquelle. |
Certificate |
Zertifikatstatus. |
Configuration |
Informationen zur Konfigurations-API des API-Verwaltungsdiensts. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
developer |
Status des Entwicklerportals in diesem API-Verwaltungsdienst. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
Hostname |
Konfiguration des benutzerdefinierten Hostnamens. |
Hostname |
Hostnamentyp. |
Legacy |
Gibt an, ob die ältere Konfigurations-API (v1) im API-Verwaltungsdienst verfügbar gemacht werden soll. Der Wert ist optional, muss aber "Aktiviert" oder "Deaktiviert" sein. Wenn "Deaktiviert" ist die Legacykonfigurations-API (v1) für selbst gehostete Gateways nicht verfügbar. Standardwert ist 'Enabled' |
Legacy |
Status des Legacyportals im API-Verwaltungsdienst. |
Nat |
Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden. |
Platform |
Compute Platform Version, die den Dienst ausführt. |
Private |
Der Status der privaten Endpunktverbindung. |
Private |
Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider. |
Public |
Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled' |
Remote |
Remote-Private Endpoint Connection-Ressource. |
Sku |
Name der Sku. |
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
User |
|
Virtual |
Konfiguration eines virtuellen Netzwerks, für das der API-Verwaltungsdienst bereitgestellt wird. |
Virtual |
Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt. |
AccessType
Der Typ des Zugriffs, der für das Speicherkonto verwendet werden soll.
Wert | Beschreibung |
---|---|
AccessKey |
Zugriffstaste verwenden. |
SystemAssignedManagedIdentity |
Verwenden Sie die vom System zugewiesene verwaltete Identität. |
UserAssignedManagedIdentity |
Verwenden Sie die vom Benutzer zugewiesene verwaltete Identität. |
AdditionalLocation
Beschreibung eines zusätzlichen RESSOURCENspeicherorts für die API-Verwaltung.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
disableGateway |
boolean |
False |
Eigenschaft gilt nur für einen API-Verwaltungsdienst, 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-Verwaltungsdiensts in der Region. |
|
location |
string |
Der Standortname der zusätzlichen Region zwischen Azure Data Center-Regionen. |
|
natGatewayState | Disabled |
Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden. |
|
outboundPublicIPAddresses |
string[] |
Präfixe für ausgehende öffentliche IPV4-Adressen, die mit dem bereitgestellten NAT-Gatewaydienst verknüpft sind. Nur für Premium-SKU auf stv2-Plattform verfügbar. |
|
platformVersion |
Compute Platform Version, die den Dienst ausführt. |
||
privateIPAddresses |
string[] |
Private Static Load Balanced IP-Adressen des API-Verwaltungsdiensts, der an einem bestimmten zusätzlichen Speicherort in einem internen virtuellen Netzwerk bereitgestellt wird. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar. |
|
publicIPAddresses |
string[] |
Ip-Adressen des API-Verwaltungsdiensts für öffentliche statische Lastenausgleich am zusätzlichen Speicherort. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar. |
|
publicIpAddressId |
string |
Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem bereitgestellten Virtuellen Netzwerkdienst am Standort zugeordnet werden soll. Wird nur für Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt wird. |
|
sku |
SKU-Eigenschaften des API-Verwaltungsdiensts. |
||
virtualNetworkConfiguration |
Konfiguration des virtuellen Netzwerks für den Speicherort. |
||
zones |
string[] |
Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss. |
ApiManagementServiceBackupRestoreParameters
Parameter, die für die Sicherung/Wiederherstellung eines API-Verwaltungsdienstvorgangs bereitgestellt werden.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
accessKey |
string |
Zugriffsschlüssel für Speicherkonto. Nur erforderlich, wenn |
|
accessType | AccessKey |
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 |
|
containerName |
string |
Der Name des BLOB-Containers (wird verwendet, um die Sicherung zu platzieren/abzurufen). |
|
storageAccount |
string |
Der Name des Azure-Speicherkontos (wird zum Platzieren/Abrufen der Sicherung verwendet). |
ApiManagementServiceIdentity
Identitätseigenschaften der Api-Verwaltungsdienstressource.
Name | Typ | Beschreibung |
---|---|---|
principalId |
string (uuid) |
Die Prinzipal-ID der Identität. |
tenantId |
string (uuid) |
Die Clientmandanten-ID der Identität. |
type |
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. |
|
userAssignedIdentities |
<string,
User |
Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". |
ApiManagementServiceResource
Eine einzelne API-Verwaltungsdienstressource in "List" oder "Get response".
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
etag |
string |
ETag der Ressource. |
|
id |
string |
Ressourcen-ID. |
|
identity |
Verwaltete Dienstidentität des API-Verwaltungsdiensts. |
||
location |
string |
Ressourcenspeicherort. |
|
name |
string |
Ressourcenname. |
|
properties.additionalLocations |
Zusätzliche Rechenzentrumsspeicherorte des API-Verwaltungsdiensts. |
||
properties.apiVersionConstraint |
Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst. |
||
properties.certificates |
Liste der Zertifikate, die im API-Verwaltungsdienst installiert werden müssen. Maximal unterstützte Zertifikate, die installiert werden können, sind 10. |
||
properties.configurationApi |
Konfigurations-API-Konfiguration des API-Verwaltungsdiensts. |
||
properties.createdAtUtc |
string (date-time) |
Erstellung des UTC-Datums des API-Verwaltungsdiensts. Das Datum entspricht dem folgenden Format: |
|
properties.customProperties |
object |
Benutzerdefinierte Eigenschaften des API-Verwaltungsdiensts. |
|
properties.developerPortalStatus | Enabled |
Status des Entwicklerportals in diesem API-Verwaltungsdienst. |
|
properties.developerPortalUrl |
string |
DEveloper Portal-Endpunkt-URL des API-Verwaltungsdiensts. |
|
properties.disableGateway |
boolean |
False |
Eigenschaft gilt nur für einen API-Verwaltungsdienst, der an mehreren Standorten bereitgestellt wird. Dies kann verwendet werden, um das Gateway im Masterbereich zu deaktivieren. |
properties.enableClientCertificate |
boolean |
False |
Eigenschaft, die nur für den Verbrauch-SKU-Dienst verwendet werden soll. Dadurch wird für jede Anforderung an das Gateway ein Clientzertifikat erzwungen. Dies ermöglicht auch die Authentifizierung des Zertifikats in der Richtlinie auf dem Gateway. |
properties.gatewayRegionalUrl |
string |
Gateway-URL des API-Verwaltungsdiensts in der Standardregion. |
|
properties.gatewayUrl |
string |
Gateway-URL des API-Verwaltungsdiensts. |
|
properties.hostnameConfigurations |
Benutzerdefinierte Hostnamenkonfiguration des API-Verwaltungsdiensts. |
||
properties.legacyPortalStatus | Enabled |
Status des Legacyportals im API-Verwaltungsdienst. |
|
properties.managementApiUrl |
string |
Url des Verwaltungs-API-Endpunkts des API-Verwaltungsdiensts. |
|
properties.natGatewayState | Disabled |
Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden. |
|
properties.notificationSenderEmail |
string maxLength: 100 |
E-Mail-Adresse, von der die Benachrichtigung gesendet wird. |
|
properties.outboundPublicIPAddresses |
string[] |
Präfixe für ausgehende öffentliche IPV4-Adressen, die mit dem bereitgestellten NAT-Gatewaydienst verknüpft sind. Nur für Premium-SKU auf stv2-Plattform verfügbar. |
|
properties.platformVersion |
Compute Platform Version, die den Dienst an diesem Speicherort ausführt. |
||
properties.portalUrl |
string |
Endpunkt-URL des Publisher-Portalendpunkts des API-Verwaltungsdiensts. |
|
properties.privateEndpointConnections |
Liste der privaten Endpunktverbindungen dieses Diensts. |
||
properties.privateIPAddresses |
string[] |
Private Static Load Balanced IP-Adressen des API-Verwaltungsdiensts in der primären Region, die in einem internen virtuellen Netzwerk bereitgestellt wird. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar. |
|
properties.provisioningState |
string |
Der aktuelle Bereitstellungsstatus des API-Verwaltungsdiensts, der eine der folgenden Sein kann: Created/Activating/Succeeded/Updating/Failed/Stopped/Endating/TerminationFailed/Deleted. |
|
properties.publicIPAddresses |
string[] |
Öffentliche IP-Adressen für statische Lastenausgleich des API-Verwaltungsdiensts in der primären Region. Nur für Standard-, Standard-, Premium- und isolierte SKU verfügbar. |
|
properties.publicIpAddressId |
string |
Öffentliche SKU-IP-V4-basierte IP-Adresse, die dem in der Region bereitgestellten virtuellen Netzwerkdienst zugeordnet werden soll. Wird nur für Entwickler- und Premium-SKU unterstützt, die im virtuellen Netzwerk bereitgestellt werden. |
|
properties.publicNetworkAccess |
Gibt an, ob der Zugriff auf öffentliche Endpunkte für diesen API-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled' |
||
properties.publisherEmail |
string maxLength: 100 |
Publisher-E-Mail. |
|
properties.publisherName |
string maxLength: 100 |
Herausgebername. |
|
properties.restore |
boolean |
False |
Rückgängigmachen des API-Verwaltungsdiensts, 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-Verwaltungsdiensts. |
|
properties.targetProvisioningState |
string |
Der Bereitstellungsstatus des API-Verwaltungsdiensts, der auf den für den Dienst gestarteten lang ausgeführten Vorgang ausgerichtet ist. |
|
properties.virtualNetworkConfiguration |
Virtuelle Netzwerkkonfiguration des API-Verwaltungsdiensts. |
||
properties.virtualNetworkType | None |
Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt. |
|
sku |
SKU-Eigenschaften des API-Verwaltungsdiensts. |
||
systemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
||
tags |
object |
Ressourcentags. |
|
type |
string |
Der Ressourcentyp für die API-Verwaltungsressource ist auf "Microsoft.ApiManagement" festgelegt. |
|
zones |
string[] |
Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen muss. |
ApiManagementServiceSkuProperties
SKU-Eigenschaften des API-Verwaltungsdiensts.
Name | Typ | Beschreibung |
---|---|---|
capacity |
integer (int32) |
Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU). Für den Verbrauch muss die SKU-Kapazität als 0 angegeben werden. |
name |
Name der Sku. |
ApimIdentityType
Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Gruppe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst.
Wert | Beschreibung |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
ApiVersionConstraint
Steuern der Api-Versionsbeschränkung für den API-Verwaltungsdienst.
Name | Typ | Beschreibung |
---|---|---|
minApiVersion |
string |
Beschränken Sie die API-Aufrufe der Steuerebene an den API-Verwaltungsdienst mit der version gleich oder neuer als diesem Wert. |
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 |
Zertifikatinformationen. |
|
certificatePassword |
string |
Zertifikatkennwort. |
encodedCertificate |
string |
Base64-Codiertes Zertifikat. |
storeName |
enum:
|
Der Speicherort des System.Security.Cryptography.x509certificates.StoreName-Zertifikatspeicherorts. Nur Stamm- und Zertifikatautorität sind gültige Speicherorte. |
CertificateInformation
SSL-Zertifikatinformationen.
Name | Typ | Beschreibung |
---|---|---|
expiry |
string (date-time) |
Ablaufdatum des Zertifikats. Das Datum entspricht dem folgenden Format: |
subject |
string |
Betreff des Zertifikats. |
thumbprint |
string |
Fingerabdruck des Zertifikats. |
CertificateSource
Zertifikatquelle.
Wert | Beschreibung |
---|---|
BuiltIn | |
Custom | |
KeyVault | |
Managed |
CertificateStatus
Zertifikatstatus.
Wert | Beschreibung |
---|---|
Completed | |
Failed | |
InProgress |
ConfigurationApi
Informationen zur Konfigurations-API des API-Verwaltungsdiensts.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
legacyApi | Enabled |
Gibt an, ob die ältere Konfigurations-API (v1) im API-Verwaltungsdienst verfügbar gemacht werden soll. Der Wert ist optional, muss aber "Aktiviert" oder "Deaktiviert" sein. Wenn "Deaktiviert" ist die Legacykonfigurations-API (v1) für selbst gehostete Gateways nicht verfügbar. Standardwert ist 'Enabled' |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
developerPortalStatus
Status des Entwicklerportals in diesem API-Verwaltungsdienst.
Wert | Beschreibung |
---|---|
Disabled |
Das Entwicklerportal ist für den Dienst deaktiviert. |
Enabled |
Das Entwicklerportal ist für den Dienst aktiviert. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
HostnameConfiguration
Konfiguration des benutzerdefinierten Hostnamens.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
certificate |
Zertifikatinformationen. |
||
certificatePassword |
string |
Zertifikatkennwort. |
|
certificateSource |
Zertifikatquelle. |
||
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, ist dies das Zertifikat, das herausfordert wird. Die Eigenschaft ist nützlich, wenn ein Dienst mehrere benutzerdefinierte Hostnamen aktiviert hat und es für das Standard-SSL-Zertifikat entscheiden muss. Die Einstellung wurde nur auf den Hostnamentyp des Gateways angewendet. |
encodedCertificate |
string |
Base64-Codiertes Zertifikat. |
|
hostName |
string |
Hostname, der für den API-Verwaltungsdienst konfiguriert werden soll. |
|
identityClientId |
string |
Vom System oder vom Benutzer zugewiesene verwaltete Identitäts-ClientId, die von Azure AD generiert wird, die GET-Zugriff auf den KeyVault hat, der das SSL-Zertifikat enthält. |
|
keyVaultId |
string |
Url zum Schlüsselschlüsselschlüssel, der das Ssl-Zertifikat enthält. Wenn absolute URL mit Version bereitgestellt wird, funktioniert die automatische Aktualisierung des SSL-Zertifikats nicht. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden. Der geheime Schlüssel sollte vom Typ anwendung/x-pkcs12 sein. |
|
negotiateClientCertificate |
boolean |
False |
Geben Sie true an, um das Clientzertifikat immer auf dem Hostnamen auszuhandeln. Der Standardwert ist "false". |
type |
Hostnamentyp. |
HostnameType
Hostnamentyp.
Wert | Beschreibung |
---|---|
ConfigurationApi | |
DeveloperPortal | |
Management | |
Portal | |
Proxy | |
Scm |
LegacyApiState
Gibt an, ob die ältere Konfigurations-API (v1) im API-Verwaltungsdienst verfügbar gemacht werden soll. Der Wert ist optional, muss aber "Aktiviert" oder "Deaktiviert" sein. Wenn "Deaktiviert" ist die Legacykonfigurations-API (v1) für selbst gehostete Gateways nicht verfügbar. Standardwert ist 'Enabled'
Wert | Beschreibung |
---|---|
Disabled |
Die Legacykonfigurations-API (v1) ist für den Dienst deaktiviert, und selbst gehostete Gateways können keine Verbindung damit herstellen. |
Enabled |
Die Legacykonfigurations-API (v1) ist für den Dienst aktiviert, und selbst gehostete Gateways können eine Verbindung damit herstellen. |
LegacyPortalStatus
Status des Legacyportals im API-Verwaltungsdienst.
Wert | Beschreibung |
---|---|
Disabled |
Legacyportal ist für den Dienst deaktiviert. |
Enabled |
Legacyportal ist für den Dienst aktiviert. |
NatGatewayState
Die Eigenschaft kann zum Aktivieren des NAT-Gateways für diesen API-Verwaltungsdienst verwendet werden.
Wert | Beschreibung |
---|---|
Disabled |
Nat-Gateway ist für den Dienst deaktiviert. |
Enabled |
Nat-Gateway ist für den Dienst aktiviert. |
PlatformVersion
Compute Platform Version, die den Dienst ausführt.
Wert | Beschreibung |
---|---|
mtv1 |
Plattform, die den Dienst auf der Multimandanten-V1-Plattform ausführt. |
stv1 |
Plattform, auf der der Dienst auf der V1-Plattform mit einem einzigen Mandanten ausgeführt wird. |
stv2 |
Plattform, auf der der Dienst auf der V2-Plattform des einzelnen Mandanten ausgeführt wird. |
stv2.1 |
Plattform, die den Dienst auf der V2-Plattform für einen einzelnen Mandanten auf neuerer Hardware ausführt. |
undetermined |
Die Plattformversion kann nicht bestimmt werden, da keine Computeplattform bereitgestellt wird. |
PrivateEndpointServiceConnectionStatus
Der Status der privaten Endpunktverbindung.
Wert | Beschreibung |
---|---|
Approved | |
Pending | |
Rejected |
PrivateLinkServiceConnectionState
Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
Name | Typ | Beschreibung |
---|---|---|
actionsRequired |
string |
Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher 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-Verwaltungsdienst zulässig ist. Der Wert ist optional, aber wenn er übergeben wird, muss 'Aktiviert' oder 'Deaktiviert' sein. Wenn "Deaktiviert", sind private Endpunkte die exklusive Zugriffsmethode. Standardwert ist 'Enabled'
Wert | Beschreibung |
---|---|
Disabled | |
Enabled |
RemotePrivateEndpointConnectionWrapper
Remote-Private Endpoint Connection-Ressource.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID für private Endpunktverbindung |
name |
string |
Name der privaten Endpunktverbindung |
properties.groupIds |
string[] |
Alle Gruppen-IDs. |
properties.privateEndpoint |
Die Ressource des privaten Endpunkts. |
|
properties.privateLinkServiceConnectionState |
Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider. |
|
properties.provisioningState |
string |
Der Bereitstellungsstatus der privaten Endpunktverbindungsressource. |
type |
string |
Ressourcentyp für private Endpunktverbindung |
SkuType
Name der Sku.
Wert | Beschreibung |
---|---|
Basic |
Grundlegende SKU der API-Verwaltung. |
BasicV2 |
BasicV2-SKU der API-Verwaltung. |
Consumption |
Verbrauchs-SKU der API-Verwaltung. |
Developer |
Entwickler-SKU der API-Verwaltung. |
Isolated |
Isolierte SKU der API-Verwaltung. |
Premium |
Premium-SKU der API-Verwaltung. |
Standard |
Standard-SKU der API-Verwaltung. |
StandardV2 |
StandardV2-SKU der Api-Verwaltung. |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
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 (date-time) |
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 | 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, für das der API-Verwaltungsdienst bereitgestellt wird.
Name | Typ | Beschreibung |
---|---|---|
subnetResourceId |
string pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$ |
Die vollständige Ressourcen-ID eines Subnetzes in einem virtuellen Netzwerk, in dem der API-Verwaltungsdienst bereitgestellt wird. |
subnetname |
string |
Der Name des Subnetzes. |
vnetid |
string |
Die ID des virtuellen Netzwerks. Dies ist in der Regel eine GUID. Erwartet standardmäßig eine NULL-GUID. |
VirtualNetworkType
Der Typ des VPN, in dem der API-Verwaltungsdienst konfiguriert werden muss. None (Standardwert) bedeutet, dass der API-Verwaltungsdienst nicht Teil eines virtuellen Netzwerks ist, extern bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das über einen internetgerichteten Endpunkt verfügt, und "Intern" bedeutet, dass die API-Verwaltungsbereitstellung innerhalb eines virtuellen Netzwerks eingerichtet ist, das nur über einen Intranet-Endpunkt verfügt.
Wert | Beschreibung |
---|---|
External |
Der Dienst ist Teil des virtuellen Netzwerks und kann über das Internet zugänglich sein. |
Internal |
Der Dienst ist Teil des virtuellen Netzwerks und kann nur über das virtuelle Netzwerk zugänglich sein. |
None |
Der Dienst ist nicht Teil eines virtuellen Netzwerks. |