ApiContractProperties Class

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement.Models

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

API Entity Properties

public class ApiContractProperties : Microsoft.Azure.Management.ApiManagement.Models.ApiEntityBaseContract

type ApiContractProperties = class
    inherit ApiEntityBaseContract

Public Class ApiContractProperties
Inherits ApiEntityBaseContract

Inheritance

Object

ApiEntityBaseContract

ApiContractProperties

Constructors

ApiContractProperties()	Initializes a new instance of the ApiContractProperties class.
ApiContractProperties(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)	Initializes a new instance of the ApiContractProperties class.

Properties

ApiRevision	Gets or sets describes the revision of the API. If no value is provided, default revision 1 is created (Inherited from ApiEntityBaseContract)
ApiRevisionDescription	Gets or sets description of the API Revision. (Inherited from ApiEntityBaseContract)
ApiType	Gets or sets type of API. Possible values include: 'http', 'soap', 'websocket', 'graphql' (Inherited from ApiEntityBaseContract)
ApiVersion	Gets or sets indicates the version identifier of the API if the API is versioned (Inherited from ApiEntityBaseContract)
ApiVersionDescription	Gets or sets description of the API Version. (Inherited from ApiEntityBaseContract)
ApiVersionSet	Gets or sets version set details
ApiVersionSetId	Gets or sets a resource identifier for the related ApiVersionSet. (Inherited from ApiEntityBaseContract)
AuthenticationSettings	Gets or sets collection of authentication settings included into this API. (Inherited from ApiEntityBaseContract)
Contact	Gets or sets contact information for the API. (Inherited from ApiEntityBaseContract)
Description	Gets or sets description of the API. May include HTML formatting tags. (Inherited from ApiEntityBaseContract)
DisplayName	Gets or sets API name. Must be 1 to 300 characters long.
IsCurrent	Gets or sets indicates if API revision is current api revision. (Inherited from ApiEntityBaseContract)
IsOnline	Gets indicates if API revision is accessible via the gateway. (Inherited from ApiEntityBaseContract)
License	Gets or sets license information for the API. (Inherited from ApiEntityBaseContract)
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. (Inherited from ApiEntityBaseContract)
SubscriptionRequired	Gets or sets specifies whether an API or Product subscription is required for accessing the API. (Inherited from ApiEntityBaseContract)
TermsOfServiceUrl	Gets or sets A URL to the Terms of Service for the API. MUST be in the format of a URL. (Inherited from ApiEntityBaseContract)

Methods

Validate()

Validate the object.