Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ApiUpdateContract

Package version

API update contract details.

Hierarchy

  • ApiUpdateContract

Index

Properties

Optional apiRevision

apiRevision: undefined | string

Describes the revision of the API. If no value is provided, default revision 1 is created

Optional apiRevisionDescription

apiRevisionDescription: undefined | string

Description of the API Revision.

Optional apiType

apiType: ApiType

Type of API.

Optional apiVersion

apiVersion: undefined | string

Indicates the version identifier of the API if the API is versioned

Optional apiVersionDescription

apiVersionDescription: undefined | string

Description of the API Version.

Optional apiVersionSetId

apiVersionSetId: undefined | string

A resource identifier for the related ApiVersionSet.

Optional authenticationSettings

authenticationSettings: AuthenticationSettingsContract

Collection of authentication settings included into this API.

Optional contact

Contact information for the API.

Optional description

description: undefined | string

Description of the API. May include HTML formatting tags.

Optional displayName

displayName: undefined | string

API name.

Optional isCurrent

isCurrent: undefined | false | true

Indicates if API revision is current api revision.

Optional isOnline

isOnline: undefined | false | true

Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.

Optional license

License information for the API.

Optional path

path: undefined | string

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Optional protocols

protocols: Protocol[]

Describes on which protocols the operations in this API can be invoked.

Optional serviceUrl

serviceUrl: undefined | string

Absolute URL of the backend service implementing this API.

Optional subscriptionKeyParameterNames

subscriptionKeyParameterNames: SubscriptionKeyParameterNamesContract

Protocols over which API is made available.

Optional subscriptionRequired

subscriptionRequired: undefined | false | true

Specifies whether an API or Product subscription is required for accessing the API.

Optional termsOfServiceUrl

termsOfServiceUrl: undefined | string

A URL to the Terms of Service for the API. MUST be in the format of a URL.

Generated using TypeDoc