Megosztás a következőn keresztül:


Api Management Service - Restore

Visszaállítja az aktuális szolgáltatás ApiManagementService_Backup műveletével létrehozott API Management szolgáltatás biztonsági másolatát. Ez egy hosszú ideig futó művelet, és eltarthat néhány percig.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name Kötelező Típus Description
backupName True

string

A létrehozandó/lekérendő biztonsági mentési fájl neve.

containerName True

string

A blobtároló neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).

storageAccount True

string

Az Azure Storage-fiók neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).

accessKey

string

Tárfiók hozzáférési kulcsa. Csak akkor szükséges, ha accessType a AccessKeyértéke .

accessType

AccessType

A tárfiókhoz használandó hozzáférés típusa.

clientId

string

A felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója. Csak akkor szükséges, ha accessType a UserAssignedManagedIdentityértéke .

Válaszok

Name Típus Description
200 OK

ApiManagementServiceResource

Sikerült visszaállítani a biztonsági mentést a API Management szolgáltatásra.

202 Accepted

Elfogadva: A hely fejléce tartalmazza azt az URL-címet, ahol a hosszú ideig futó művelet állapota ellenőrizhető.

Fejlécek

location: string

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ApiManagementRestoreService

Mintakérelem

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2022-08-01

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

Mintaválasz

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

Definíciók

Name Description
AccessType

A tárfiókhoz használandó hozzáférés típusa.

AdditionalLocation

Egy további API Management erőforrás helyének leírása.

ApiManagementServiceBackupRestoreParameters

Egy API Management szolgáltatásművelet biztonsági mentéséhez/visszaállításához megadott paraméterek.

ApiManagementServiceIdentity

Az Api Management szolgáltatás erőforrásának identitástulajdonságai.

ApiManagementServiceResource

Egyetlen API Management szolgáltatáserőforrás a Listában vagy a Válasz lekérése listában.

ApiManagementServiceSkuProperties

API Management szolgáltatáserőforrás termékváltozatának tulajdonságai.

ApimIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

ApiVersionConstraint

A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.

ArmIdWrapper

ARM-erőforrásazonosító burkolója

CertificateConfiguration

Tanúsítványkonfiguráció, amely nem megbízható köztes és főtanúsítványokból áll.

CertificateInformation

SSL-tanúsítvány adatai.

CertificateSource

Tanúsítvány forrása.

CertificateStatus

Tanúsítvány állapota.

createdByType

Az erőforrást létrehozó identitás típusa.

ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

HostnameConfiguration

Egyéni állomásnév-konfiguráció.

HostnameType

Állomásnév típusa.

NatGatewayState

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

PlatformVersion

A szolgáltatást futtató Számítási platform verziója.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

PublicNetworkAccess

Azt határozza meg, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értékűnek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"

RemotePrivateEndpointConnectionWrapper

Távoli privát végpont kapcsolati erőforrása.

SkuType

A termékváltozat neve.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

UserIdentityProperties
VirtualNetworkConfiguration

Olyan virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része egyetlen Virtual Network sem, a Külső azt jelenti, hogy a API Management üzembe helyezés internetkapcsolattal rendelkező Virtual Network belül van beállítva, a Belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

AccessType

A tárfiókhoz használandó hozzáférés típusa.

Name Típus Description
AccessKey

string

Használja a hozzáférési kulcsot.

SystemAssignedManagedIdentity

string

Rendszer által hozzárendelt felügyelt identitás használata.

UserAssignedManagedIdentity

string

Felhasználó által hozzárendelt felügyelt identitás használata.

AdditionalLocation

Egy további API Management erőforrás helyének leírása.

Name Típus Alapértelmezett érték Description
disableGateway

boolean

False

A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót ezen a további helyen.

gatewayRegionalUrl

string

A régióban található API Management szolgáltatás átjáró URL-címe.

location

string

A további régió helyneve az Azure Data center-régiók között.

natGatewayState

NatGatewayState

Disabled

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

outboundPublicIPAddresses

string[]

A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.

platformVersion

PlatformVersion

A szolgáltatást futtató Számítási platform verziója.

