ApiContract Class

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement.Models

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

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

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

Object

Resource

ApiContract

Attributes

JsonTransformationAttribute

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, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>, 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', '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.
Id	Gets fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} (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.
License	Gets or sets license information for the API.
Name	Gets the name of the resource (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.
TermsOfServiceUrl	Gets or sets A URL to the Terms of Service for the API. MUST be in the format of a URL.
Type	Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from Resource)

Methods

Validate()

Validate the object.