Api Management Service - Apply Network Configuration Updates

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

Updates de resource Microsoft.ApiManagement die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte DNS-wijzigingen te kiezen.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName
 path True

string

De naam van de API Management service.

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

string

De id van het doelabonnement.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
location

string

Locatie van de API Management-service die moet worden bijgewerkt voor een service voor meerdere regio's. Voor een service die in één regio is geïmplementeerd, is deze parameter niet vereist.

Antwoorden

Name Type Description
200 OK

ApiManagementServiceResource

Updates voor de netwerkconfiguratie zijn toegepast op de API Management-service.
202 Accepted

Geaccepteerd: De locatieheader bevat de URL waar de status van de langlopende bewerking kan worden gecontroleerd.

Headers

location: string
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
AdditionalLocation

Beschrijving van een extra API Management resourcelocatie.
ApiManagementServiceApplyNetworkConfigurationParameters

Parameter die is opgegeven voor de configuratiebewerking Netwerk toepassen.
ApiManagementServiceIdentity

Identiteitseigenschappen van de Api Management-serviceresource.
ApiManagementServiceResource

Eén API Management serviceresource in Lijst of Antwoord ophalen.
ApiManagementServiceSkuProperties

API Management SKU-eigenschappen van serviceresources.
ApimIdentityType

Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd.
ApiVersionConstraint

Versiebeperking besturingsvlak-API's voor de API Management-service.
ArmIdWrapper

Een wrapper voor een ARM-resource-id
CertificateConfiguration

Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenproducten en basiscertificaten.
CertificateInformation

SSL-certificaatgegevens.
CertificateSource

Certificaatbron.
CertificateStatus

Certificaatstatus.
createdByType

Het type identiteit waarmee de resource is gemaakt.
ErrorFieldContract

Fout Veldcontract.
ErrorResponse

Foutreactie.
HostnameConfiguration

Aangepaste hostnaamconfiguratie.
HostnameType

Type hostnaam.
NatGatewayState

De eigenschap kan worden gebruikt om nat-gateway in te schakelen voor deze API Management-service.
PlatformVersion

Compute Platform-versie waarop de service wordt uitgevoerd.
PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.
PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
PublicNetworkAccess

Of openbare eindpunttoegang is toegestaan voor deze API Management service. De waarde is optioneel, maar als deze is doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
RemotePrivateEndpointConnectionWrapper

Externe privé-eindpuntverbindingsresource.
SkuType

Naam van de SKU.
systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
UserIdentityProperties
VirtualNetworkConfiguration

Configuratie van een virtueel netwerk waarop API Management service wordt geïmplementeerd.
VirtualNetworkType

Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft.

AdditionalLocation

Beschrijving van een extra API Management resourcelocatie.

Name Type Standaardwaarde Description
disableGateway

boolean

False

De eigenschap is alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway op deze extra locatie uit te schakelen.
gatewayRegionalUrl

string

Gateway-URL van de API Management-service in de regio.
location

string

De locatienaam van de extra regio tussen Azure-datacenterregio's.
natGatewayState

NatGatewayState

Disabled

De eigenschap kan worden gebruikt om nat-gateway in te schakelen voor deze API Management-service.
outboundPublicIPAddresses

string[]

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de geïmplementeerde NAT Gateway-service. Alleen beschikbaar voor Premium SKU op stv2-platform.
platformVersion

PlatformVersion

Compute Platform-versie waarop de service wordt uitgevoerd.
privateIPAddresses

string[]

Privé-IP-adressen met gelijke taakverdeling van de API Management-service die is geïmplementeerd in een interne Virtual Network op een bepaalde extra locatie. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
publicIPAddresses

string[]

Openbare STATISCHE IP-adressen met gelijke taakverdeling van de API Management-service op de extra locatie. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
publicIpAddressId

string

Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service op de locatie. Alleen ondersteund voor Premium-SKU die wordt geïmplementeerd in Virtual Network.
sku

ApiManagementServiceSkuProperties

SKU-eigenschappen van de API Management-service.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuratie van virtueel netwerk voor de locatie.
zones

string[]

Een lijst met beschikbaarheidszones die aangeven waar de resource vandaan moet komen.

ApiManagementServiceApplyNetworkConfigurationParameters