privateIPAddresses

string[]

A API Management szolgáltatás privát statikus terheléselosztású IP-címei, amelyek egy belső Virtual Network vannak üzembe helyezve egy adott további helyen. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.

publicIPAddresses

string[]

A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei a további helyen. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.

publicIpAddressId

string

Nyilvános standard termékváltozat V4-alapú IP-címe, amely Virtual Network üzembe helyezett szolgáltatáshoz társítandó a helyen. Csak az Virtual Network-ben üzembe helyezett prémium termékváltozat esetén támogatott.

sku

ApiManagementServiceSkuProperties

A API Management szolgáltatás termékváltozat-tulajdonságai.

virtualNetworkConfiguration

VirtualNetworkConfiguration

A hely virtuális hálózati konfigurációja.

zones

string[]

A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceBackupRestoreParameters

Egy API Management szolgáltatásművelet biztonsági mentéséhez/visszaállításához megadott paraméterek.

Name Típus Alapértelmezett érték Description
accessKey

string

Tárfiók hozzáférési kulcsa. Csak akkor szükséges, ha accessType a AccessKeyértéke .

accessType

AccessType

AccessKey

A tárfiókhoz használandó hozzáférés típusa.

backupName

string

A létrehozandó/lekérendő biztonsági mentési fájl neve.

clientId

string

A felhasználó által hozzárendelt felügyelt identitás ügyfél-azonosítója. Csak akkor szükséges, ha accessType a UserAssignedManagedIdentityértéke .

containerName

string

A blobtároló neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).

storageAccount

string

Az Azure Storage-fiók neve (a biztonsági mentés elhelyezésére/lekérésére szolgál).

ApiManagementServiceIdentity

Az Api Management szolgáltatás erőforrásának identitástulajdonságai.

Name Típus Description
principalId

string

Az identitás egyszerű azonosítója.

tenantId

string

Az identitás ügyfélbérlő-azonosítója.

type

ApimIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

userAssignedIdentities

<string,  UserIdentityProperties>

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárának kulcshivatkozásai a következő űrlapon található ARM-erőforrás-azonosítók: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Egyetlen API Management szolgáltatáserőforrás a Listában vagy a Válasz lekérése listában.

Name Típus Alapértelmezett érték Description
etag

string

Az erőforrás ETagje.

id

string

Erőforrás-azonosító.

identity

ApiManagementServiceIdentity

Az Api Management szolgáltatás felügyeltszolgáltatás-identitása.

location

string

Erőforrás helye.

name

string

Erőforrás neve.

properties.additionalLocations

AdditionalLocation[]

A API Management szolgáltatás további adatközponti helyei.

properties.apiVersionConstraint

ApiVersionConstraint

A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.

properties.certificates

CertificateConfiguration[]

A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A legfeljebb telepíthető támogatott tanúsítványok maximális mérete 10.

properties.createdAtUtc

string

A API Management szolgáltatás létrehozási UTC-dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

properties.customProperties

object

A API Management szolgáltatás egyéni tulajdonságai.
A beállítás Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 letiltja a titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA az összes TLS(1.0, 1.1 és 1.2) esetében.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 letilthatja a TLS 1.1-et.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 letilthatja a TLS 1.0-t egy API Management szolgáltatásban.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 letilthatja a TLS 1.1-et a háttérrendszerekkel folytatott kommunikációhoz.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 letilthatja a TLS 1.0-t a háttérrendszerekkel folytatott kommunikációhoz.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 engedélyezhető a HTTP2 protokoll egy API Management szolgáltatásban.
Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, az alaphelyzetbe állítja a kihagyott tulajdonságok értékeit az alapértelmezett értékre. A Http2 kivételével az összes beállítás esetében az alapértelmezett érték az, True ha a szolgáltatás 2018. április 1-jén vagy azt megelőzően jött létre, máskülönben False . A Http2-beállítás alapértelmezett értéke a .False

A következő titkosítások bármelyikét letilthatja a következő beállításokkalMicrosoft.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. Például: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Az alapértelmezett érték számukra.true
Megjegyzés: A következő titkosítások nem tilthatók le, mivel belső platformösszetevőkre van szükségük: 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.developerPortalUrl

string

A DEveloper Portál végpontjának URL-címe a API Management szolgáltatásban.

properties.disableGateway

boolean

False

A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatásra érvényes. Ezzel letilthatja az átjárót a főrégióban.

properties.enableClientCertificate

boolean

False

A tulajdonság csak használati termékváltozat-szolgáltatáshoz használható. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjáró felé irányuló minden egyes kérésen. Ez lehetővé teszi a tanúsítvány hitelesítését is az átjáró házirendjében.

properties.gatewayRegionalUrl

string

Az alapértelmezett régióban található API Management szolgáltatás átjáró URL-címe.

properties.gatewayUrl

string

A API Management szolgáltatás átjáró URL-címe.

properties.hostnameConfigurations

HostnameConfiguration[]

A API Management szolgáltatás egyéni állomásnév-konfigurációja.

properties.managementApiUrl

string

A felügyeleti API-végpont URL-címe a API Management szolgáltatásban.

properties.natGatewayState

NatGatewayState

Disabled

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

properties.notificationSenderEmail

string

Email címet, amelyről az értesítés el lesz küldve.

properties.outboundPublicIPAddresses

string[]

A NAT Gateway által üzembe helyezett szolgáltatáshoz társított kimenő nyilvános IPV4-címelőtagok. Csak prémium termékváltozathoz érhető el az stv2 platformon.

properties.platformVersion

PlatformVersion

A szolgáltatást ezen a helyen futtató számítási platform verziója.

properties.portalUrl

string

A Publisher portál végpontjának URL-címe a API Management szolgáltatásban.

properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

A szolgáltatás privát végpontkapcsolatainak listája.

properties.privateIPAddresses

string[]

A API Management szolgáltatás privát statikus terheléselosztású IP-címei az elsődleges régióban, amely belső Virtual Network van üzembe helyezve. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.

properties.provisioningState

string

A API Management szolgáltatás jelenlegi kiépítési állapota, amely a következők egyike lehet: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

properties.publicIPAddresses

string[]

A API Management szolgáltatás nyilvános statikus terheléselosztású IP-címei az elsődleges régióban. Csak alapszintű, standard, prémium és izolált termékváltozatokhoz érhető el.

properties.publicIpAddressId

string

A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatú V4-alapú IP-cím. Csak a fejlesztői és prémium termékváltozatok Virtual Network való üzembe helyezéséhez támogatott.

properties.publicNetworkAccess

PublicNetworkAccess

Azt jelzi, hogy engedélyezve van-e a nyilvános végponthoz való hozzáférés ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értéknek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"

properties.publisherEmail

string

Közzétevő e-mail címe.

properties.publisherName

string

Közzétevő neve.

properties.restore

boolean

False

Törölje az Api Management Service-t, ha korábban helyreállítható módon törölték. Ha ez a jelző meg van adva, és True (Igaz) értékre van állítva, a rendszer figyelmen kívül hagyja az összes többi tulajdonságot.

properties.scmUrl

string

A API Management szolgáltatás SCM-végpontJÁNAK URL-címe.

properties.targetProvisioningState

string

A szolgáltatáson elindított hosszú ideig futó művelet által megcélzott API Management szolgáltatás kiépítési állapota.

properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

A API Management szolgáltatás virtuális hálózati konfigurációja.

properties.virtualNetworkType

VirtualNetworkType

None

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része semmilyen Virtual Network, a Külső azt jelenti, hogy a API Management üzembe helyezés egy internetkapcsolattal rendelkező végponttal rendelkező Virtual Network belül van beállítva, a belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

sku

ApiManagementServiceSkuProperties

A API Management szolgáltatás termékváltozat-tulajdonságai.

systemData

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

tags

object

Erőforráscímkék.

type

string

API Management erőforrás erőforrástípusa Microsoft.ApiManagement értékre van állítva.

zones

string[]

A rendelkezésre állási zónák listája, amely azt jelöli, hogy honnan kell származnia az erőforrásnak.

ApiManagementServiceSkuProperties

API Management szolgáltatáserőforrás termékváltozatának tulajdonságai.

Name Típus Description
capacity

integer

A termékváltozat kapacitása (a termékváltozat üzembe helyezett egységeinek száma). A használati termékváltozat kapacitását 0-ként kell megadni.

name

SkuType

A termékváltozat neve.

ApimIdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus egy implicit módon létrehozott identitást és egy felhasználó által hozzárendelt identitáskészletet is tartalmaz. A "Nincs" típus eltávolítja az identitásokat a szolgáltatásból.

Name Típus Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

A Control Plane Apis verziókorlátozása az API Management szolgáltatáshoz.

Name Típus Description
minApiVersion

string

Korlátozza a vezérlősík API-hívásait API Management szolgáltatásra, amelynek verziója megegyezik vagy újabb ennél az értéknél.

ArmIdWrapper

ARM-erőforrásazonosító burkolója

Name Típus Description
id

string

CertificateConfiguration

Tanúsítványkonfiguráció, amely nem megbízható köztes és főtanúsítványokból áll.

Name Típus Description
certificate

CertificateInformation

Tanúsítványadatok.

certificatePassword

string

Tanúsítvány jelszava.

encodedCertificate

string

Base64 kódolású tanúsítvány.

storeName enum:
  • CertificateAuthority
  • Root

A System.Security.Cryptography.x509certificates.StoreName tanúsítványtároló helye. Csak a Gyökér és a CertificateAuthority érvényes hely.

CertificateInformation

SSL-tanúsítvány adatai.

Name Típus Description
expiry

string

A tanúsítvány lejárati dátuma. A dátum az ISO 8601 szabvány által meghatározott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

subject

string

A tanúsítvány tárgya.

thumbprint

string

A tanúsítványhoz tartozó ujjlenyomat.

CertificateSource

Tanúsítvány forrása.

Name Típus Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Tanúsítvány állapota.

Name Típus Description
Completed

string

Failed

string

InProgress

string

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

HostnameConfiguration

Egyéni állomásnév-konfiguráció.

Name Típus Alapértelmezett érték Description
certificate

CertificateInformation

Tanúsítványadatok.

certificatePassword

string

Tanúsítvány jelszava.

certificateSource

CertificateSource

Tanúsítvány forrása.

certificateStatus

CertificateStatus

Tanúsítvány állapota.

defaultSslBinding

boolean

False

Adja meg az igaz értéket az állomásnévhez társított tanúsítvány alapértelmezett SSL-tanúsítványként való beállításához. Ha egy ügyfél nem küldi el az SNI-fejlécet, akkor ez lesz az a tanúsítvány, amelyet a rendszer megtámad. A tulajdonság akkor hasznos, ha egy szolgáltatás több egyéni állomásnévvel rendelkezik, és el kell döntenie az alapértelmezett SSL-tanúsítványt. A beállítás csak az átjáró állomásnévtípusára van alkalmazva.

encodedCertificate

string

Base64 kódolású tanúsítvány.

hostName

string

Az Api Management szolgáltatásban konfigurálandó állomásnév.

identityClientId

string

A rendszer vagy felhasználó által hozzárendelt felügyelt identitás ügyfélazonosítója a Azure AD által generált módon, amely GET-hozzáféréssel rendelkezik az SSL-tanúsítványt tartalmazó keyVaulthoz.

keyVaultId

string

Az SSL-tanúsítványt tartalmazó KeyVault-titkos kód URL-címe. Ha meg van adva a verziót tartalmazó abszolút URL-cím, az SSL-tanúsítvány automatikus frissítése nem fog működni. Ehhez az Api Management szolgáltatást aka.ms/apimmsi kell konfigurálni. A titkos kódnak application/x-pkcs12 típusúnak kell lennie

negotiateClientCertificate

boolean

False

Adja meg az igaz értéket, hogy mindig egyeztetni szeretné az ügyféltanúsítványt az állomásnéven. Az alapértelmezett érték hamis.

type

HostnameType

Állomásnév típusa.

HostnameType

Állomásnév típusa.

Name Típus Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

