Api Management Service - MigrateToStv2

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Uppgraderar en API Management-tjänst till Stv2-plattformen. Mer information finns i https://aka.ms/apim-migrate-stv2. Den här ändringen är inte reversibel. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
mode	MigrateToStv2Mode	Läge för migrering till stv2. Standardvärdet är PreserveIp.

Svar

Name	Typ	Description
200 OK	ApiManagementServiceResource	Tjänsten har migrerats.
202 Accepted		Migreringsbegäran har skickats. Sidhuvuden location: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

ApiManagementServiceResource

Tjänsten har migrerats.

202 Accepted

Migreringsbegäran har skickats.

Sidhuvuden

location: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementMigrateService

Exempelbegäran

HTTP

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

{
  "mode": "PreserveIp"
}

Exempelsvar

Statuskod:: 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

Statuskod:: 200

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

Definitioner

Name	Description
AdditionalLocation	Beskrivning av ytterligare en API Management-resursplats.
ApiManagementServiceIdentity	Identitetsegenskaper för Api Management-tjänstresursen.
ApiManagementServiceResource	En enda API Management-tjänstresurs i Lista eller Hämta svar.
ApiManagementServiceSkuProperties	Egenskaper för API Management-tjänstens resurs-SKU.
ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
ApiVersionConstraint	Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.
ArmIdWrapper	En omslutning för ett ARM-resurs-ID
CertificateConfiguration	Certifikatkonfiguration som består av icke-betrodda mellanliggande objekt och rotcertifikat.
CertificateInformation	SSL-certifikatinformation.
CertificateSource	Certifikatkälla.
CertificateStatus	Certifikatstatus.
ConfigurationApi	Information om API-konfigurations-API:et för API Management-tjänsten.
createdByType	Den typ av identitet som skapade resursen.
developerPortalStatus	Status för utvecklarportalen i den här API Management-tjänsten.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HostnameConfiguration	Konfiguration av anpassat värdnamn.
HostnameType	Typ av värdnamn.
LegacyApiState	Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"
LegacyPortalStatus	Status för den äldre portalen i API Management-tjänsten.
MigrateToStv2Contract	Beskriver en tillgänglig API Management SKU.
MigrateToStv2Mode	Läge för migrering till stv2. Standardvärdet är PreserveIp.
NatGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
PlatformVersion	Beräkningsplattformsversion som kör tjänsten.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
PublicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
RemotePrivateEndpointConnectionWrapper	Fjärrresurs för privat slutpunktsanslutning.
SkuType	Namnet på SKU:n.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguration av ett virtuellt nätverk som API Management-tjänsten distribueras till.
VirtualNetworkType	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.

AdditionalLocation

Objekt

Beskrivning av ytterligare en API Management-resursplats.

Name	Typ	Standardvärde	Description
disableGateway	boolean	False	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.
gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i regionen.
location	string		Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.
natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med NAT Gateway-distribuerad tjänst. Endast tillgängligt för Premium SKU på stv2-plattformen.
platformVersion	PlatformVersion		Beräkningsplattformsversion som kör tjänsten.
privateIPAddresses	string[]		Privata statiska belastningsutjämnings-IP-adresser för API Management-tjänsten som distribueras i ett internt virtuellt nätverk på en viss ytterligare plats. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolated.
publicIPAddresses	string[]		Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten på den ytterligare platsen. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolated.
publicIpAddressId	string		Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk på platsen. Stöds endast för Premium SKU som distribueras i virtuellt nätverk.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuellt nätverk för platsen.
zones	string[]		En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

ApiManagementServiceIdentity

Objekt

Identitetsegenskaper för Api Management-tjänstresursen.

Name	Typ	Description
principalId	string (uuid)	Identitetens huvud-ID.
tenantId	string (uuid)	Klientklient-ID:t för identiteten.
type	ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities	<string, UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Objekt

En enda API Management-tjänstresurs i Lista eller Hämta svar.