Parameter die is opgegeven voor de configuratiebewerking Netwerk toepassen.

Name Type Description
location

string

Locatie van de API Management-service die moet worden bijgewerkt voor een service met meerdere regio's. Voor een service die in één regio is geïmplementeerd, is deze parameter niet vereist.

ApiManagementServiceIdentity

Identiteitseigenschappen van de Api Management-serviceresource.

Name Type Description
principalId

string

De principal-id van de identiteit.
tenantId

string

De tenant-id van de client van de identiteit.
type

ApimIdentityType

Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd.
userAssignedIdentities

<string,  UserIdentityProperties>

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen naar de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

ApiManagementServiceResource

Eén API Management serviceresource in Lijst of Antwoord ophalen.

Name Type Standaardwaarde Description
etag

string

ETag van de resource.
id

string

Resource-id.
identity

ApiManagementServiceIdentity

Beheerde service-identiteit van de API Management-service.
location

string

Resourcelocatie.
name

string

Resourcenaam.
properties.additionalLocations

AdditionalLocation[]

Aanvullende datacenterlocaties van de API Management-service.
properties.apiVersionConstraint

ApiVersionConstraint

Versiebeperking besturingsvlak-API's voor de API Management-service.
properties.certificates

CertificateConfiguration[]

Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Het maximum aantal ondersteunde certificaten dat kan worden geïnstalleerd is 10.
properties.createdAtUtc

string

UTC-datum van de API Management-service maken. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.customProperties

object

Aangepaste eigenschappen van de API Management-service.
Met deze instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 wordt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uitgeschakeld voor alle TLS(1.0, 1.1 en 1.2).
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
De instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen op een API Management-service.
Als u geen van deze eigenschappen opgeeft tijdens de PATCH-bewerking, worden de waarden van de weggelaten eigenschappen opnieuw ingesteld op de standaardwaarden. Voor alle instellingen behalve Http2 is True de standaardwaarde als de service is gemaakt op of vóór 1 april 2018 en False anders. De standaardwaarde van de http2-instelling is False.

U kunt een van de volgende coderingen uitschakelen met behulp van instellingen 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. Bijvoorbeeld Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: :false. De standaardwaarde is true voor hen.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze vereist zijn voor interne platformonderdelen: 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 Portal-eindpunt-URL van de API Management-service.
properties.disableGateway

boolean

False

De eigenschap is alleen geldig voor een API Management-service die op meerdere locaties is geïmplementeerd. Dit kan worden gebruikt om de gateway in de hoofdregio uit te schakelen.
properties.enableClientCertificate

boolean

False

De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee dwingt u af dat er een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hierdoor kan het certificaat ook worden geverifieerd in het beleid op de gateway.
properties.gatewayRegionalUrl

string

Gateway-URL van de API Management-service in de standaardregio.
properties.gatewayUrl

string

Gateway-URL van de API Management-service.
properties.hostnameConfigurations

HostnameConfiguration[]

Aangepaste hostnaamconfiguratie van de API Management-service.
properties.managementApiUrl

string

Eindpunt-URL van de beheer-API van de API Management-service.
properties.natGatewayState

NatGatewayState

Disabled

Eigenschap kan worden gebruikt om NAT-gateway in te schakelen voor deze API Management-service.
properties.notificationSenderEmail

string

Email adres van waaruit de melding wordt verzonden.
properties.outboundPublicIPAddresses

string[]

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de in NAT Gateway geïmplementeerde service. Alleen beschikbaar voor Premium SKU op het stv2-platform.
properties.platformVersion

PlatformVersion

Compute Platform-versie waarop de service op deze locatie wordt uitgevoerd.
properties.portalUrl

string

Eindpunt-URL van de publisher-portal van de API Management-service.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

Lijst met privé-eindpuntverbindingen van deze service.
properties.privateIPAddresses

string[]

Privé IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio die is geïmplementeerd in een interne Virtual Network. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
properties.provisioningState

string

De huidige inrichtingsstatus van de API Management service, die een van de volgende kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Terminating/TerminationFailed/Verwijderd.
properties.publicIPAddresses

string[]

Openbare IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio. Alleen beschikbaar voor Basic, Standard, Premium en Isolated SKU.
properties.publicIpAddressId

