ApiContractProperties ApiContractProperties ApiContractProperties Class

Definition

Api Entity Properties

public class ApiContractProperties : Microsoft.Azure.Management.ApiManagement.Models.ApiEntityBaseContract
type ApiContractProperties = class
    inherit ApiEntityBaseContract
Public Class ApiContractProperties
Inherits ApiEntityBaseContract
Inheritance
ApiContractPropertiesApiContractPropertiesApiContractProperties

Constructors

ApiContractProperties() ApiContractProperties() ApiContractProperties()

Initializes a new instance of the ApiContractProperties class.

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

Initializes a new instance of the ApiContractProperties class.

Properties

ApiRevision ApiRevision ApiRevision

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

(Inherited from ApiEntityBaseContract)
ApiRevisionDescription ApiRevisionDescription ApiRevisionDescription

Gets or sets description of the Api Revision.

(Inherited from ApiEntityBaseContract)
ApiType ApiType ApiType

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

(Inherited from ApiEntityBaseContract)
ApiVersion ApiVersion ApiVersion

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

(Inherited from ApiEntityBaseContract)
ApiVersionDescription ApiVersionDescription ApiVersionDescription

Gets or sets description of the Api Version.

(Inherited from ApiEntityBaseContract)
ApiVersionSet ApiVersionSet ApiVersionSet
ApiVersionSetId ApiVersionSetId ApiVersionSetId

Gets or sets a resource identifier for the related ApiVersionSet.

(Inherited from ApiEntityBaseContract)
AuthenticationSettings AuthenticationSettings AuthenticationSettings

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

(Inherited from ApiEntityBaseContract)
Description Description Description

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

(Inherited from ApiEntityBaseContract)
DisplayName DisplayName DisplayName

Gets or sets API name.

IsCurrent IsCurrent IsCurrent

Gets indicates if API revision is current api revision.

(Inherited from ApiEntityBaseContract)
IsOnline IsOnline IsOnline

Gets indicates if API revision is accessible via the gateway.

(Inherited from ApiEntityBaseContract)
Path Path 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 Protocols Protocols

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

ServiceUrl ServiceUrl ServiceUrl

Gets or sets absolute URL of the backend service implementing this API.

SubscriptionKeyParameterNames SubscriptionKeyParameterNames SubscriptionKeyParameterNames

Gets or sets protocols over which API is made available.

(Inherited from ApiEntityBaseContract)

Methods

Validate() Validate() Validate()

Validate the object.

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to