ApiManagementServiceResource interface

Paket:

@azure/arm-apimanagement

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

Extends

ApimResource

Egenskaper

additionalLocations	Ytterligare datacenterplatser för API Management-tjänsten.
apiVersionConstraint	Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.
certificates	Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds och som kan installeras är 10.
createdAtUtc	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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
customProperties	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
developerPortalUrl	DEveloper-portalens slutpunkts-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
disableGateway	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.
enableClientCertificate	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.
etag	ETag för resursen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
gatewayRegionalUrl	Gateway-URL för API Management-tjänsten i standardregionen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
gatewayUrl	Gateway-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
hostnameConfigurations	Anpassad värdnamnskonfiguration för API Management-tjänsten.
identity	Hanterad tjänstidentitet för Api Management-tjänsten.
location	Resursplats.
managementApiUrl	API-slutpunkts-URL för hantering av API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
natGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
notificationSenderEmail	Email adress som meddelandet ska skickas från.
outboundPublicIPAddresses	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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
platformVersion	Compute Platform Version som kör tjänsten på den här platsen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
portalUrl	Slutpunkts-URL för utgivarportalen för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
privateEndpointConnections	Lista över privata slutpunktsanslutningar för den här tjänsten.
privateIPAddresses	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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
provisioningState	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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
publicIPAddresses	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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
publicIpAddressId	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.
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"
publisherEmail	E-postutfärdare.
publisherName	Utgivarens namn.
restore	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.
scmUrl	SCM-slutpunkts-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
sku	SKU-egenskaper för API Management-tjänsten.
systemData	Metadata som rör skapande och senaste ändring av resursen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
targetProvisioningState	Etableringstillståndet för API Management-tjänsten, som är mål för den långvariga åtgärd som startades på tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
virtualNetworkConfiguration	Konfiguration av virtuellt nätverk för API Management-tjänsten.
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.
zones	En lista över tillgänglighetszoner som anger var resursen måste komma ifrån.

Ärvda egenskaper

id	Resurs-ID. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
name	Resursnamn. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
tags	Resurstaggar.
type	Resurstypen för API Management resurs är inställd på Microsoft.ApiManagement. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

Egenskapsinformation

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Egenskapsvärde

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Egenskapsvärde

ApiVersionConstraint

certificates

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

certificates?: CertificateConfiguration[]

Egenskapsvärde

CertificateConfiguration[]

createdAtUtc

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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

createdAtUtc?: Date

Egenskapsvärde

Date

customProperties

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

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

Egenskapsvärde

{[propertyName: string]: string}

developerPortalUrl

DEveloper-portalens slutpunkts-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

developerPortalUrl?: string

Egenskapsvärde

string

disableGateway

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.

disableGateway?: boolean

Egenskapsvärde

boolean

enableClientCertificate

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.

enableClientCertificate?: boolean

Egenskapsvärde

boolean

etag

ETag för resursen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

etag?: string

Egenskapsvärde

string

gatewayRegionalUrl

Gateway-URL för API Management-tjänsten i standardregionen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

gatewayRegionalUrl?: string

Egenskapsvärde

string

gatewayUrl

Gateway-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

gatewayUrl?: string

Egenskapsvärde

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Egenskapsvärde

HostnameConfiguration[]

identity

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

identity?: ApiManagementServiceIdentity

Egenskapsvärde

ApiManagementServiceIdentity

location

Resursplats.

location: string

Egenskapsvärde

string

managementApiUrl

API-slutpunkts-URL för hantering av API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

managementApiUrl?: string

Egenskapsvärde

string

natGatewayState

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

natGatewayState?: string

Egenskapsvärde

string

notificationSenderEmail

Email adress som meddelandet ska skickas från.

notificationSenderEmail?: string

Egenskapsvärde

string

outboundPublicIPAddresses

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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

outboundPublicIPAddresses?: string[]

Egenskapsvärde

string[]

platformVersion

Compute Platform Version som kör tjänsten på den här platsen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

platformVersion?: string

Egenskapsvärde

string

portalUrl

Slutpunkts-URL för utgivarportalen för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

portalUrl?: string

Egenskapsvärde

string

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Egenskapsvärde

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

privateIPAddresses?: string[]

Egenskapsvärde

string[]

provisioningState

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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

provisioningState?: string

Egenskapsvärde

string

publicIPAddresses

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. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

publicIPAddresses?: string[]

Egenskapsvärde

string[]

publicIpAddressId

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.

publicIpAddressId?: string

Egenskapsvärde

string

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"

publicNetworkAccess?: string

Egenskapsvärde

string

publisherEmail

E-postutfärdare.

publisherEmail: string

Egenskapsvärde

string

publisherName

Utgivarens namn.

publisherName: string

Egenskapsvärde

string

restore

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.

restore?: boolean

Egenskapsvärde

boolean

scmUrl

SCM-slutpunkts-URL för API Management-tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

scmUrl?: string

Egenskapsvärde

string

sku

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

sku: ApiManagementServiceSkuProperties

Egenskapsvärde

ApiManagementServiceSkuProperties

systemData

Metadata som rör skapande och senaste ändring av resursen. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

systemData?: SystemData

Egenskapsvärde

SystemData

targetProvisioningState

Etableringstillståndet för API Management-tjänsten, som är mål för den långvariga åtgärd som startades på tjänsten. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

targetProvisioningState?: string

Egenskapsvärde

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Egenskapsvärde

VirtualNetworkConfiguration

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.

virtualNetworkType?: string

Egenskapsvärde

string

zones

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

zones?: string[]

Egenskapsvärde

string[]

Information om ärvda egenskaper

id

Resurs-ID. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

id?: string

Egenskapsvärde

string

Ärvd frånApimResource.id

name

Resursnamn. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

name?: string

Egenskapsvärde

string

Ärvd frånApimResource.name

tags

Resurstaggar.

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

Egenskapsvärde

{[propertyName: string]: string}

Ärvd frånApimResource.tags

type

Resurstypen för API Management resurs är inställd på Microsoft.ApiManagement. Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.

type?: string

Egenskapsvärde

string

Ärvd frånApimResource.type