Api Management Service - Backup

Biztonsági másolatot készít a API Management szolgáltatásról az adott Azure Storage-fiókba. Ez a művelet hosszú ideig fut, és eltarthat néhány percig.

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

URI-paraméterek

Name In Required Type Description
resourceGroupName
path True
  • string

Az erőforráscsoport neve.

serviceName
path True
  • string

A API Management szolgáltatás neve.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják Microsoft Azure előfizetést. Az előfizetés-azonosító minden szolgáltatáshívás URI-jának részét képezi.

api-version
query True
  • string

Az ügyfélkéréshez használandó API verziója.

Kérelem törzse

Name Required Type Description
backupName True
  • string

A létrehozandó/beolvasandó 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 másolat elhelyezésére/lekérésére szolgál).

accessKey
  • string

Storage fiók hozzáférési kulcsát. Csak akkor szükséges, ha accessType a beállítás értéke AccessKey.

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 beállítás értéke UserAssignedManagedIdentity.

Válaszok

Name Type Description
200 OK

A API Management szolgáltatás biztonsági mentése sikeresen megtörtént a tárfiókba.

202 Accepted

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

Other Status Codes

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

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

ApiManagementBackupWithAccessKey
ApiManagementBackupWithSystemManagedIdentity
ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

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

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

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-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
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

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

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "XXXXX-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "XXXXX-86f1-XXXXX-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "XXXXX-a100-4478-XXXX-d65d98118ba0",
        "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "XXXXX-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "XXXX-6328-4db2-XXXX-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definíciók

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 Backup/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 vagy a Get válasz listában.

ApiManagementServiceSkuProperties

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

ApimIdentityType

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

ApiVersionConstraint

A Control Plane APIs verziókorlátozása a API Management szolgáltatáshoz.

ArmIdWrapper

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

CertificateConfiguration

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

CertificateInformation

SSL-tanúsítvány adatai.

CertificateSource

Tanúsítványforrás.

CertificateStatus

Tanúsítvány állapota.

createdByType

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

ErrorFieldContract

Hibamező szerződése.

ErrorResponse

Hibaválasz.

HostnameConfiguration

Egyéni gazdagépnév-konfiguráció.

HostnameType

Állomásnév típusa.

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 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" állapotú, a privát végpontok a kizárólagos hozzáférési módszerek. Az alapértelmezett érték "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

Egy virtuális hálózat konfigurálása, amelyen API Management szolgáltatás üzembe van helyezve.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) érték azt jelenti, hogy a API Management szolgáltatás nem része egyik 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 belül van beállítva.

AccessType

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

Name Type Description
AccessKey
  • string

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

SystemAssignedManagedIdentity
  • string

Használjon rendszer által hozzárendelt felügyelt identitást.

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 Type Default Value Description
disableGateway
  • boolean
False

A tulajdonság csak több helyen üzembe helyezett Api Management-szolgáltatáshoz é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óJÁNAK URL-címe.

location
  • string

A további régió neve az Azure-adatközpont régiói között.

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ási IP-címei, amelyek egy belső Virtual Network egy adott további helyen vannak üzembe helyezve. 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ási IP-címei a további helyen. Csak alapszintű, standard, Prémium és izolált termékváltozatokhoz érhető el.

publicIpAddressId
  • string

A nyilvános standard termékváltozat V4-alapú IP-címe, amelyet a helyen Virtual Network üzembe helyezett szolgáltatáshoz kell társítani. Csak Prémium termékváltozat Virtual Network való üzembe helyezéséhez támogatott.

sku

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

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 Backup/visszaállításához megadott paraméterek.

Name Type Default Value Description
accessKey
  • string

Storage fiók hozzáférési kulcsát. Csak akkor szükséges, ha accessType be van állítva.AccessKey

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 be van állítva.UserAssignedManagedIdentity

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 Type Description
principalId
  • string

Az identitás fő azonosítója.

tenantId
  • string

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

type

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

userAssignedIdentities

Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai a következő formában jelennek meg: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

ApiManagementServiceResource

Egyetlen API Management szolgáltatáserőforrás a List vagy a Get válasz listában.

Name Type Default Value Description
etag
  • string

Az erőforrás ETagje.

id
  • string

Erőforrás-azonosító.

identity

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

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

properties.apiVersionConstraint

A Control Plane APIs verziókorlátozása a API Management szolgáltatáshoz.

properties.certificates

Azon tanúsítványok listája, amelyeket telepíteni kell a API Management szolgáltatásban. A maximálisan telepíthető tanúsítványok maximális támogatottsága 10.

properties.createdAtUtc
  • string

A API Management szolgáltatás létrehozási UTC-dátuma. A dátum a következő formátumnak felel meg: yyyy-MM-ddTHH:mm:ssZ az ISO 8601 szabványban meghatározottak szerint.

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 az összes TLS(1.0, 1.1 és 1.2) titkosítási TLS_RSA_WITH_3DES_EDE_CBC_SHA.
A beállítással Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 csak a TLS 1.1 tiltható le.
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, a rendszer visszaállítja a kihagyott tulajdonságok értékeit az alapértelmezett értékre. A Http2 kivételével az összes beállításnál 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 .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 az Azure CloudService belső összetevői megkövetelik őket: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

