Package version:

Interface ApiPortalProperties

API portal properties payload

Hierarchy

  • ApiPortalProperties

Properties

gatewayIds? httpsOnly? instances? provisioningState? public? resourceRequests? sourceUrls? ssoProperties? url?

Properties

Optional gatewayIds

gatewayIds?: string[]

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

Optional httpsOnly

httpsOnly?: boolean

Indicate if only https is allowed.

Optional Readonly instances

instances?: ApiPortalInstance[]

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

Optional Readonly provisioningState

provisioningState?: string

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

Optional public

public?: boolean

Indicates whether the API portal exposes endpoint.

Optional Readonly resourceRequests

resourceRequests?: ApiPortalResourceRequests

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

Optional sourceUrls

sourceUrls?: string[]

Collection of OpenAPI source URL locations.

Optional ssoProperties

ssoProperties?: SsoProperties

Single sign-on related configuration

Optional Readonly url

url?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc