ApiCreateOrUpdateProperties interface

Package:

@azure/arm-apimanagement

API Create or Update Properties.

Extends

ApiContractProperties

Properties

format	Format of the Content in which the API is getting imported.
soapApiType	Type of API to create. http creates a REST API soap creates a SOAP pass-through API websocket creates websocket API graphql creates GraphQL API.
translateRequiredQueryParametersConduct	Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'
value	Content value when Importing an API.
wsdlSelector	Criteria to limit import of WSDL to a subset of the document.

Inherited 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.

Property Details

format

Format of the Content in which the API is getting imported.

format?: string

Property Value

string

soapApiType

Type of API to create.

• http creates a REST API
• soap creates a SOAP pass-through API
• websocket creates websocket API
• graphql creates GraphQL API.

soapApiType?: string

Property Value

string

translateRequiredQueryParametersConduct

Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Property Value

string

value

Content value when Importing an API.

value?: string

Property Value

string

wsdlSelector

Criteria to limit import of WSDL to a subset of the document.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Property Value

ApiCreateOrUpdatePropertiesWsdlSelector

Inherited Property Details

apiRevision

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

apiRevision?: string

Property Value

string

Inherited From ApiContractProperties.apiRevision

apiRevisionDescription

Description of the API Revision.

apiRevisionDescription?: string

Property Value

string

Inherited From ApiContractProperties.apiRevisionDescription

apiType

Type of API.

apiType?: string

Property Value

string

Inherited From ApiContractProperties.apiType

apiVersion

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

apiVersion?: string

Property Value

string

Inherited From ApiContractProperties.apiVersion

apiVersionDescription

Description of the API Version.

apiVersionDescription?: string

Property Value

string

Inherited From ApiContractProperties.apiVersionDescription

apiVersionSet

Version set details

apiVersionSet?: ApiVersionSetContractDetails

Property Value

ApiVersionSetContractDetails

Inherited From ApiContractProperties.apiVersionSet

apiVersionSetId

A resource identifier for the related ApiVersionSet.

apiVersionSetId?: string

Property Value

string

Inherited From ApiContractProperties.apiVersionSetId

authenticationSettings

Collection of authentication settings included into this API.

authenticationSettings?: AuthenticationSettingsContract

Property Value

AuthenticationSettingsContract

Inherited From ApiContractProperties.authenticationSettings

contact

Contact information for the API.

contact?: ApiContactInformation

Property Value

ApiContactInformation

Inherited From ApiContractProperties.contact

description

Description of the API. May include HTML formatting tags.

description?: string

Property Value

string

Inherited From ApiContractProperties.description

displayName

API name. Must be 1 to 300 characters long.

displayName?: string

Property Value

string

Inherited From ApiContractProperties.displayName

isCurrent

Indicates if API revision is current api revision.

isCurrent?: boolean

Property Value

boolean

Inherited From ApiContractProperties.isCurrent

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

Inherited From ApiContractProperties.isOnline

license

License information for the API.

license?: ApiLicenseInformation

Property Value

ApiLicenseInformation

Inherited From ApiContractProperties.license

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

Inherited From ApiContractProperties.path

protocols

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

protocols?: string[]

Property Value

string[]

Inherited From ApiContractProperties.protocols

serviceUrl

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

serviceUrl?: string

Property Value

string

Inherited From ApiContractProperties.serviceUrl

sourceApiId

API identifier of the source API.

sourceApiId?: string

Property Value

string

Inherited From ApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocols over which API is made available.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Property Value

SubscriptionKeyParameterNamesContract

Inherited From ApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Property Value

boolean

Inherited From ApiContractProperties.subscriptionRequired

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 From ApiContractProperties.termsOfServiceUrl