Api Management Service - Apply Network Configuration Updates

  • Referens
Service:
API Management
API Version:
2022-08-01

Uppdateringar resursen Microsoft.ApiManagement som körs i det virtuella nätverket för att välja de uppdaterade DNS-ändringarna.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

Namnet på API Management-tjänsten.

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

string

ID för målprenumerationen.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Typ Description
location

string

Platsen för Api Management-tjänsten som ska uppdateras för en tjänst i flera regioner. För en tjänst som distribueras i en enda region krävs inte den här parametern.

Svar

Name Typ Description
200 OK

ApiManagementServiceResource

Uppdateringar av nätverkskonfigurationen har tillämpats på Api Management-tjänsten.
202 Accepted

Godkänt: Platsrubriken innehåller url:en där statusen för den långvariga åtgärden kan kontrolleras.

Headers

location: string
Other Status Codes

ErrorResponse

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

Säkerhet

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 personifiera ditt användarkonto

Exempel

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

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

{
  "location": "west us"
}

Sample Response

Status code:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01
Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "UID": "52ed5986-717b-45b4-b17c-3df8db372cff"
  },
  "location": "East Asia",
  "etag": "AAAAAAAXX6Y=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2015-09-22T01:50:34.7921566Z",
    "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": [
      "207.46.155.24"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definitioner

Name Description
AdditionalLocation

Beskrivning av ytterligare en API Management resursplats.
ApiManagementServiceApplyNetworkConfigurationParameters

Parameter som angetts för åtgärden Tillämpa nätverkskonfiguration.
ApiManagementServiceIdentity

Identitetsegenskaper för Api Management-tjänstresursen.
ApiManagementServiceResource

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

API Management SKU-egenskaper för tjänstresurser.
ApimIdentityType

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

Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.
ArmIdWrapper

En adapter för ett ARM-resurs-ID
CertificateConfiguration

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

SSL-certifikatinformation.
CertificateSource

Certifikatkälla.
CertificateStatus

Certifikatstatus.
createdByType

Den typ av identitet som skapade resursen.
ErrorFieldContract

Fel fältkontrakt.
ErrorResponse

Felsvar.
HostnameConfiguration

Anpassad konfiguration av värdnamn.
HostnameType

Typ av värdnamn.
NatGatewayState

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

Compute Platform Version som kör tjänsten.
PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState

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

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

Fjärrresurs för privat slutpunktsanslutning.
SkuType

Namnet på SKU:n.
systemData

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

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

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

AdditionalLocation

Beskrivning av ytterligare en API Management resursplats.

Name Typ Standardvärde Description
disableGateway

boolean

False

Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.
gatewayRegionalUrl

string

Gateway-URL för API Management-tjänsten i regionen.
location

string

Platsnamnet för den ytterligare regionen bland Azure-datacenterregioner.
natGatewayState

NatGatewayState

Disabled

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

string[]

Utgående offentliga IPV4-adressprefix som är associerade med DEN NAT Gateway-distribuerade tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
platformVersion

PlatformVersion

Compute Platform Version som kör tjänsten.
privateIPAddresses

string[]

Privata statiska belastningsutjämnings-IP-adresser för API Management-tjänsten som distribueras i en intern Virtual Network på en viss ytterligare plats. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolerad.
publicIPAddresses

string[]

Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten på den ytterligare platsen. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolerad.
publicIpAddressId

string

Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network.
sku

ApiManagementServiceSkuProperties

SKU-egenskaper för API Management-tjänsten.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Konfiguration av virtuellt nätverk för platsen.
zones

string[]

En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

ApiManagementServiceApplyNetworkConfigurationParameters

Parameter som angetts för åtgärden Tillämpa nätverkskonfiguration.

Name Typ Description
location

string

Platsen för Api Management-tjänsten som ska uppdateras för en tjänst i flera regioner. För en tjänst som distribueras i en enda region krävs inte den här parametern.

ApiManagementServiceIdentity

Identitetsegenskaper för Api Management-tjänstresursen.

Name Typ Description
principalId

string

Identitetens huvud-ID.
tenantId

string

Klientklient-ID för identiteten.
type

ApimIdentityType

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

<string,  UserIdentityProperties>

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

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

Name Typ Standardvärde Description
etag

string

ETag för resursen.
id

string

Resurs-ID.
identity

ApiManagementServiceIdentity

Hanterad tjänstidentitet för Api Management-tjänsten.
location

string

Resursplats.
name

string

Resursnamn.
properties.additionalLocations

AdditionalLocation[]

Ytterligare datacenterplatser för API Management-tjänsten.
properties.apiVersionConstraint

ApiVersionConstraint

Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.
properties.certificates

CertificateConfiguration[]

Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds och som kan installeras är 10.
properties.createdAtUtc

string

Skapa UTC-datum för API Management-tjänsten. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.customProperties

object

Anpassade egenskaper för API Management-tjänsten.
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2).
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1.
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 på en API Management-tjänst.
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan användas för att inaktivera endast TLS 1.1 för kommunikation med serverdelar.
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar.
Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst.
Om du inte anger någon av dessa egenskaper för PATCH-åtgärden återställs utelämnade egenskapers värden till standardvärdena. För alla inställningar utom Http2 är True standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare än den 1 april 2018 och False annars. Http2-inställningens standardvärde är False.

