Delen via

ApiManagementServiceResource interface

  • Referentie
Pakket:
@azure/arm-apimanagement

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

Uitbreiding
ApimResource

Eigenschappen

additionalLocations

Aanvullende datacenterlocaties van de API Management-service.
apiVersionConstraint

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

Lijst met certificaten die moeten worden geïnstalleerd in de API Management-service. Maximaal 10 ondersteunde certificaten die kunnen worden geïnstalleerd.
createdAtUtc

Utc-datum voor het maken van de API Management-service. De datum voldoet aan de volgende notatie: 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 schakelt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uit 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.
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 op een API Management-service.
Als u een van deze eigenschappen niet opgeeft in patchbewerking, 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 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
developerPortalUrl

Eindpunt-URL van de 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

Eigenschap die alleen is bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Dit dwingt af dat een clientcertificaat wordt gepresenteerd bij elke aanvraag aan de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.
etag

ETag van de resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
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.
identity

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

Resourcelocatie.
managementApiUrl

Eindpunt-URL van de 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

Email adres van waaruit de melding wordt verzonden.
outboundPublicIPAddresses

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de geïmplementeerde NAT Gateway-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 is geïmplementeerd in een interne Virtual Network. Alleen beschikbaar voor Basic, Standard, Premium en Isolated 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 kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/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 Isolated SKU. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
publicIpAddressId

Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service in de regio. Alleen ondersteund voor ontwikkelaars en Premium-SKU's die worden geïmplementeerd in Virtual Network.
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
publisherEmail

E-mailadres van uitgever.
publisherName

Naam van uitgever.
restore

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

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

SKU-eigenschappen van de API Management-service.
systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. 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 gericht die is gestart op de service. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
virtualNetworkConfiguration

Configuratie van het virtuele netwerk van de API Management-service.
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.
zones

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

Overgenomen eigenschappen

id

Resource-id. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name

Resourcenaam. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
tags

Resourcetags.
type

Het resourcetype voor API Management resource is ingesteld op Microsoft.ApiManagement. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

additionalLocations

Aanvullende datacenterlocaties van de API Management-service.

additionalLocations?: AdditionalLocation[]

Waarde van eigenschap

AdditionalLocation[]

apiVersionConstraint

Versiebeperking besturingsvlak-API's 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. Maximaal 10 ondersteunde certificaten die kunnen worden geïnstalleerd.

certificates?: CertificateConfiguration[]

Waarde van eigenschap

CertificateConfiguration[]

createdAtUtc

Utc-datum voor het maken van de API Management-service. De datum voldoet aan de volgende notatie: 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 schakelt de coderings-TLS_RSA_WITH_3DES_EDE_CBC_SHA uit 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.
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 op een API Management-service.
Als u een van deze eigenschappen niet opgeeft in patchbewerking, 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 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

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

Waarde van eigenschap

{[propertyName: string]: string}

developerPortalUrl

Eindpunt-URL van de 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

Eigenschap die alleen is bedoeld om te worden gebruikt voor de verbruiks-SKU-service. Dit dwingt af dat een clientcertificaat wordt gepresenteerd bij elke aanvraag aan de gateway. Hiermee kunt u ook het certificaat verifiëren in het beleid op de gateway.

enableClientCertificate?: boolean

Waarde van eigenschap

boolean

etag

ETag van de resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

etag?: string

Waarde van eigenschap

string

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[]

identity

Beheerde service-identiteit van de Api Management-service.

identity?: ApiManagementServiceIdentity

Waarde van eigenschap

ApiManagementServiceIdentity

location

Resourcelocatie.

location: string

Waarde van eigenschap

string

managementApiUrl

Eindpunt-URL van de 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

Email adres van waaruit de melding wordt verzonden.

notificationSenderEmail?: string

Waarde van eigenschap

string

outboundPublicIPAddresses

Uitgaande openbare IPV4-adresvoorvoegsels die zijn gekoppeld aan de geïmplementeerde NAT Gateway-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 is geïmplementeerd in een interne Virtual Network. Alleen beschikbaar voor Basic, Standard, Premium en Isolated 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 kan zijn: Gemaakt/Activeren/Geslaagd/Bijwerken/Mislukt/Gestopt/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 Isolated SKU. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

publicIPAddresses?: string[]

Waarde van eigenschap

string[]

publicIpAddressId

Ip-adres op basis van openbare standaard-SKU V4 dat moet worden gekoppeld aan Virtual Network geïmplementeerde service 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 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

publicNetworkAccess?: string

Waarde van eigenschap

string

publisherEmail

E-mailadres van uitgever.

publisherEmail: string

Waarde van eigenschap

string

publisherName

Naam van uitgever.

publisherName: string

Waarde van eigenschap

string

restore

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.

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

sku

SKU-eigenschappen van de API Management-service.

sku: ApiManagementServiceSkuProperties

Waarde van eigenschap

ApiManagementServiceSkuProperties

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

systemData?: SystemData

Waarde van eigenschap

SystemData

targetProvisioningState

De inrichtingsstatus van de API Management-service, waarop de langdurige bewerking is gericht die 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 het virtuele netwerk van de API Management-service.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Waarde van eigenschap

VirtualNetworkConfiguration

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.

virtualNetworkType?: string

Waarde van eigenschap

string

zones

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

zones?: string[]

Waarde van eigenschap

string[]

Details van overgenomen eigenschap

id

Resource-id. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

Overgenomen vanApimResource.id

name

Resourcenaam. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

Overgenomen vanApimResource.name

tags

Resourcetags.

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

Waarde van eigenschap

{[propertyName: string]: string}

Overgenomen vanApimResource.tags

type

Het resourcetype voor API Management resource is ingesteld op Microsoft.ApiManagement. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

Overgenomen vanApimResource.type