A API Management szolgáltatás DEveloper-portál végpontjának URL-címe.

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 lett használva. Ez kikényszeríti az ügyféltanúsítvány bemutatását az átjárónak küldött 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

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

properties.gatewayUrl
  • string

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

properties.hostnameConfigurations

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

properties.managementApiUrl
  • string

A API Management szolgáltatás felügyeleti API-végpontjának URL-címe.

properties.notificationSenderEmail
  • string

E-mail-cím, amelyről az értesítés el lesz küldve.

properties.platformVersion

A szolgáltatást ezen a helyen futtató számításiplatform-verzió.

properties.portalUrl
  • string

Publisher API Management szolgáltatás portálvégpontjának URL-címe.

properties.privateEndpointConnections

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

properties.privateIPAddresses
  • string[]

A belső Virtual Network üzembe helyezett elsődleges régióban lévő API Management szolgáltatás statikus terheléselosztásos magánhálózati IP-címei. Csak alapszintű, standard, Prémium és izolált termékváltozathoz érhető el.

properties.provisioningState
  • string

A API Management szolgáltatás aktuális 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áltozathoz é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 ip-címének V4-alapú ip-címe. Csak a fejlesztői és Prémium termékváltozatok Virtual Network való üzembe helyezéséhez támogatott.

properties.publicNetworkAccess

Azt határozza meg, 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" lehetőség van, a privát végpontok a kizárólagos hozzáférési módszerek. Az alapértelmezett érték "Engedélyezve"

properties.publisherEmail
  • string

Publisher e-mail.

properties.publisherName
  • string

Publisher nevet.

properties.restore
  • boolean
False

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

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

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

properties.virtualNetworkType None

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) é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 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 belül van beállítva.

sku

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

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ás erőforrás-termékváltozatának tulajdonságai.

Name Type Description
capacity
  • integer

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

name

A termékváltozat neve.

ApimIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

A Control Plane APIs verziókorlátozása a API Management szolgáltatáshoz.

Name Type 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 Type Description
id
  • string

CertificateConfiguration

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

Name Type Description
certificate

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 Type Description
expiry
  • string

A tanúsítvány lejárati dátuma. A dátum a következő formátumnak felel meg: yyyy-MM-ddTHH:mm:ssZ az ISO 8601 szabványban meghatározottak szerint.

subject
  • string

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

thumbprint
  • string

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

CertificateSource

Tanúsítványforrás.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

Tanúsítvány állapota.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

Hibamező szerződése.

Name Type Description
code
  • string

Tulajdonságszintű hibakód.

message
  • string

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

target
  • string

Tulajdonságnév.

ErrorResponse

Hibaválasz.

Name Type 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

É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 gazdagépnév-konfiguráció.

Name Type Default Value Description
certificate

Tanúsítványadatok.

certificatePassword
  • string

Tanúsítvány jelszava.

certificateSource

Tanúsítványforrás.

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 a vitatandó tanúsítvány. A tulajdonság akkor hasznos, ha egy szolgáltatáshoz több egyéni állomásnév is engedélyezve van, és el kell döntenie az alapértelmezett SSL-tanúsítványt. Ez a beállítás csak a proxy á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álni kívánt á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ó keyVault kulcshoz.

keyVaultId
  • string

Az SSL-tanúsítványt tartalmazó KeyVault-titkos kód URL-címe. Ha megadja a verziót tartalmazó abszolút URL-címet, 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 alkalmazás típusúnak/x-pkcs12-nek 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

Állomásnév típusa.

HostnameType

Állomásnév típusa.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

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

Name Type Description
mtv1
  • string

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

stv1
  • string

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

stv2
  • string

A szolgáltatást egybé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 Type 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 Type 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

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 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" állapotú, a privát végpontok a kizárólagos hozzáférési módszerek. Az alapértelmezett érték "Engedélyezve"

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

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

Name Type 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

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

properties.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 kapcsolatának erőforrástípusa

SkuType

A termékváltozat neve.

Name Type 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

Prémium Api Management termékváltozatát.

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 Type 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

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 erőforrást utoljára módosító identitás.

lastModifiedByType

Az erőforrást utoljára módosító identitás típusa.

UserIdentityProperties

Name Type Description
clientId
  • string

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

principalId
  • string

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

VirtualNetworkConfiguration

Egy virtuális hálózat konfigurálása, amelyen API Management szolgáltatás üzembe van helyezve.

Name Type 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 értékű GUID-t vár.

VirtualNetworkType

Az a VPN-típus, amelyben API Management szolgáltatást konfigurálni kell. A Nincs (alapértelmezett érték) érték azt jelenti, hogy a API Management szolgáltatás nem része egyik 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 belül van beállítva.

Name Type Description
External
  • string

A szolgáltatás 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 semmilyen Virtual Network.