ApiUpdateContract Class

Definition

API update contract details.

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

Constructors

ApiUpdateContract()

Initializes a new instance of the ApiUpdateContract class.

ApiUpdateContract(String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>)

Initializes a new instance of the ApiUpdateContract 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.

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.

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.

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.

Methods

Validate()

Validate the object.

Applies to