Api Management Service - Restore

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee herstelt u een back-up van een API Management-service die is gemaakt met behulp van de ApiManagementService_Backup bewerking op de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
backupName	True	string	De naam van het back-upbestand dat moet worden gemaakt/opgehaald.
containerName	True	string	De naam van de blobcontainer (wordt gebruikt om de back-up te plaatsen/op te halen).
storageAccount	True	string	De naam van het Azure-opslagaccount (wordt gebruikt om de back-up te plaatsen/op te halen).
accessKey		string	Toegangssleutel voor opslagaccount. Alleen vereist als `accessType` is ingesteld op `AccessKey`.
accessType		AccessType	Het type toegang dat moet worden gebruikt voor het opslagaccount.
clientId		string	De client-id van door de gebruiker toegewezen beheerde identiteit. Alleen vereist als `accessType` is ingesteld op `UserAssignedManagedIdentity`.

Antwoorden

Name	Type	Description
200 OK	ApiManagementServiceResource	De back-up is hersteld naar de API Management-service.
202 Accepted		Geaccepteerd: De locatieheader bevat de URL waar de status van de langdurige bewerking kan worden gecontroleerd. Kopteksten location: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

ApiManagementServiceResource

De back-up is hersteld naar de API Management-service.

202 Accepted

Geaccepteerd: De locatieheader bevat de URL waar de status van de langdurige bewerking kan worden gecontroleerd.

Kopteksten

location: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementRestoreService

Voorbeeldaanvraag

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2024-05-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Voorbeeldrespons

Statuscode:: 202

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

Statuscode:: 200

{
  "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": "config-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
  }
}

Definities

Name	Description
AccessType	Het type toegang dat moet worden gebruikt voor het opslagaccount.
AdditionalLocation	Beschrijving van een extra API Management-resourcelocatie.
ApiManagementServiceBackupRestoreParameters	Parameters die zijn opgegeven bij de back-up/herstel van een API Management-servicebewerking.
ApiManagementServiceIdentity	Identiteitseigenschappen van de Api Management-serviceresource.
ApiManagementServiceResource	Eén API Management-serviceresource in Lijst of Antwoord ophalen.
ApiManagementServiceSkuProperties	SKU-eigenschappen voor API Management-serviceresources.
ApimIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
ApiVersionConstraint	Besturingselementvlak api's versiebeperking voor de API Management-service.
ArmIdWrapper	Een wrapper voor een ARM-resource-id
CertificateConfiguration	Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenliggende en basiscertificaten.
CertificateInformation	SSL-certificaatgegevens.
CertificateSource	Certificaatbron.
CertificateStatus	Certificaatstatus.
ConfigurationApi	Informatie over de configuratie-API van de API Management-service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
developerPortalStatus	Status van ontwikkelaarsportal in deze API Management-service.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HostnameConfiguration	Aangepaste hostnaamconfiguratie.
HostnameType	Type hostnaam.
LegacyApiState	Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld
LegacyPortalStatus	Status van verouderde portal in de API Management-service.
NatGatewayState	De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
PlatformVersion	Compute Platform-versie waarop de service wordt uitgevoerd.
PrivateEndpointServiceConnectionStatus	De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
PublicNetworkAccess	Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
RemotePrivateEndpointConnectionWrapper	Externe privé-eindpuntverbindingsresource.
SkuType	Naam van de SKU.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserIdentityProperties
VirtualNetworkConfiguration	Configuratie van een virtueel netwerk waarnaar de API Management-service wordt geïmplementeerd.
VirtualNetworkType	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.

AccessType

Inventarisatie

Het type toegang dat moet worden gebruikt voor het opslagaccount.

Waarde	Description
AccessKey	Gebruik de toegangssleutel.
SystemAssignedManagedIdentity	Gebruik door het systeem toegewezen beheerde identiteit.
UserAssignedManagedIdentity	Gebruik door de gebruiker toegewezen beheerde identiteit.

AdditionalLocation

Object

Beschrijving van een extra API Management-resourcelocatie.

Name	Type	Default value	Description
disableGateway	boolean	False	De eigenschap is alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen.
gatewayRegionalUrl	string		Gateway-URL van de API Management-service in de regio.
location	string		De locatienaam van de extra regio tussen Azure Data Center-regio's.
natGatewayState	NatGatewayState	Disabled	De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
outboundPublicIPAddresses	string[]		Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de nat-gateway geïmplementeerde service. Alleen beschikbaar voor Premium SKU op stv2-platform.
platformVersion	PlatformVersion		Compute Platform-versie waarop de service wordt uitgevoerd.
privateIPAddresses	string[]		Privé statische IP-adressen met gelijke taakverdeling van de API Management-service die in een intern virtueel netwerk op een bepaalde extra locatie wordt geïmplementeerd. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU.
publicIPAddresses	string[]		Openbare STATISCHE IP-adressen met gelijke taakverdeling van de API Management-service op de extra locatie. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU.
publicIpAddressId	string		Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service virtual network geïmplementeerd op de locatie. Alleen ondersteund voor Premium SKU die wordt geïmplementeerd in Virtual Network.
sku	ApiManagementServiceSkuProperties		SKU-eigenschappen van de API Management-service.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuratie van virtueel netwerk voor de locatie.
zones	string[]		Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen.

ApiManagementServiceBackupRestoreParameters

Object

Parameters die zijn opgegeven bij de back-up/herstel van een API Management-servicebewerking.

Name	Type	Default value	Description
accessKey	string		Toegangssleutel voor opslagaccount. Alleen vereist als `accessType` is ingesteld op `AccessKey`.
accessType	AccessType	AccessKey	Het type toegang dat moet worden gebruikt voor het opslagaccount.
backupName	string		De naam van het back-upbestand dat moet worden gemaakt/opgehaald.
clientId	string		De client-id van door de gebruiker toegewezen beheerde identiteit. Alleen vereist als `accessType` is ingesteld op `UserAssignedManagedIdentity`.
containerName	string		De naam van de blobcontainer (wordt gebruikt om de back-up te plaatsen/op te halen).
storageAccount	string		De naam van het Azure-opslagaccount (wordt gebruikt om de back-up te plaatsen/op te halen).

ApiManagementServiceIdentity

Object

Identiteitseigenschappen van de Api Management-serviceresource.

Name	Type	Description
principalId	string (uuid)	De principal-id van de identiteit.
tenantId	string (uuid)	De tenant-id van de client van de identiteit.
type	ApimIdentityType	Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities	<string, UserIdentityProperties>	De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ApiManagementServiceResource

Object

Eén API Management-serviceresource in Lijst of Antwoord ophalen.

Name	Type	Default value	Description
etag	string		ETag van de resource.
id	string		Resource-id.
identity	ApiManagementServiceIdentity		Beheerde service-identiteit van de Api Management-service.
location	string		Resourcelocatie.
name	string		Resourcenaam.
properties.additionalLocations	AdditionalLocation[]		Aanvullende datacenterlocaties van de API Management-service.
properties.apiVersionConstraint	ApiVersionConstraint		Besturingselementvlak api's versiebeperking voor de API Management-service.
properties.certificates	CertificateConfiguration[]		Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd, is 10.
properties.configurationApi	ConfigurationApi		Configuratie-API-configuratie van de API Management-service.
properties.createdAtUtc	string (date-time)		Utc-datum van de API Management-service maken. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.customProperties	object		Aangepaste eigenschappen van de API Management-service. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitschakelt. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan worden gebruikt om alleen TLS 1.1 uit te schakelen. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends. Instelling `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service. Als u geen van deze eigenschappen opgeeft bij DE PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde `True` als de service is gemaakt op of vóór 1 april 2018 en anders `False`. De standaardwaarde van http2-instelling is `False`. U kunt een van de volgende coderingen uitschakelen met behulp van instellingen `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`: 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. Bijvoorbeeld: `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. De standaardwaarde is `true` voor deze waarden. Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist voor interne platformonderdelen: 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.developerPortalStatus	developerPortalStatus	Enabled	Status van ontwikkelaarsportal in deze API Management-service.
properties.developerPortalUrl	string		Eindpunt-URL van DEveloper Portal van de API Management-service.
properties.disableGateway	boolean	False	De eigenschap is alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen.
properties.enableClientCertificate	boolean	False	De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.
properties.gatewayRegionalUrl	string		Gateway-URL van de API Management-service in de standaardregio.
properties.gatewayUrl	string		Gateway-URL van de API Management-service.
properties.hostnameConfigurations	HostnameConfiguration[]		Aangepaste hostnaamconfiguratie van de API Management-service.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status van verouderde portal in de API Management-service.
properties.managementApiUrl	string		Eindpunt-URL voor beheer-API van de API Management-service.
properties.natGatewayState	NatGatewayState	Disabled	De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
properties.notificationSenderEmail	string maxLength: 100		E-mailadres van waaruit de melding wordt verzonden.
properties.outboundPublicIPAddresses	string[]		Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de nat-gateway geïmplementeerde service. Alleen beschikbaar voor Premium SKU op stv2-platform.
properties.platformVersion	PlatformVersion		Compute Platform-versie waarop de service op deze locatie wordt uitgevoerd.
properties.portalUrl	string		Eindpunt-URL van de Publisher-portal van de API Management-service.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lijst met privé-eindpuntverbindingen van deze service.
properties.privateIPAddresses	string[]		Privé-IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio die wordt geïmplementeerd in een intern virtueel netwerk. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU.
properties.provisioningState	string		De huidige inrichtingsstatus van de API Management-service die een van de volgende opties kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Beëindigen/Beëindigen/BeëindigingFailed/Verwijderd.
properties.publicIPAddresses	string[]		Openbare STATISCHE IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU.
properties.publicIpAddressId	string		Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
properties.publisherEmail	string maxLength: 100		E-mail van Publisher.
properties.publisherName	string maxLength: 100		Naam van uitgever.
properties.restore	boolean	False	De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd.
properties.scmUrl	string		SCM-eindpunt-URL van de API Management-service.
properties.targetProvisioningState	string		De inrichtingsstatus van de API Management-service, waarop de langdurige bewerking is gestart op de service.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuratie van virtueel netwerk van de API Management-service.
properties.virtualNetworkType	VirtualNetworkType	None	Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.
sku	ApiManagementServiceSkuProperties		SKU-eigenschappen van de API Management-service.
systemData	systemData		Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
tags	object		Resourcetags.
type	string		Resourcetype voor API Management-resource is ingesteld op Microsoft.ApiManagement.
zones	string[]		Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen.

