ApiContract interface

Package:

@azure/arm-apimanagement

API details.

Extends

ProxyResource

Properties

apiRevision	Describes the revision of the API. If no value is provided, default revision 1 is created
apiRevisionDescription	Description of the API Revision.
apiType	Type of API.
apiVersion	Indicates the version identifier of the API if the API is versioned
apiVersionDescription	Description of the API Version.
apiVersionSet	Version set details
apiVersionSetId	A resource identifier for the related ApiVersionSet.
authenticationSettings	Collection of authentication settings included into this API.
contact	Contact information for the API.
description	Description of the API. May include HTML formatting tags.
displayName	API name. Must be 1 to 300 characters long.
isCurrent	Indicates if API revision is current api revision.
isOnline	Indicates if API revision is accessible via the gateway. NOTE: This property will not be serialized. It can only be populated by the server.
license	License information for the API.
path	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.
protocols	Describes on which protocols the operations in this API can be invoked.
serviceUrl	Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
sourceApiId	API identifier of the source API.
subscriptionKeyParameterNames	Protocols over which API is made available.
subscriptionRequired	Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl	A URL to the Terms of Service for the API. MUST be in the format of a URL.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiRevision

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

apiRevision?: string

Property Value

string

apiRevisionDescription

Description of the API Revision.

apiRevisionDescription?: string

Property Value

string

apiType

Type of API.

apiType?: string

Property Value

string

apiVersion

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

apiVersion?: string

Property Value

string

apiVersionDescription

Description of the API Version.

apiVersionDescription?: string

Property Value

string

apiVersionSet

Version set details

apiVersionSet?: ApiVersionSetContractDetails

Property Value

ApiVersionSetContractDetails

apiVersionSetId

A resource identifier for the related ApiVersionSet.

apiVersionSetId?: string

Property Value

string

authenticationSettings

Collection of authentication settings included into this API.

authenticationSettings?: AuthenticationSettingsContract

Property Value

AuthenticationSettingsContract

contact

Contact information for the API.

contact?: ApiContactInformation

Property Value

ApiContactInformation

description

Description of the API. May include HTML formatting tags.

description?: string

Property Value

string

displayName

API name. Must be 1 to 300 characters long.

displayName?: string

Property Value

string

isCurrent

Indicates if API revision is current api revision.

isCurrent?: boolean

Property Value

boolean

isOnline

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

isOnline?: boolean

Property Value

boolean

license

License information for the API.

license?: ApiLicenseInformation

Property Value

ApiLicenseInformation

path

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.

path?: string

Property Value

string

protocols

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

protocols?: string[]

Property Value

string[]

serviceUrl

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

serviceUrl?: string

Property Value

string

sourceApiId

API identifier of the source API.

sourceApiId?: string

Property Value

string

subscriptionKeyParameterNames

Protocols over which API is made available.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Property Value

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Property Value

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type