Api Management Service - Update

Frissít egy meglévő API Management szolgáltatást.

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

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

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

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

A API Management szolgáltatásban telepíteni kívánt tanúsítványok listája. A legfeljebb 10 telepíthető tanúsítvány telepíthető.

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-et tilthatja 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 csak a TLS 1.1-et lehet letiltani 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áson.
Ha nem adja meg ezeket a tulajdonságokat a PATCH műveletben, a rendszer visszaállítja a kihagyott tulajdonságok alapértelmezett értékeit. 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 .False

A következő rejtjelek 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 van true megadva. Megjegyzés: A következő rejtjelek nem tilthatók le, mivel azOkat az Azure CloudService belső összetevői igénylik: 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.disableGateway
  • boolean

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

properties.enableClientCertificate
  • boolean

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ónak küldött minden egyes kéréshez. Ez lehetővé teszi a tanúsítvány hitelesítését az átjáró házirendjében.

properties.hostnameConfigurations

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

properties.notificationSenderEmail
  • string

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

properties.privateEndpointConnections

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

properties.publicIpAddressId
  • string

A régióban Virtual Network üzembe helyezett szolgáltatáshoz társítandó nyilvános standard termékváltozatÚ IP V4-alapú IP-cím. Csak a fejlesztői és Prémium termékváltozat 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" állapotú, 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-mailt.

properties.publisherName
  • string

Publisher nevét.

properties.restore
  • boolean

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

properties.virtualNetworkConfiguration

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

properties.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.

sku

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

tags
  • object

Erőforráscímkék.

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.

Válaszok

Name Type Description
200 OK

A szolgáltatás frissítése sikeresen megtörtént.

202 Accepted

A szolgáltatásfrissítési kérelem elfogadva.

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

ApiManagementUpdateServiceDisableTls10
ApiManagementUpdateServicePublisherDetails
ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServicePublisherDetails

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "sasolank",
    "UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
    "Reserved": "",
    "TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
    "Pool": "Manual",
    "TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
  },
  "location": "West US",
  "etag": "AAAAAAAYRPs=",
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2017-06-29T17:50:42.3191122Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "40.86.176.232"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
    },
    "virtualNetworkType": "None"
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  }
}

ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "properties": {
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "virtualNetworkType": "External",
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ]
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2021-12-01-preview
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "location": "Japan East",
  "etag": "AAAAAAAWBIU=",
  "properties": {
    "publisherEmail": "contoso@microsoft.com",
    "publisherName": "apimPublisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-04-08T23:41:35.6447381Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-japaneast-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": "mycustomdomain.int-azure-api.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-06-09T23:59:59+00:00",
          "thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
          "subject": "CN=mycustomdomain.int-azure-api.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Managed"
      }
    ],
    "publicIPAddresses": [
      "20.78.248.217"
    ],
    "additionalLocations": [
      {
        "location": "Australia East",
        "sku": {
          "name": "Premium",
          "capacity": 3
        },
        "zones": [
          "1",
          "2",
          "3"
        ],
        "publicIPAddresses": [
          "20.213.1.35"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
        },
        "gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
        "disableGateway": false,
        "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
        "platformVersion": "stv2"
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "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.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": "Internal",
    "disableGateway": false,
    "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
  }
}

Definíciók

AdditionalLocation

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

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.

ApiManagementServiceUpdateParameters

Az Update Api Management Service-hez megadott paraméter.

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

Olyan 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.

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á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óJÁNAK URL-címe.

location
  • string

A további régió neve az Azure Data center-régiók 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ású IP-címei, amelyeket egy belső Virtual Network helyeznek üzembe egy adott további helyen. Csak alapszintű, standard, Prémium és izolált termékváltozathoz é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áltozathoz érhető el.

publicIpAddressId
  • string

A nyilvános standard termékváltozat V4-alapú IP-címe, amelyet Virtual Network üzembe helyezett szolgáltatáshoz kell társítani a helyen. Csak Prémium termékváltozat Virtual Network történő ü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.

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.

ApiManagementServiceUpdateParameters

Az Update Api Management Service-hez megadott paraméter.

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.

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.

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.

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 egyenlő 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ás több egyéni gazdagépnévvel rendelkezik, és el kell döntenie az alapértelmezett SSL-tanúsítványt. A beállítás csak a proxy gazdagépné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, hogy az ügyféltanúsítvány mindig igaz legyen 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 kapcsolati 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á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 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ó által hozzárendelt identitás egyszerű azonosítója.

VirtualNetworkConfiguration

Olyan 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 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.