A tulajdonság használatával engedélyezheti a NAT Gatewayt ehhez a API Management szolgáltatáshoz.

Name Típus Description
Disabled

string

A NAT Gateway le van tiltva a szolgáltatáshoz.

Enabled

string

A NAT Gateway engedélyezve van a szolgáltatáshoz.

PlatformVersion

A szolgáltatást futtató Számítási platform verziója.

Name Típus Description
mtv1

string

A szolgáltatást több-bérlős V1 platformon futtató platform.

stv1

string

A szolgáltatást egyetlen bérlős V1 platformon futtató platform.

stv2

string

A szolgáltatást egyetlen bérlős V2 platformon futtató platform.

undetermined

string

A platform verziója nem határozható meg, mivel a számítási platform nincs üzembe helyezve.

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

Name Típus Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

Name Típus Description
actionsRequired

string

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

description

string

A kapcsolat jóváhagyásának/elutasításának oka.

status

PrivateEndpointServiceConnectionStatus

Azt jelzi, hogy a szolgáltatás tulajdonosa jóváhagyta/elutasította/eltávolította-e a kapcsolatot.

PublicNetworkAccess

Azt határozza meg, hogy a nyilvános végponthoz való hozzáférés engedélyezve van-e ehhez a API Management szolgáltatáshoz. Az érték megadása nem kötelező, de ha be van adva, akkor "Engedélyezve" vagy "Letiltva" értékűnek kell lennie. Ha a "Letiltva", a privát végpontok a kizárólagos hozzáférési módszer. Az alapértelmezett érték az "Engedélyezve"

Name Típus Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Távoli privát végpont kapcsolati erőforrása.

Name Típus Description
id

string

Privát végpont kapcsolati erőforrás-azonosítója

name

string

Privát végpont kapcsolatának neve

properties.groupIds

string[]

Az összes csoportazonosító.

properties.privateEndpoint

ArmIdWrapper

A privát végpont erőforrása.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A szolgáltatásfelhasználó és a szolgáltató közötti kapcsolat állapotával kapcsolatos információk gyűjteménye.

properties.provisioningState

string

A privát végpont kapcsolati erőforrásának kiépítési állapota.

type

string

Privát végpont kapcsolati erőforrástípusa

SkuType

A termékváltozat neve.

Name Típus Description
Basic

string

Az API Management alapszintű termékváltozata.

Consumption

string

Az API Management használati termékváltozata.

Developer

string

Az Api Management fejlesztői termékváltozata.

Isolated

string

Az API Management izolált termékváltozata.

Premium

string

Az Api Management prémium termékváltozata.

Standard

string

Az Api Management standard termékváltozata.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)

lastModifiedBy

string

Az az identitás, amely legutóbb módosította az erőforrást.

lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

UserIdentityProperties

Name Típus Description
clientId

string

A felhasználó által hozzárendelt identitás ügyfél-azonosítója.

principalId

string

A felhasználó által hozzárendelt identitás egyszerű azonosítója.

VirtualNetworkConfiguration

Olyan virtuális hálózat konfigurálása, amelyre API Management szolgáltatás telepítve van.

Name Típus Description
subnetResourceId

string

Egy virtuális hálózat alhálózatának teljes erőforrás-azonosítója a API Management szolgáltatás üzembe helyezéséhez.

subnetname

string

Az alhálózat neve.

vnetid

string

A virtuális hálózat azonosítója. Ez általában egy GUID. Alapértelmezés szerint null guid értéket vár.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) azt jelenti, hogy a API Management szolgáltatás nem része egyetlen Virtual Network sem, a Külső azt jelenti, hogy a API Management üzembe helyezés internetkapcsolattal rendelkező Virtual Network belül van beállítva, a Belső pedig azt jelenti, hogy API Management az üzembe helyezés csak intranetes végponttal rendelkező Virtual Network van beállítva.

Name Típus Description
External

string

A szolgáltatás a Virtual Network része, és az internetről érhető el.

Internal

string

A szolgáltatás a Virtual Network része, és csak a virtuális hálózaton belülről érhető el.

None

string

A szolgáltatás nem része egyetlen Virtual Network sem.