string

Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service in de regio. Wordt alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network.
properties.publicNetworkAccess

PublicNetworkAccess

Of openbare eindpunttoegang is toegestaan voor deze API Management-service. De waarde is optioneel, maar als deze wordt doorgegeven, moet deze 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'Uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld
properties.publisherEmail

string

E-mailadres van uitgever.
properties.publisherName

string

Naam van uitgever.
properties.restore

boolean

False

Verwijder de API Management-service ongedaan als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd.
properties.scmUrl

string

SCM-eindpunt-URL van de API Management-service.
properties.targetProvisioningState

string

De inrichtingsstatus van de API Management-service, waarop de langdurige bewerking is gericht die is gestart op de service.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuratie van het virtuele netwerk van de API Management-service.
properties.virtualNetworkType

VirtualNetworkType

None

Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft.
sku

ApiManagementServiceSkuProperties

SKU-eigenschappen van de API Management-service.
systemData

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
tags

object

Resourcetags.
type

string

Resourcetype voor API Management resource is ingesteld op Microsoft.ApiManagement.
zones

string[]

Een lijst met beschikbaarheidszones die aangeeft waar de resource vandaan moet komen.

ApiManagementServiceSkuProperties

API Management SKU-eigenschappen van serviceresources.

Name Type Description
capacity

integer

Capaciteit van de SKU (aantal geïmplementeerde eenheden van de SKU). Voor Verbruik SKU-capaciteit moet worden opgegeven als 0.
name

SkuType

Naam van de SKU.

ApimIdentityType

Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd.

Name Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

Versiebeperking besturingsvlak-API's voor de API Management-service.

Name Type Description
minApiVersion

string

Beperk API-aanroepen van besturingsvlak tot API Management service met een versie die gelijk is aan of hoger is dan deze waarde.

ArmIdWrapper

Een wrapper voor een ARM-resource-id

Name Type Description
id

string

CertificateConfiguration

Certificaatconfiguratie die bestaat uit niet-vertrouwde tussenproducten en basiscertificaten.

Name Type Description
certificate

CertificateInformation

Certificaatgegevens.
certificatePassword

string

Certificaatwachtwoord.
encodedCertificate

string

Base64-gecodeerd certificaat.
storeName enum:
  • CertificateAuthority
  • Root

De locatie van het certificaatarchief System.Security.Cryptography.x509certificates.StoreName. Alleen Root en CertificateAuthority zijn geldige locaties.

CertificateInformation

SSL-certificaatgegevens.

Name Type Description
expiry

string

Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
subject

string

Onderwerp van het certificaat.
thumbprint

string

Vingerafdruk van het certificaat.

CertificateSource

Certificaatbron.

Name Type Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

Certificaatstatus.

Name Type Description
Completed

string

Failed

string

InProgress

string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.
message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.
target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout.
error.message

string

Door mensen leesbare weergave van de fout.

HostnameConfiguration

Aangepaste hostnaamconfiguratie.

Name Type Standaardwaarde Description
certificate

CertificateInformation

Certificaatgegevens.
certificatePassword

string

Certificaatwachtwoord.
certificateSource

CertificateSource

Certificaatbron.
certificateStatus

CertificateStatus

Certificaatstatus.
defaultSslBinding

boolean

False

Geef true op om het certificaat dat is gekoppeld aan deze hostnaam in te stellen als het standaard-SSL-certificaat. Als een client de SNI-header niet verzendt, is dit het certificaat dat wordt aangevochten. De eigenschap is handig als voor een service meerdere aangepaste hostnamen zijn ingeschakeld en deze moet beslissen over het standaard SSL-certificaat. De instelling wordt alleen toegepast op het hostnaamtype van de gateway.
encodedCertificate

string

Base64-gecodeerd certificaat.
hostName

string

Hostnaam die moet worden geconfigureerd in de API Management-service.
identityClientId

string

ClientId van door het systeem of door de gebruiker toegewezen beheerde identiteit zoals gegenereerd door Azure AD, die GET-toegang heeft tot de keyVault die het SSL-certificaat bevat.
keyVaultId

string

URL naar het KeyVault-geheim met het SSL-certificaat. Als absolute URL met versie is opgegeven, werkt het automatisch bijwerken van het SSL-certificaat niet. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi. Het geheim moet van het type application/x-pkcs12 zijn
negotiateClientCertificate