ApiManagementServiceSkuProperties

Object

SKU-eigenschappen voor API Management-serviceresources.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor verbruiks-SKU-capaciteit moet worden opgegeven als 0.
name	SkuType	Naam van de SKU.

ApimIdentityType

Inventarisatie

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Object

Besturingselementvlak api's versiebeperking voor de API Management-service.

Name	Type	Description
minApiVersion	string	Beperk API-aanroepen naar API Management-service met een versie die gelijk is aan of hoger is dan deze waarde.

ArmIdWrapper

Object

Een wrapper voor een ARM-resource-id

Name	Type	Description
id	string

CertificateConfiguration

Object

Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenliggende en basiscertificaten.

Name	Type	Description
certificate	CertificateInformation	Certificaatgegevens.
certificatePassword	string	Certificaatwachtwoord.
encodedCertificate	string	Base64 Gecodeerd certificaat.
storeName	enum: CertificateAuthority Root	De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen root en CertificateAuthority zijn geldige locaties.

CertificateInformation

Object

SSL-certificaatgegevens.

Name	Type	Description
expiry	string (date-time)	Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
subject	string	Onderwerp van het certificaat.
thumbprint	string	Vingerafdruk van het certificaat.

CertificateSource

Inventarisatie

Certificaatbron.

Waarde	Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Inventarisatie

Certificaatstatus.

Waarde	Description
Completed
Failed
InProgress

ConfigurationApi

Object

Informatie over de configuratie-API van de API Management-service.

Name	Type	Default value	Description
legacyApi	LegacyApiState	Enabled	Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

developerPortalStatus

Inventarisatie

Status van ontwikkelaarsportal in deze API Management-service.

Waarde	Description
Disabled	De ontwikkelaarsportal is uitgeschakeld voor de service.
Enabled	De ontwikkelaarsportal is ingeschakeld voor de service.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HostnameConfiguration

Object

Aangepaste hostnaamconfiguratie.

Name	Type	Default value	Description
certificate	CertificateInformation		Certificaatgegevens.
certificatePassword	string		Certificaatwachtwoord.
certificateSource	CertificateSource		Certificaatbron.
certificateStatus	CertificateStatus		Certificaatstatus.
defaultSslBinding	boolean	False	Geef true op voor het instellen van het certificaat dat is gekoppeld aan deze hostnaam als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, wordt dit het certificaat dat wordt aangeroepen. De eigenschap is handig als voor een service meerdere aangepaste hostnaam is ingeschakeld en moet worden bepaald welk standaard-SSL-certificaat moet worden gebruikt. De instelling wordt alleen toegepast op het hostnaamtype van de gateway.
encodedCertificate	string		Base64 Gecodeerd certificaat.
hostName	string		Hostnaam die moet worden geconfigureerd voor de Api Management-service.
identityClientId	string		Door het systeem of door de gebruiker toegewezen clientId van beheerde identiteit zoals gegenereerd door Azure AD, die GET-toegang heeft tot de sleutelkluis die het SSL-certificaat bevat.
keyVaultId	string		Url naar het KeyVault-geheim met het SSL-certificaat. Als er een absolute URL met versie wordt opgegeven, werkt automatisch bijwerken van ssl-certificaat niet. Hiervoor moet de Api Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12
negotiateClientCertificate	boolean	False	Geef waar op om altijd te onderhandelen over clientcertificaat op de hostnaam. De standaardwaarde is onwaar.
type	HostnameType		Type hostnaam.

HostnameType

Inventarisatie

Type hostnaam.

