Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiPortalProperties

Package version

API portal properties payload

Hierarchy

  • ApiPortalProperties

Index

Properties

Optional gatewayIds

gatewayIds: string[]

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

Optional httpsOnly

httpsOnly: undefined | false | true

Indicate if only https is allowed.

Optional 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 provisioningState

provisioningState: ApiPortalProvisioningState

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

Optional public

public: undefined | false | true

Indicates whether the API portal exposes endpoint.

Optional 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 url

url: undefined | 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.

Generated using TypeDoc