boolean

False

Geef true op om altijd te onderhandelen over het clientcertificaat op de hostnaam. De standaardwaarde is onwaar.
type

HostnameType

Hostnaamtype.

HostnameType

Type hostnaam.

Name Type Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

NatGatewayState

De eigenschap kan worden gebruikt om nat-gateway in te schakelen voor deze API Management-service.

Name Type Description
Disabled

string

Nat Gateway is uitgeschakeld voor de service.
Enabled

string

Nat Gateway is ingeschakeld voor de service.

PlatformVersion

Compute Platform-versie waarop de service wordt uitgevoerd.

Name Type Description
mtv1

string

Platform waarop de service wordt uitgevoerd op multitenant V1-platform.
stv1

string

Platform waarop de service wordt uitgevoerd op een V1-platform met één tenant.
stv2

string

Platform waarop de service wordt uitgevoerd op een V2-platform met één tenant.
undetermined

string

De platformversie kan niet worden bepaald, omdat het rekenplatform niet is geïmplementeerd.

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

Name Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.

Name Type Description
actionsRequired

string

Een bericht waarin wordt aangegeven of wijzigingen in de serviceprovider updates voor de consument vereisen.
description

string

De reden voor goedkeuring/afwijzing van de verbinding.
status

PrivateEndpointServiceConnectionStatus

Geeft aan of de verbinding is goedgekeurd/geweigerd/verwijderd door de eigenaar van de service.

PublicNetworkAccess

Of openbare eindpunttoegang is toegestaan voor deze API Management service. De waarde is optioneel, maar als deze is doorgegeven, moet 'Ingeschakeld' of 'Uitgeschakeld' zijn. Als 'uitgeschakeld' is, zijn privé-eindpunten de exclusieve toegangsmethode. De standaardwaarde is Ingeschakeld

Name Type Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

Externe privé-eindpuntverbindingsresource.

Name Type Description
id

string

Resource-id van privé-eindpuntverbinding
name

string

Naam van privé-eindpuntverbinding
properties.groupIds

string[]

Alle groeps-id's.
properties.privateEndpoint

ArmIdWrapper

De resource van het privé-eindpunt.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen de servicegebruiker en de provider.
properties.provisioningState

string

De inrichtingsstatus van de privé-eindpuntverbindingsresource.
type

string

Resourcetype privé-eindpuntverbinding

SkuType

Naam van de SKU.

Name Type Description
Basic

string

Basis-SKU van API Management.
Consumption

string

Verbruiks-SKU van API Management.
Developer

string

Ontwikkelaars-SKU van API Management.
Isolated

string

Geïsoleerde SKU van API Management.
Premium

string

Premium-SKU van API Management.
Standard

string

Standaard-SKU van API Management.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit die de resource heeft gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string

Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.

UserIdentityProperties

Name Type Description
clientId

string

De client-id van de door de gebruiker toegewezen identiteit.
principalId

string

De principal-id van de door de gebruiker toegewezen identiteit.

VirtualNetworkConfiguration

Configuratie van een virtueel netwerk waarop API Management service wordt geïmplementeerd.

Name Type Description
subnetResourceId

string

De volledige resource-id van een subnet in een virtueel netwerk om de API Management-service in te implementeren.
subnetname

string

De naam van het subnet.
vnetid

string

De id van het virtuele netwerk. Dit is meestal een GUID. Verwacht standaard een null-GUID.

VirtualNetworkType

Het type VPN waarin API Management service moet worden geconfigureerd. Geen (standaardwaarde) betekent dat de API Management-service geen deel uitmaakt van een Virtual Network, extern betekent dat de API Management-implementatie is ingesteld binnen een Virtual Network met een internetgericht eindpunt en Intern betekent dat API Management implementatie wordt ingesteld binnen een Virtual Network alleen een intranetgericht eindpunt heeft.

Name Type Description
External

string

De service maakt deel uit van Virtual Network en is toegankelijk via internet.
Internal

string

De service maakt deel uit van Virtual Network en is alleen toegankelijk vanuit het virtuele netwerk.
None

string

De service maakt geen deel uit van een Virtual Network.