Du kan inaktivera något av följande chiffer med hjälp av inställningarna Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Till exempel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Standardvärdet är true för dem.
Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalUrl

string

DEveloper-portalens slutpunkts-URL för API Management-tjänsten.
properties.disableGateway

boolean

False

Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.
properties.enableClientCertificate

boolean

False

Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.
properties.gatewayRegionalUrl

string

Gateway-URL för API Management-tjänsten i standardregionen.
properties.gatewayUrl

string

Gateway-URL för API Management-tjänsten.
properties.hostnameConfigurations

HostnameConfiguration[]

Anpassad värdnamnskonfiguration för API Management-tjänsten.
properties.managementApiUrl

string

API-slutpunkts-URL för hantering av API Management-tjänsten.
properties.natGatewayState

NatGatewayState

Disabled

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

string

Email adress som meddelandet ska skickas från.
properties.outboundPublicIPAddresses

string[]

Utgående offentliga IPV4-adressprefix som är associerade med DEN NAT Gateway-distribuerade tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
properties.platformVersion

PlatformVersion

Compute Platform Version som kör tjänsten på den här platsen.
properties.portalUrl

string

Slutpunkts-URL för utgivarportalen för API Management-tjänsten.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Lista över privata slutpunktsanslutningar för den här tjänsten.
properties.privateIPAddresses

string[]

Privata statiska belastningsutjämnings-IP-adresser för API Management-tjänsten i den primära regionen som distribueras i en intern Virtual Network. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolerad.
properties.provisioningState

string

Det aktuella etableringstillståndet för API Management-tjänsten som kan vara något av följande: Skapad/Aktivera/Lyckades/Uppdatera/Misslyckades/Stoppad/Avslutande/AvslutningFel/Borttaget.
properties.publicIPAddresses

string[]

Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten i den primära regionen. Endast tillgängligt för SKU:n Basic, Standard, Premium och Isolerad.
properties.publicIpAddressId

string

Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i Virtual Network.
properties.publicNetworkAccess

PublicNetworkAccess

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

string

E-postutfärdare.
properties.publisherName

string

Utgivarens namn.
properties.restore

boolean

False

Ta bort Api Management-tjänsten om den tidigare har tagits bort mjukt. Om den här flaggan har angetts och angetts till Sant ignoreras alla andra egenskaper.
properties.scmUrl

string

SCM-slutpunkts-URL för API Management-tjänsten.
properties.targetProvisioningState

string

Etableringstillståndet för API Management-tjänsten, som är mål för den långvariga åtgärd som startades på tjänsten.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Konfiguration av virtuellt nätverk för API Management-tjänsten.
properties.virtualNetworkType

VirtualNetworkType

None

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

ApiManagementServiceSkuProperties

SKU-egenskaper för API Management-tjänsten.
systemData

systemData

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

object

Resurstaggar.
type

string

Resurstypen för API Management resurs är inställd på Microsoft.ApiManagement.
zones

string[]

En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

ApiManagementServiceSkuProperties

API Management SKU-egenskaper för tjänstresurser.

Name Typ Description
capacity

integer

SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För SKU-kapacitet för förbrukning måste anges som 0.
name

SkuType

Namnet på SKU:n.

ApimIdentityType

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

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

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

Name Typ Description
minApiVersion

string

Begränsa API-anrop på kontrollplanet till API Management tjänst med en version som är lika med eller nyare än det här värdet.

ArmIdWrapper

