Api Management Service - MigrateToStv2

Reference

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Upgraduje službu API Management na platformu Stv2. Podrobnosti najdete v https://aka.ms/apim-migrate-stv2. Tato změna není nevratná. Tato operace je dlouhotrvající a dokončení může trvat několik minut.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
mode	MigrateToStv2Mode	Režim migrace na stv2. Výchozí hodnota je PreserveIp.

Odpovědi

Name	Typ	Description
200 OK	ApiManagementServiceResource	Služba byla úspěšně migrována.
202 Accepted		Žádost o migraci byla odeslána. Hlavičky location: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

ApiManagementServiceResource

Služba byla úspěšně migrována.

202 Accepted

Žádost o migraci byla odeslána.

Hlavičky

location: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementMigrateService

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Stavový kód:: 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
  }
}

Definice

Name	Description
AdditionalLocation	Popis dalšího umístění prostředku služby API Management
ApiManagementServiceIdentity	Vlastnosti identity prostředku služby Api Management
ApiManagementServiceResource	Jeden prostředek služby API Management v seznamu nebo získání odpovědi
ApiManagementServiceSkuProperties	Vlastnosti skladové položky prostředku služby API Management
ApimIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
ApiVersionConstraint	Omezení verze APIS roviny řízení pro službu API Management
ArmIdWrapper	Obálka pro ID prostředku ARM
CertificateConfiguration	Konfigurace certifikátu, která se skládá z nedůvěryhodných zprostředkujících certifikátů a kořenových certifikátů.
CertificateInformation	Informace o certifikátu SSL
CertificateSource	Zdroj certifikátu.
CertificateStatus	Stav certifikátu.
ConfigurationApi	Informace týkající se rozhraní API konfigurace služby API Management
createdByType	Typ identity, která prostředek vytvořila.
developerPortalStatus	Stav portálu pro vývojáře v této službě API Management
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HostnameConfiguration	Konfigurace vlastního názvu hostitele
HostnameType	Typ názvu hostitele.
LegacyApiState	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled
LegacyPortalStatus	Stav starší verze portálu ve službě API Management
MigrateToStv2Contract	Popisuje dostupnou skladovou položku služby API Management.
MigrateToStv2Mode	Režim migrace na stv2. Výchozí hodnota je PreserveIp.
NatGatewayState	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
PlatformVersion	Verze výpočetní platformy, na které běží služba.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
PublicNetworkAccess	Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled
RemotePrivateEndpointConnectionWrapper	Prostředek připojení ke vzdálenému privátnímu koncovému bodu
SkuType	Název skladové položky.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserIdentityProperties
VirtualNetworkConfiguration	Konfigurace virtuální sítě, do které je nasazená služba API Management.
VirtualNetworkType	Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod.

AdditionalLocation

Objekt

Popis dalšího umístění prostředku služby API Management

Name	Typ	Default value	Description
disableGateway	boolean	False	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. Tuto možnost můžete použít k zakázání brány v tomto dalším umístění.
gatewayRegionalUrl	string		Adresa URL brány služby API Management v oblasti
location	string		Název umístění další oblasti mezi oblastmi Azure Data Center.
natGatewayState	NatGatewayState	Disabled	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
outboundPublicIPAddresses	string[]		Odchozí předpony veřejných IPV4 adres přidružených k nasazené službě NAT Gateway K dispozici pouze pro skladovou položku Premium na platformě stv2.
platformVersion	PlatformVersion		Verze výpočetní platformy, na které běží služba.
privateIPAddresses	string[]		Privátní IP adresy služby API Management se statickým vyrovnáváním zatížení, které jsou nasazené v interní virtuální síti v konkrétním dalším umístění. K dispozici pouze pro SKU Basic, Standard, Premium a Isolated.
publicIPAddresses	string[]		Veřejné IP adresy služby API Management se statickým vyrovnáváním zatížení v dalším umístění K dispozici pouze pro SKU Basic, Standard, Premium a Isolated.
publicIpAddressId	string		IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v umístění. Podporuje se jenom nasazení skladové položky Premium ve virtuální síti.
sku	ApiManagementServiceSkuProperties		Vlastnosti skladové položky služby API Management
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurace virtuální sítě pro umístění
zones	string[]		Seznam zón dostupnosti označující, odkud prostředek musí pocházet.