Waarde	Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Inventarisatie

Indicatie of de verouderde configuratie-API (v1) al dan niet moet worden weergegeven in de API Management-service. Waarde is optioneel, maar moet zijn ingeschakeld of uitgeschakeld. Als 'Uitgeschakeld' is, is verouderde configuratie-API (v1) niet beschikbaar voor zelf-hostende gateways. De standaardwaarde is Ingeschakeld

Waarde	Description
Disabled	Verouderde configuratie-API (v1) is uitgeschakeld voor de service en zelf-hostende gateways kunnen er geen verbinding mee maken.
Enabled	Verouderde configuratie-API (v1) is ingeschakeld voor de service en zelf-hostende gateways kunnen er verbinding mee maken.

LegacyPortalStatus

Inventarisatie

Status van verouderde portal in de API Management-service.

Waarde	Description
Disabled	Verouderde portal is uitgeschakeld voor de service.
Enabled	Verouderde portal is ingeschakeld voor de service.

NatGatewayState

Inventarisatie

De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.

Waarde	Description
Disabled	Nat Gateway is uitgeschakeld voor de service.
Enabled	Nat Gateway is ingeschakeld voor de service.

PlatformVersion

Inventarisatie

Compute Platform-versie waarop de service wordt uitgevoerd.

Waarde	Description
mtv1	Platform waarop de service wordt uitgevoerd op het platform multitenant V1.
stv1	Platform waarop de service wordt uitgevoerd op één tenant V1-platform.
stv2	Platform waarop de service wordt uitgevoerd op één tenant V2-platform.
stv2.1	Platform waarop de service wordt uitgevoerd op één tenant V2-platform op nieuwere hardware.
undetermined	De platformversie kan niet worden bepaald, omdat het rekenplatform niet is geïmplementeerd.

PrivateEndpointServiceConnectionStatus

Inventarisatie

De verbindingsstatus van het privé-eindpunt.

Waarde	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

Name	Type	Description
actionsRequired	string	Een bericht dat aangeeft of wijzigingen in de serviceprovider updates voor de consument vereisen.
description	string	De reden voor goedkeuring/afwijzing van de verbinding.
status	PrivateEndpointServiceConnectionStatus	Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

PublicNetworkAccess

Inventarisatie

Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Waarde is optioneel, maar als deze wordt doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als deze optie is uitgeschakeld, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld

Waarde	Description
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

Externe privé-eindpuntverbindingsresource.

Name	Type	Description
id	string	Resource-id voor privé-eindpuntverbinding
name	string	Naam van privé-eindpuntverbinding
properties.groupIds	string[]	Alle groeps-id's.
properties.privateEndpoint	ArmIdWrapper	De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.
properties.provisioningState	string	De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type	string	Resourcetype voor privé-eindpuntverbinding

SkuType

Inventarisatie

Naam van de SKU.

Waarde	Description
Basic	Eenvoudige SKU van Api Management.
BasicV2	BasicV2-SKU van Api Management.
Consumption	Verbruiks-SKU van Api Management.
Developer	Ontwikkelaars-SKU van Api Management.
Isolated	Geïsoleerde SKU van Api Management.
Premium	Premium SKU van Api Management.
Standard	Standaard-SKU van Api Management.
StandardV2	StandardV2-SKU van Api Management.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserIdentityProperties

Object

Name	Type	Description
clientId	string	De client-id van de door de gebruiker toegewezen identiteit.
principalId	string	De principal-id van de door de gebruiker toegewezen identiteit.

VirtualNetworkConfiguration

Object

Configuratie van een virtueel netwerk waarnaar de API Management-service wordt geïmplementeerd.

Name	Type	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	De volledige resource-id van een subnet in een virtueel netwerk waarin de API Management-service wordt geïmplementeerd.
subnetname	string	De naam van het subnet.
vnetid	string	De id van het virtuele netwerk. Dit is meestal een GUID. Verwacht standaard een null-GUID.

VirtualNetworkType

Inventarisatie

Het type VPN waarin de API Management-service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een virtueel netwerk, extern betekent dat de API Management-implementatie is ingesteld binnen een virtueel netwerk met een internetgericht eindpunt en intern betekent dat de API Management-implementatie alleen is ingesteld in een virtueel netwerk met alleen een intranetgericht eindpunt.

Waarde	Description
External	De service maakt deel uit van virtual network en is toegankelijk via internet.
Internal	De service maakt deel uit van het virtuele netwerk en is alleen toegankelijk vanuit het virtuele netwerk.
None	De service maakt geen deel uit van een virtueel netwerk.

Delen via

Api Management Service - Restore

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementRestoreService

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AccessType

AdditionalLocation

ApiManagementServiceBackupRestoreParameters

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Aanvullende resources