ApiContract Class

Definition

Api details.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiContract = class
    inherit Resource
Public Class ApiContract
Inherits Resource
Inheritance
System.Object
ApiContract
Attributes

Constructors

ApiContract()

Initializes a new instance of the ApiContract class.

ApiContract(String, String, String, String, String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, String, String, IList<Nullable<Protocol>>, ApiVersionSetContractDetails)

Initializes a new instance of the ApiContract 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'

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.

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.

Id

Gets resource ID.

(Inherited from Resource)
IsCurrent

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

IsOnline

Gets indicates if API revision is accessible via the gateway.

Name

Gets resource name.

(Inherited from Resource)
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.

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.

Type

Gets resource type for API Management resource.

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to