ApiManagementServiceIdentity

Objekt

Vlastnosti identity prostředku služby Api Management

Name	Typ	Description
principalId	string (uuid)	ID objektu zabezpečení identity.
tenantId	string (uuid)	ID tenanta klienta identity.
type	ApimIdentityType	Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.
userAssignedIdentities	<string, UserIdentityProperties>	Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ApiManagementServiceResource

Objekt

Jeden prostředek služby API Management v seznamu nebo získání odpovědi

Name	Typ	Default value	Description
etag	string		ETag prostředku.
id	string		ID prostředku.
identity	ApiManagementServiceIdentity		Identita spravované služby služby Api Management
location	string		Umístění prostředku
name	string		Název prostředku
properties.additionalLocations	AdditionalLocation[]		Další umístění datacenter služby API Management
properties.apiVersionConstraint	ApiVersionConstraint		Omezení verze APIS roviny řízení pro službu API Management
properties.certificates	CertificateConfiguration[]		Seznam certifikátů, které je potřeba nainstalovat ve službě API Management Maximální počet podporovaných certifikátů, které je možné nainstalovat, je 10.
properties.configurationApi	ConfigurationApi		Konfigurace rozhraní API konfigurace služby API Management
properties.createdAtUtc	string (date-time)		Datum vytvoření utc služby API Management Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
properties.customProperties	object		Vlastní vlastnosti služby API Management Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` zakáže TLS_RSA_WITH_3DES_EDE_CBC_SHA šifry pro všechny protokoly TLS(1.0, 1.1 a 1.2). Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` lze použít k zakázání pouze protokolu TLS 1.1. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 ve službě API Management. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` lze použít k zakázání pouze protokolu TLS 1.1 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` lze použít k zakázání protokolu TLS 1.0 pro komunikaci s back-endy. Nastavení `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` lze použít k povolení protokolu HTTP2 ve službě API Management. Nezadání žádné z těchto vlastností v operaci PATCH resetuje hodnoty vynechaných vlastností na výchozí hodnoty. Pro všechna nastavení kromě Http2 je výchozí hodnota `True`, pokud byla služba vytvořena 1. dubna 2018 a `False` jinak. Výchozí hodnota nastavení Http2 je `False`. Pomocí `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`nastavení můžete zakázat některou z následujících šifer: 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. Například `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Výchozí hodnota je `true` pro ně. Poznámka: Následující šifry nelze zakázat, protože jsou vyžadovány interními komponentami platformy: 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	Stav portálu pro vývojáře v této službě API Management
properties.developerPortalUrl	string		Adresa URL koncového bodu portálu DEveloper služby API Management
properties.disableGateway	boolean	False	Vlastnost platí pouze pro službu Api Management nasazenou ve více umístěních. To se dá použít k zakázání brány v hlavní oblasti.
properties.enableClientCertificate	boolean	False	Vlastnost má být použita pouze pro službu SKU Consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.
properties.gatewayRegionalUrl	string		Adresa URL brány služby API Management ve výchozí oblasti
properties.gatewayUrl	string		Adresa URL brány služby API Management
properties.hostnameConfigurations	HostnameConfiguration[]		Vlastní konfigurace názvu hostitele služby API Management
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Stav starší verze portálu ve službě API Management
properties.managementApiUrl	string		Adresa URL koncového bodu rozhraní API pro správu služby API Management
properties.natGatewayState	NatGatewayState	Disabled	Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.
properties.notificationSenderEmail	string maxLength: 100		E-mailová adresa, ze které se oznámení odešle.
properties.outboundPublicIPAddresses	string[]		Odchozí předpony veřejných IPV4 adres přidružených k nasazené službě NAT Gateway K dispozici pouze pro skladovou položku Premium na platformě stv2.
properties.platformVersion	PlatformVersion		Verze výpočetní platformy, na které běží služba v tomto umístění.
properties.portalUrl	string		Adresa URL koncového bodu portálu vydavatele služby API Management
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Seznam připojení privátních koncových bodů této služby
properties.privateIPAddresses	string[]		Privátní IP adresy služby API Management s vyrovnáváním zatížení v primární oblasti, která je nasazená v interní virtuální síti. K dispozici pouze pro SKU Basic, Standard, Premium a Isolated.
properties.provisioningState	string		Aktuální stav zřizování služby API Management, který může být jedním z následujících způsobů: Vytvoření, aktivace, úspěch, aktualizace, selhání, ukončení, ukončení nebo odstranění.
properties.publicIPAddresses	string[]		Veřejné IP adresy služby API Management se statickým vyrovnáváním zatížení v primární oblasti K dispozici pouze pro SKU Basic, Standard, Premium a Isolated.
properties.publicIpAddressId	string		IP adresa založená na veřejné standardní SKU V4, která se má přidružit k nasazené službě virtuální sítě v dané oblasti. Podporuje se jenom pro SKU Pro vývojáře a Premium nasazené ve virtuální síti.
properties.publicNetworkAccess	PublicNetworkAccess		Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled
properties.publisherEmail	string maxLength: 100		E-mail vydavatele.
properties.publisherName	string maxLength: 100		Název vydavatele.
properties.restore	boolean	False	Pokud byla dříve obnovitelně odstraněna, zrušte odstranění služby Api Management. Pokud je tento příznak zadaný a nastaví se na Hodnotu True, budou ignorovány všechny ostatní vlastnosti.
properties.scmUrl	string		Adresa URL koncového bodu SCM služby API Management
properties.targetProvisioningState	string		Stav zřizování služby API Management, na který cílí dlouhotrvající operace spuštěná ve službě.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurace virtuální sítě služby API Management
properties.virtualNetworkType	VirtualNetworkType	None	Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod.
sku	ApiManagementServiceSkuProperties		Vlastnosti skladové položky služby API Management
systemData	systemData		Metadata týkající se vytvoření a poslední změny prostředku.
tags	object		Značky prostředků
type	string		Typ prostředku služby API Management je nastavený na Microsoft.ApiManagement.
zones	string[]		Seznam zón dostupnosti označující, odkud prostředek musí pocházet.

ApiManagementServiceSkuProperties

Objekt

Vlastnosti skladové položky prostředku služby API Management

Name	Typ	Description
capacity	integer (int32)	Kapacita skladové položky (počet nasazených jednotek skladové položky). Pro kapacitu skladové položky Consumption musí být zadána jako 0.
name	SkuType	Název skladové položky.

ApimIdentityType

Výčet

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity.

Hodnota	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Objekt

Omezení verze APIS roviny řízení pro službu API Management

Name	Typ	Description
minApiVersion	string	Omezte volání rozhraní API řídicí roviny do služby API Management s verzí rovnající se nebo novější než tato hodnota.

ArmIdWrapper

Objekt

Obálka pro ID prostředku ARM

Name	Typ	Description
id	string

CertificateConfiguration

Objekt

Konfigurace certifikátu, která se skládá z nedůvěryhodných zprostředkujících certifikátů a kořenových certifikátů.

Name	Typ	Description
certificate	CertificateInformation	Informace o certifikátu
certificatePassword	string	Heslo certifikátu.
encodedCertificate	string	Kódovaný certifikát Base64
storeName	enum: CertificateAuthority Root	Umístění úložiště certifikátů System.Security.Cryptography.x509certificates.StoreName. Platná umístění jsou pouze root a CertificateAuthority.

CertificateInformation

Objekt

Informace o certifikátu SSL

Name	Typ	Description
expiry	string (date-time)	Datum vypršení platnosti certifikátu Datum odpovídá následujícímu formátu: `yyyy-MM-ddTHH:mm:ssZ` podle normy ISO 8601.
subject	string	Předmět certifikátu.
thumbprint	string	Kryptografický otisk certifikátu.

CertificateSource

Výčet

Zdroj certifikátu.

Hodnota	Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Výčet

Stav certifikátu.

Hodnota	Description
Completed
Failed
InProgress

ConfigurationApi

Objekt

Informace týkající se rozhraní API konfigurace služby API Management

Name	Typ	Default value	Description
legacyApi	LegacyApiState	Enabled	Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

developerPortalStatus

Výčet

Stav portálu pro vývojáře v této službě API Management

Hodnota	Description
Disabled	Portál pro vývojáře je pro službu zakázaný.
Enabled	Portál pro vývojáře je pro službu povolený.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HostnameConfiguration

Objekt

Konfigurace vlastního názvu hostitele

Name	Typ	Default value	Description
certificate	CertificateInformation		Informace o certifikátu
certificatePassword	string		Heslo certifikátu.
certificateSource	CertificateSource		Zdroj certifikátu.
certificateStatus	CertificateStatus		Stav certifikátu.
defaultSslBinding	boolean	False	Zadejte hodnotu true pro nastavení certifikátu přidruženého k tomuto názvu hostitele jako výchozího certifikátu SSL. Pokud klient neodešle hlavičku SNI, bude to certifikát, který bude vyzván. Tato vlastnost je užitečná, pokud má služba povolených více vlastních názvů hostitelů a musí se rozhodnout o výchozím certifikátu SSL. Nastavení použité pouze pro typ názvu hostitele brány.
encodedCertificate	string		Kódovaný certifikát Base64
hostName	string		Název hostitele pro konfiguraci ve službě Api Management.
identityClientId	string		ID klienta spravované identity přiřazené systémem nebo uživatelem vygenerované službou Azure AD, který má přístup GET ke službě keyVault obsahující certifikát SSL.
keyVaultId	string		Adresa URL tajného klíče služby KeyVault obsahující certifikát SSL. Pokud je k dispozici absolutní adresa URL obsahující verzi, automatická aktualizace certifikátu SSL nebude fungovat. To vyžaduje, aby služba Api Management byla nakonfigurovaná s aka.ms/apimmsi. Tajný kód by měl být typu application/x-pkcs12
negotiateClientCertificate	boolean	False	Zadejte true pro vždy vyjednání klientského certifikátu na názvu hostitele. Výchozí hodnota je false.
type	HostnameType		Typ názvu hostitele.

HostnameType

Výčet

Typ názvu hostitele.

Hodnota	Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Výčet

Indikuje, jestli má být ve službě API Management zpřístupněno starší verze konfiguračního rozhraní API (v1). Hodnota je nepovinná, ale musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, starší verze rozhraní API konfigurace (v1) nebude k dispozici pro brány v místním prostředí. Výchozí hodnota je Enabled

Hodnota	Description
Disabled	Rozhraní API starší verze konfigurace (v1) je pro službu zakázané a brány v místním prostředí se k němu nemůžou připojit.
Enabled	Rozhraní API starší verze konfigurace (v1) je povolené pro službu a brány v místním prostředí se k němu můžou připojit.

LegacyPortalStatus

Výčet

Stav starší verze portálu ve službě API Management

Hodnota	Description
Disabled	Starší verze portálu je pro službu zakázaná.
Enabled	Starší verze portálu je pro službu povolená.

MigrateToStv2Contract

Objekt

Popisuje dostupnou skladovou položku služby API Management.

Name	Typ	Description
mode	MigrateToStv2Mode	Režim migrace na stv2. Výchozí hodnota je PreserveIp.

MigrateToStv2Mode

Výčet

Režim migrace na stv2. Výchozí hodnota je PreserveIp.

Hodnota	Description
NewIP	Migrujte službu API Management na stv2 z stv1. To nebude mít žádný výpadek, protože konfigurace služby bude migrována do nové infrastruktury, ale IP adresa se změní.
PreserveIp	Migrujte službu API Management na stv2 z stv1 tak, že si zarezervujte IP adresu služby. To bude mít výpadek až 15 minut, zatímco IP adresa se migruje na novou infrastrukturu.

NatGatewayState

Výčet

Vlastnost se dá použít k povolení služby NAT Gateway pro tuto službu API Management.

Hodnota	Description
Disabled	Služba Nat Gateway je pro službu zakázaná.
Enabled	Služba Nat Gateway je povolená.

PlatformVersion

Výčet

Verze výpočetní platformy, na které běží služba.

Hodnota	Description
mtv1	Platforma, na které běží služba na platformě Multi Tenant V1.
stv1	Platforma, na které běží služba na platformě V1 s jedním tenantem.
stv2	Platforma, na které běží služba na platformě V2 s jedním tenantem
stv2.1	Platforma, která spouští službu na platformě jednoho tenanta V2 na novějším hardwaru.
undetermined	Verzi platformy nelze určit, protože výpočetní platforma není nasazená.

PrivateEndpointServiceConnectionStatus

Výčet

Stav připojení privátního koncového bodu.

Hodnota	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objekt

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

Name	Typ	Description
actionsRequired	string	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí připojení.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

PublicNetworkAccess

Výčet

Určuje, jestli je pro tuto službu API Management povolený přístup k veřejnému koncovému bodu. Hodnota je nepovinná, ale pokud je předaná, musí být Enabled (Povoleno) nebo Disabled (Zakázáno). Pokud je zakázáno, privátní koncové body jsou výhradní metodou přístupu. Výchozí hodnota je Enabled

Hodnota	Description
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Objekt

Prostředek připojení ke vzdálenému privátnímu koncovému bodu

Name	Typ	Description
id	string	ID prostředku připojení privátního koncového bodu
name	string	Název připojení privátního koncového bodu
properties.groupIds	string[]	Všechna ID skupiny.
properties.privateEndpoint	ArmIdWrapper	Prostředek privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
properties.provisioningState	string	Stav zřizování prostředku připojení privátního koncového bodu.
type	string	Typ prostředku připojení privátního koncového bodu

SkuType

Výčet

Název skladové položky.

Hodnota	Description
Basic	Základní skladová položka služby Api Management
BasicV2	Skladová položka BasicV2 služby Api Management.
Consumption	Skladová položka consumption služby Api Management
Developer	Skladová položka pro vývojáře služby Api Management.
Isolated	Izolovaná skladová položka služby Api Management
Premium	Skladová položka Premium služby Api Management
Standard	Standardní skladová položka služby Api Management
StandardV2	Skladová položka StandardV2 služby Api Management.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserIdentityProperties

Objekt

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

VirtualNetworkConfiguration

Objekt

Konfigurace virtuální sítě, do které je nasazená služba API Management.

Name	Typ	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	Úplné ID prostředku podsítě ve virtuální síti pro nasazení služby API Management do.
subnetname	string	Název podsítě.
vnetid	string	ID virtuální sítě. Obvykle se jedná o identifikátor GUID. Ve výchozím nastavení očekáváte identifikátor GUID s hodnotou null.

VirtualNetworkType

Výčet

Typ sítě VPN, ve které je potřeba nakonfigurovat službu API Management. Žádná (výchozí hodnota) znamená, že služba API Management není součástí žádné virtuální sítě, externí znamená, že nasazení služby API Management je nastavené uvnitř virtuální sítě s internetovým koncovým bodem a interní znamená, že nasazení služby API Management je nastaveno uvnitř virtuální sítě, která má pouze intranetový koncový bod.

Hodnota	Description
External	Služba je součástí virtuální sítě a je přístupná z internetu.
Internal	Služba je součástí virtuální sítě a je přístupná pouze z virtuální sítě.
None	Služba není součástí žádné virtuální sítě.

Sdílet prostřednictvím

Api Management Service - MigrateToStv2

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementMigrateService

Ukázkový požadavek

Ukázková odpověď

Definice

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

Další materiály