Delen via

ApiManagementServiceBaseProperties interface

  • Referentie
Pakket:
@azure/arm-apimanagement

Basiseigenschappen van een beschrijving van een API Management-serviceresource.

Eigenschappen

additionalLocations

Aanvullende datacenterlocaties van de API Management-service.
apiVersionConstraint

Besturingselementvlak api's versiebeperking voor de API Management-service.
certificates

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

Utc-datum van de API Management-service maken. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
customProperties

Aangepaste eigenschappen van de API Management-service.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitschakelt.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
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.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service.
Als u geen van deze eigenschappen opgeeft bij DE PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde True als de service is gemaakt op of vóór 1 april 2018 en anders False. De standaardwaarde van 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 deze waarden.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist 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
developerPortalUrl

Eindpunt-URL van DEveloper Portal van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
disableGateway

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

De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.
gatewayRegionalUrl

Gateway-URL van de API Management-service in de standaardregio. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
gatewayUrl

Gateway-URL van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
hostnameConfigurations

Aangepaste hostnaamconfiguratie van de API Management-service.
managementApiUrl

Eindpunt-URL voor beheer-API van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
natGatewayState

De eigenschap kan worden gebruikt om NAT Gateway in te schakelen voor deze API Management-service.
notificationSenderEmail

E-mailadres van waaruit de melding wordt verzonden.
outboundPublicIPAddresses

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de nat-gateway geïmplementeerde service. Alleen beschikbaar voor Premium SKU op stv2-platform. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
platformVersion

Compute Platform-versie waarop de service op deze locatie wordt uitgevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
portalUrl

Eindpunt-URL van de Publisher-portal van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
privateEndpointConnections

Lijst met privé-eindpuntverbindingen van deze service.
privateIPAddresses

Privé-IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio die wordt geïmplementeerd in een intern virtueel netwerk. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
provisioningState

De huidige inrichtingsstatus van de API Management-service die een van de volgende opties kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Beëindigen/Beëindigen/BeëindigingFailed/Verwijderd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
publicIPAddresses

Openbare STATISCHE IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
publicIpAddressId

Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network.
publicNetworkAccess

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

De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd.
scmUrl

SCM-eindpunt-URL van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
targetProvisioningState

De inrichtingsstatus van de API Management-service, waarop de langdurige bewerking is gestart op de service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
virtualNetworkConfiguration

Configuratie van virtueel netwerk van de API Management-service.
virtualNetworkType

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

Eigenschapdetails

additionalLocations

Aanvullende datacenterlocaties van de API Management-service.

additionalLocations?: AdditionalLocation[]

Waarde van eigenschap

AdditionalLocation[]

apiVersionConstraint

Besturingselementvlak api's versiebeperking voor de API Management-service.

apiVersionConstraint?: ApiVersionConstraint

Waarde van eigenschap

ApiVersionConstraint

certificates

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.

certificates?: CertificateConfiguration[]

Waarde van eigenschap

CertificateConfiguration[]

createdAtUtc

Utc-datum van de API Management-service maken. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

createdAtUtc?: Date

Waarde van eigenschap

Date

customProperties

Aangepaste eigenschappen van de API Management-service.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA voor alle TLS(1.0, 1.1 en 1.2) uitschakelt.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan worden gebruikt om alleen TLS 1.1 uit te schakelen.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen op een API Management-service.
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.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan worden gebruikt om TLS 1.0 uit te schakelen voor communicatie met back-ends.
Instelling Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan worden gebruikt om het HTTP2-protocol in te schakelen voor een API Management-service.
Als u geen van deze eigenschappen opgeeft bij DE PATCH-bewerking, worden de waarden van de weggelaten eigenschappen teruggezet op de standaardwaarden. Voor alle instellingen behalve Http2 wordt de standaardwaarde True als de service is gemaakt op of vóór 1 april 2018 en anders False. De standaardwaarde van 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 deze waarden.
Opmerking: de volgende coderingen kunnen niet worden uitgeschakeld omdat ze zijn vereist 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

customProperties?: {[propertyName: string]: string}

Waarde van eigenschap

{[propertyName: string]: string}

developerPortalUrl

Eindpunt-URL van DEveloper Portal van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

developerPortalUrl?: string

Waarde van eigenschap

string

disableGateway

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.

disableGateway?: boolean

Waarde van eigenschap

boolean

enableClientCertificate

De eigenschap is alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven bij elke aanvraag voor de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.

enableClientCertificate?: boolean

Waarde van eigenschap

boolean

gatewayRegionalUrl

Gateway-URL van de API Management-service in de standaardregio. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

gatewayRegionalUrl?: string

Waarde van eigenschap

string

gatewayUrl

Gateway-URL van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

gatewayUrl?: string

Waarde van eigenschap

string

hostnameConfigurations

Aangepaste hostnaamconfiguratie van de API Management-service.

hostnameConfigurations?: HostnameConfiguration[]

Waarde van eigenschap

HostnameConfiguration[]

managementApiUrl

Eindpunt-URL voor beheer-API van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

managementApiUrl?: string

Waarde van eigenschap

string

natGatewayState

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

natGatewayState?: string

Waarde van eigenschap

string

notificationSenderEmail

E-mailadres van waaruit de melding wordt verzonden.

notificationSenderEmail?: string

Waarde van eigenschap

string

outboundPublicIPAddresses

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de nat-gateway geïmplementeerde service. Alleen beschikbaar voor Premium SKU op stv2-platform. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

outboundPublicIPAddresses?: string[]

Waarde van eigenschap

string[]

platformVersion

Compute Platform-versie waarop de service op deze locatie wordt uitgevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

platformVersion?: string

Waarde van eigenschap

string

portalUrl

Eindpunt-URL van de Publisher-portal van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

portalUrl?: string

Waarde van eigenschap

string

privateEndpointConnections

Lijst met privé-eindpuntverbindingen van deze service.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Waarde van eigenschap

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Privé-IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio die wordt geïmplementeerd in een intern virtueel netwerk. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

privateIPAddresses?: string[]

Waarde van eigenschap

string[]

provisioningState

De huidige inrichtingsstatus van de API Management-service die een van de volgende opties kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/Beëindigen/Beëindigen/BeëindigingFailed/Verwijderd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

provisioningState?: string

Waarde van eigenschap

string

publicIPAddresses

Openbare STATISCHE IP-adressen met gelijke taakverdeling van de API Management-service in de primaire regio. Alleen beschikbaar voor Basic, Standard, Premium en Geïsoleerde SKU. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

publicIPAddresses?: string[]

Waarde van eigenschap

string[]

publicIpAddressId

Openbare standaard-SKU IP V4 gebaseerd IP-adres dat moet worden gekoppeld aan de service Virtual Network geïmplementeerd in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network.

publicIpAddressId?: string

Waarde van eigenschap

string

publicNetworkAccess

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

publicNetworkAccess?: string

Waarde van eigenschap

string

restore

De Api Management-service ongedaan maken als deze eerder voorlopig is verwijderd. Als deze vlag is opgegeven en is ingesteld op Waar, worden alle andere eigenschappen genegeerd.

restore?: boolean

Waarde van eigenschap

boolean

scmUrl

SCM-eindpunt-URL van de API Management-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

scmUrl?: string

Waarde van eigenschap

string

targetProvisioningState

De inrichtingsstatus van de API Management-service, waarop de langdurige bewerking is gestart op de service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

targetProvisioningState?: string

Waarde van eigenschap

string

virtualNetworkConfiguration

Configuratie van virtueel netwerk van de API Management-service.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Waarde van eigenschap

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

Waarde van eigenschap

string