ApiPortalProperties interface

Package:

@azure/arm-appplatform

API portal properties payload

Properties

apiTryOutEnabledState	Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
gatewayIds	The array of resource Ids of gateway to integrate with API portal.
httpsOnly	Indicate if only https is allowed.
instances	Collection of instances belong to API portal. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	State of the API portal. NOTE: This property will not be serialized. It can only be populated by the server.
public	Indicates whether the API portal exposes endpoint.
resourceRequests	The requested resource quantity for required CPU and Memory. NOTE: This property will not be serialized. It can only be populated by the server.
sourceUrls	Collection of OpenAPI source URL locations.
ssoProperties	Single sign-on related configuration
url	URL of the API portal, exposed when 'public' is true. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiTryOutEnabledState

Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.

apiTryOutEnabledState?: string

Property Value

string

gatewayIds

The array of resource Ids of gateway to integrate with API portal.

gatewayIds?: string[]

Property Value

string[]

httpsOnly

Indicate if only https is allowed.

httpsOnly?: boolean

Property Value

boolean

instances

Collection of instances belong to API portal. NOTE: This property will not be serialized. It can only be populated by the server.

instances?: ApiPortalInstance[]

Property Value

ApiPortalInstance[]

provisioningState

State of the API portal. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

public

Indicates whether the API portal exposes endpoint.

public?: boolean

Property Value

boolean

resourceRequests

The requested resource quantity for required CPU and Memory. NOTE: This property will not be serialized. It can only be populated by the server.

resourceRequests?: ApiPortalResourceRequests

Property Value

ApiPortalResourceRequests

sourceUrls

Collection of OpenAPI source URL locations.

sourceUrls?: string[]

Property Value

string[]

ssoProperties

Single sign-on related configuration

ssoProperties?: SsoProperties

Property Value

SsoProperties

url

URL of the API portal, exposed when 'public' is true. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string