En adapter för ett ARM-resurs-ID

Name Typ Description
id

string

CertificateConfiguration

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

Name Typ Description
certificate

CertificateInformation

Certifikatinformation.
certificatePassword

string

Certifikatlösenord.
encodedCertificate

string

Base64-kodat certifikat.
storeName enum:
  • CertificateAuthority
  • Root

Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Root och CertificateAuthority är giltiga platser.

CertificateInformation

SSL-certifikatinformation.

Name Typ Description
expiry

string

Certifikatets förfallodatum. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
subject

string

Certifikatets ämne.
thumbprint

string

Tumavtryck för certifikatet.

CertificateSource

Certifikatkälla.

Name Typ Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Certifikatstatus.

Name Typ Description
Completed

string

Failed

string

InProgress

string

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Fel fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.
message

string

Mänsklig läsbar representation av fel på egenskapsnivå.
target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.
error.message

string

Mänsklig läsbar representation av felet.

HostnameConfiguration

Anpassad konfiguration av värdnamn.

Name Typ Standardvärde Description
certificate

CertificateInformation

Certifikatinformation.
certificatePassword

string

Certifikatlösenord.
certificateSource

CertificateSource

Certifikatkälla.
certificateStatus

CertificateStatus

Certifikatstatus.
defaultSslBinding

boolean

False

Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet är detta certifikatet som kommer att utmanas. Egenskapen är användbar om flera anpassade värdnamn är aktiverade för en tjänst och den måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.
encodedCertificate

string

Base64-kodat certifikat.
hostName

string

Värdnamn som ska konfigureras på Api Management-tjänsten.
identityClientId

string

ClientId för system- eller användartilldelad hanterad identitet som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.
keyVaultId

string

URL till KeyVault-hemligheten som innehåller SSL-certifikatet. Om absolut URL som innehåller version anges fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12
negotiateClientCertificate

boolean

False

Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är false.
type

HostnameType

Typ av värdnamn.

HostnameType

Typ av värdnamn.

Name Typ Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

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

Name Typ Description
Disabled

string

Nat Gateway är inaktiverat för tjänsten.
Enabled

string

Nat Gateway är aktiverat för tjänsten.

PlatformVersion

Compute Platform Version som kör tjänsten.

Name Typ Description
mtv1

string

Plattform som kör tjänsten på V1-plattformen för flera innehavare.
stv1

string

Plattform som kör tjänsten på V1-plattformen för enskild klientorganisation.
stv2

string

Plattform som kör tjänsten på V2-plattformen för enskild klientorganisation.
undetermined

string

Det går inte att fastställa plattformsversionen eftersom beräkningsplattformen inte distribueras.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name Typ Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

Name Typ Description
actionsRequired

string

Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.
description

string

Anledningen till att anslutningen godkänns/avvisas.
status

PrivateEndpointServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PublicNetworkAccess

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

Name Typ Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Fjärrresurs för privat slutpunktsanslutning.

Name Typ Description
id

string

Resurs-ID för privat slutpunktsanslutning
name

string

Namn på privat slutpunktsanslutning
properties.groupIds

string[]

Alla grupp-ID:t.
properties.privateEndpoint

ArmIdWrapper

Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

string

Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type

string

Resurstyp för privat slutpunktsanslutning

SkuType

Namnet på SKU:n.

Name Typ Description
Basic

string

Grundläggande SKU för Api Management.
Consumption

string

Förbruknings-SKU för Api Management.
Developer

string

Utvecklar-SKU för Api Management.
Isolated

string

Isolerad SKU för Api Management.
Premium

string

Premium-SKU för Api Management.
Standard

string

Standard-SKU för Api Management.

systemData

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

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserIdentityProperties

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet.
principalId

string

Huvud-ID för användartilldelad identitet.

VirtualNetworkConfiguration

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

Name Typ Description
subnetResourceId

string

Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.
subnetname

string

Namnet på undernätet.
vnetid

string

Det virtuella nätverks-ID:t. Detta är vanligtvis ett GUID. Förvänta dig ett null-GUID som standard.

VirtualNetworkType

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

Name Typ Description
External

string

Tjänsten är en del av Virtual Network och är tillgänglig från Internet.
Internal

string

Tjänsten är en del av Virtual Network och är endast tillgänglig inifrån det virtuella nätverket.
None

string

Tjänsten ingår inte i någon Virtual Network.