Name	Typ	Standardvärde	Description
etag	string		ETag för resursen.
id	string		Resurs-ID.
identity	ApiManagementServiceIdentity		Hanterad tjänstidentitet för Api Management-tjänsten.
location	string		Resursplats.
name	string		Resursnamn.
properties.additionalLocations	AdditionalLocation[]		Ytterligare datacenterplatser för API Management-tjänsten.
properties.apiVersionConstraint	ApiVersionConstraint		Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.
properties.certificates	CertificateConfiguration[]		Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.
properties.configurationApi	ConfigurationApi		Konfigurations-API-konfiguration för API Management-tjänsten.
properties.createdAtUtc	string (date-time)		Skapande av UTC-datum för API Management-tjänsten. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.customProperties	object		Anpassade egenskaper för API Management-tjänsten. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` kan användas för att inaktivera bara TLS 1.1. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 på en API Management-tjänst. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` kan användas för att inaktivera endast TLS 1.1 för kommunikation med serverdelar. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Inställning `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst. Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till standardvärdena. För alla inställningar utom Http2 är standardvärdet `True` om tjänsten skapades den 1 april 2018 eller före den 1 april 2018 och `False` annat. Http2-inställningens standardvärde är `False`. Du kan inaktivera något av följande chiffer med hjälp av inställningarna `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. Till exempel `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Standardvärdet är `true` för dem. Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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 för utvecklarportalen i den här API Management-tjänsten.
properties.developerPortalUrl	string		DEveloper-portalens slutpunkts-URL för API Management-tjänsten.
properties.disableGateway	boolean	False	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.
properties.enableClientCertificate	boolean	False	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.
properties.gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i standardregionen.
properties.gatewayUrl	string		Gateway-URL för API Management-tjänsten.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfiguration av anpassat värdnamn för API Management-tjänsten.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status för den äldre portalen i API Management-tjänsten.
properties.managementApiUrl	string		API-slutpunkts-URL för hantering av API Management.
properties.natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
properties.notificationSenderEmail	string maxLength: 100		E-postadress som meddelandet ska skickas från.
properties.outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med NAT Gateway-distribuerad tjänst. Endast tillgängligt för Premium SKU på stv2-plattformen.
properties.platformVersion	PlatformVersion		Beräkningsplattformsversion som kör tjänsten på den här platsen.
properties.portalUrl	string		Url för slutpunkts-URL för utgivarportalen för API Management-tjänsten.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista över privata slutpunktsanslutningar för den här tjänsten.
properties.privateIPAddresses	string[]		Privata statiska belastningsutjämnings-IP-adresser för API Management-tjänsten i den primära regionen som distribueras i ett internt virtuellt nätverk. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolated.
properties.provisioningState	string		Det aktuella etableringstillståndet för API Management-tjänsten som kan vara något av följande: Skapad/Aktivera/Lyckades/Uppdatera/Misslyckad/Stoppad/Avslutande/AvslutningFailed/Borttagen.
properties.publicIPAddresses	string[]		Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten i den primära regionen. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolated.
properties.publicIpAddressId	string		Public Standard SKU IP V4-baserad IP-adress som ska associeras med distribuerad tjänst för virtuellt nätverk i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i virtuellt nätverk.
properties.publicNetworkAccess	PublicNetworkAccess		Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
properties.publisherEmail	string maxLength: 100		E-post för utgivare.
properties.publisherName	string maxLength: 100		Utgivarens namn.
properties.restore	boolean	False	Ta bort Api Management-tjänsten om den tidigare var mjuk borttagen. Om den här flaggan anges och är inställd på Sant ignoreras alla andra egenskaper.
properties.scmUrl	string		SCM-slutpunkts-URL för API Management-tjänsten.
properties.targetProvisioningState	string		Etableringstillståndet för API Management-tjänsten, som är mål för den tidskrävande åtgärden som startades på tjänsten.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuellt nätverk för API Management-tjänsten.
properties.virtualNetworkType	VirtualNetworkType	None	Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
systemData	systemData		Metadata som rör skapande och senaste ändring av resursen.
tags	object		Resurstaggar.
type	string		Resurstypen för API Management-resursen är inställd på Microsoft.ApiManagement.
zones	string[]		En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

ApiManagementServiceSkuProperties

Objekt

Egenskaper för API Management-tjänstens resurs-SKU.

Name	Typ	Description
capacity	integer (int32)	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0.
name	SkuType	Namnet på SKU:n.

ApimIdentityType

Uppräkning

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Värde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Objekt

Kontrollplans-API:ets versionsvillkor för API Management-tjänsten.

Name	Typ	Description
minApiVersion	string	Begränsa API-anrop för kontrollplan till API Management-tjänsten med en version som är lika med eller nyare än det här värdet.

ArmIdWrapper

Objekt

En omslutning för ett ARM-resurs-ID

Name	Typ	Description
id	string

CertificateConfiguration

Objekt

Certifikatkonfiguration som består av icke-betrodda mellanliggande objekt och rotcertifikat.

Name	Typ	Description
certificate	CertificateInformation	Certifikatinformation.
certificatePassword	string	Certifikatlösenord.
encodedCertificate	string	Base64-kodat certifikat.
storeName	enum: CertificateAuthority Root	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.

CertificateInformation

Objekt

SSL-certifikatinformation.

Name	Typ	Description
expiry	string (date-time)	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
subject	string	Certifikatets ämne.
thumbprint	string	Tumavtryck för certifikatet.

CertificateSource

Uppräkning

Certifikatkälla.

Värde	Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Uppräkning

Certifikatstatus.

Värde	Description
Completed
Failed
InProgress

ConfigurationApi

Objekt

Information om API-konfigurations-API:et för API Management-tjänsten.

Name	Typ	Standardvärde	Description
legacyApi	LegacyApiState	Enabled	Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

developerPortalStatus

Uppräkning

Status för utvecklarportalen i den här API Management-tjänsten.

Värde	Description
Disabled	Utvecklarportalen är inaktiverad för tjänsten.
Enabled	Utvecklarportalen är aktiverad för tjänsten.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HostnameConfiguration

Objekt

Konfiguration av anpassat värdnamn.

Name	Typ	Standardvärde	Description
certificate	CertificateInformation		Certifikatinformation.
certificatePassword	string		Certifikatlösenord.
certificateSource	CertificateSource		Certifikatkälla.
certificateStatus	CertificateStatus		Certifikatstatus.
defaultSslBinding	boolean	False	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet blir det här certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.
encodedCertificate	string		Base64-kodat certifikat.
hostName	string		Värdnamn som ska konfigureras på Api Management-tjänsten.
identityClientId	string		Klient-ID för system- eller användartilldelad hanterad identitet som genererats av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.
keyVaultId	string		Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12
negotiateClientCertificate	boolean	False	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.
type	HostnameType		Typ av värdnamn.

HostnameType

Uppräkning

Typ av värdnamn.

Värde	Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Uppräkning

Ange om det äldre konfigurations-API:et (v1) ska exponeras på API Management-tjänsten eller inte. Värdet är valfritt men måste vara Aktiverat eller Inaktiverat. Om "Inaktiverad" är äldre konfigurations-API (v1) inte tillgängligt för gatewayer med egen värd. Standardvärdet är "Aktiverat"

Värde	Description
Disabled	Äldre konfigurations-API (v1) är inaktiverat för tjänsten och gatewayer med egen värd kan inte ansluta till den.
Enabled	Api för äldre konfiguration (v1) är aktiverat för tjänsten och gatewayer med egen värd kan ansluta till den.

LegacyPortalStatus

Uppräkning

Status för den äldre portalen i API Management-tjänsten.

Värde	Description
Disabled	Den äldre portalen är inaktiverad för tjänsten.
Enabled	Den äldre portalen är aktiverad för tjänsten.

MigrateToStv2Contract

Objekt

Beskriver en tillgänglig API Management SKU.

Name	Typ	Description
mode	MigrateToStv2Mode	Läge för migrering till stv2. Standardvärdet är PreserveIp.

MigrateToStv2Mode

Uppräkning

Läge för migrering till stv2. Standardvärdet är PreserveIp.

Värde	Description
NewIP	Migrera API Management-tjänsten till stv2 från stv1. Detta kommer inte att ha någon stilleståndstid eftersom tjänstkonfigurationen migreras till ny infrastruktur, men IP-adressen ändras.
PreserveIp	Migrera API Management-tjänsten till stv2 från stv1 genom att reservera tjänstens IP-adress. Detta kommer att ha en stilleståndstid på upp till 15 minuter, medan IP-adressen migreras till ny infrastruktur.

NatGatewayState

Uppräkning

Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.

Värde	Description
Disabled	Nat Gateway är inaktiverad för tjänsten.
Enabled	Nat Gateway är aktiverat för tjänsten.

PlatformVersion

Uppräkning

Beräkningsplattformsversion som kör tjänsten.

Värde	Description
mtv1	Plattform som kör tjänsten på V1-plattformen för flera klientorganisationer.
stv1	Plattform som kör tjänsten på V1-plattformen för enskild klientorganisation.
stv2	Plattform som kör tjänsten på V2-plattformen för enskild klientorganisation.
stv2.1	Plattform som kör tjänsten på V2-plattformen för enskild klientorganisation på nyare maskinvara.
undetermined	Det går inte att fastställa plattformsversionen eftersom beräkningsplattformen inte distribueras.

PrivateEndpointServiceConnectionStatus

Uppräkning

Anslutningsstatus för privat slutpunkt.

Värde	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.
description	string	Orsak till godkännande/avvisande av anslutningen.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PublicNetworkAccess

Uppräkning

Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas in måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"

Värde	Description
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Objekt

Fjärrresurs för privat slutpunktsanslutning.

Name	Typ	Description
id	string	Resurs-ID för privat slutpunktsanslutning
name	string	Namn på privat slutpunktsanslutning
properties.groupIds	string[]	Alla grupp-ID:t.
properties.privateEndpoint	ArmIdWrapper	Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
properties.provisioningState	string	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type	string	Resurstyp för privat slutpunktsanslutning

SkuType

Uppräkning

Namnet på SKU:n.

Värde	Description
Basic	Grundläggande SKU för Api Management.
BasicV2	BasicV2 SKU för Api Management.
Consumption	Förbruknings-SKU för Api Management.
Developer	Utvecklar-SKU för Api Management.
Isolated	Isolerad SKU för Api Management.
Premium	Premium SKU för Api Management.
Standard	Standard-SKU för Api Management.
StandardV2	StandardV2 SKU för Api Management.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserIdentityProperties

Objekt

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

VirtualNetworkConfiguration

Objekt

Konfiguration av ett virtuellt nätverk som API Management-tjänsten distribueras till.

Name	Typ	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.
subnetname	string	Namnet på undernätet.
vnetid	string	Det virtuella nätverks-ID:t. Detta är vanligtvis ett GUID. Förvänta dig ett null-GUID som standard.

VirtualNetworkType

Uppräkning

Den typ av VPN som API Management-tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i något virtuellt nätverk, externt innebär att API Management-distributionen har konfigurerats i ett virtuellt nätverk med en Internetuppkopplad slutpunkt, och intern innebär att API Management-distributionen konfigureras i ett virtuellt nätverk som endast har en intranätuppkopplad slutpunkt.

Värde	Description
External	Tjänsten är en del av det virtuella nätverket och är tillgänglig från Internet.
Internal	Tjänsten är en del av det virtuella nätverket och är endast tillgänglig från det virtuella nätverket.
None	Tjänsten ingår inte i något virtuellt nätverk.

Dela via

Api Management Service - MigrateToStv2

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementMigrateService

Exempelbegäran

Exempelsvar

Definitioner

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

developerPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

MigrateToStv2Contract

MigrateToStv2Mode

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Ytterligare resurser