Share via


ApiCreateOrUpdateParameter Class

Definition

API Create or Update Parameters.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiCreateOrUpdateParameter
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiCreateOrUpdateParameter = class
Public Class ApiCreateOrUpdateParameter
Inheritance
ApiCreateOrUpdateParameter
Attributes

Constructors

ApiCreateOrUpdateParameter()

Initializes a new instance of the ApiCreateOrUpdateParameter class.

ApiCreateOrUpdateParameter(String, String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>, ApiVersionSetContractDetails, String, String, ApiCreateOrUpdatePropertiesWsdlSelector, String)

Initializes a new instance of the ApiCreateOrUpdateParameter class.

Properties

ApiRevision

Gets or sets describes the revision of the API. If no value is provided, default revision 1 is created

ApiRevisionDescription

Gets or sets description of the API Revision.

ApiType

Gets or sets type of API. Possible values include: 'http', 'soap', 'websocket', 'graphql'

ApiVersion

Gets or sets indicates the version identifier of the API if the API is versioned

ApiVersionDescription

Gets or sets description of the API Version.

ApiVersionSet

Gets or sets version set details

ApiVersionSetId

Gets or sets a resource identifier for the related ApiVersionSet.

AuthenticationSettings

Gets or sets collection of authentication settings included into this API.

Contact

Gets or sets contact information for the API.

Description

Gets or sets description of the API. May include HTML formatting tags.

DisplayName

Gets or sets API name. Must be 1 to 300 characters long.

Format

Gets or sets format of the Content in which the API is getting imported. Possible values include: 'wadl-xml', 'wadl-link-json', 'swagger-json', 'swagger-link-json', 'wsdl', 'wsdl-link', 'openapi', 'openapi+json', 'openapi-link', 'openapi+json-link', 'graphql-link'

IsCurrent

Gets or sets indicates if API revision is current api revision.

IsOnline

Gets indicates if API revision is accessible via the gateway.

License

Gets or sets license information for the API.

Path

Gets or sets 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

Gets or sets describes on which protocols the operations in this API can be invoked.

ServiceUrl

Gets or sets absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SoapApiType

Gets or sets 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. Possible values include: 'SoapToRest', 'SoapPassThrough', 'WebSocket', 'GraphQL'
SourceApiId

Gets or sets API identifier of the source API.

SubscriptionKeyParameterNames

Gets or sets protocols over which API is made available.

SubscriptionRequired

Gets or sets specifies whether an API or Product subscription is required for accessing the API.

TermsOfServiceUrl

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

Value

Gets or sets content value when Importing an API.

WsdlSelector

Gets or sets criteria to limit import of WSDL to a subset of the document.

Methods

Validate()

Validate the object.

Applies to