ApiContractProperties Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| 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. |
ApiContractProperties()
Initializes a new instance of the ApiContractProperties class.
public ApiContractProperties ();Public Sub New ()Applies to
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.
public ApiContractProperties (string path, string description = default, Microsoft.Azure.Management.ApiManagement.Models.AuthenticationSettingsContract authenticationSettings = default, Microsoft.Azure.Management.ApiManagement.Models.SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames = default, string apiType = default, string apiRevision = default, string apiVersion = default, bool? isCurrent = default, bool? isOnline = default, string apiRevisionDescription = default, string apiVersionDescription = default, string apiVersionSetId = default, bool? subscriptionRequired = default, string termsOfServiceUrl = default, Microsoft.Azure.Management.ApiManagement.Models.ApiContactInformation contact = default, Microsoft.Azure.Management.ApiManagement.Models.ApiLicenseInformation license = default, string sourceApiId = default, string displayName = default, string serviceUrl = default, System.Collections.Generic.IList<string> protocols = default, Microsoft.Azure.Management.ApiManagement.Models.ApiVersionSetContractDetails apiVersionSet = default);new Microsoft.Azure.Management.ApiManagement.Models.ApiContractProperties : string * string * Microsoft.Azure.Management.ApiManagement.Models.AuthenticationSettingsContract * Microsoft.Azure.Management.ApiManagement.Models.SubscriptionKeyParameterNamesContract * string * string * string * Nullable<bool> * Nullable<bool> * string * string * string * Nullable<bool> * string * Microsoft.Azure.Management.ApiManagement.Models.ApiContactInformation * Microsoft.Azure.Management.ApiManagement.Models.ApiLicenseInformation * string * string * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.ApiManagement.Models.ApiVersionSetContractDetails -> Microsoft.Azure.Management.ApiManagement.Models.ApiContractPropertiesPublic Sub New (path As String, Optional description As String = Nothing, Optional authenticationSettings As AuthenticationSettingsContract = Nothing, Optional subscriptionKeyParameterNames As SubscriptionKeyParameterNamesContract = Nothing, Optional apiType As String = Nothing, Optional apiRevision As String = Nothing, Optional apiVersion As String = Nothing, Optional isCurrent As Nullable(Of Boolean) = Nothing, Optional isOnline As Nullable(Of Boolean) = Nothing, Optional apiRevisionDescription As String = Nothing, Optional apiVersionDescription As String = Nothing, Optional apiVersionSetId As String = Nothing, Optional subscriptionRequired As Nullable(Of Boolean) = Nothing, Optional termsOfServiceUrl As String = Nothing, Optional contact As ApiContactInformation = Nothing, Optional license As ApiLicenseInformation = Nothing, Optional sourceApiId As String = Nothing, Optional displayName As String = Nothing, Optional serviceUrl As String = Nothing, Optional protocols As IList(Of String) = Nothing, Optional apiVersionSet As ApiVersionSetContractDetails = Nothing)Parameters
- path
- String
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.
- description
- String
Description of the API. May include HTML formatting tags.
- authenticationSettings
- AuthenticationSettingsContract
Collection of authentication settings included into this API.
- subscriptionKeyParameterNames
- SubscriptionKeyParameterNamesContract
Protocols over which API is made available.
- apiType
- String
Type of API. Possible values include: 'http', 'soap', 'websocket', 'graphql'
- apiRevision
- String
Describes the revision of the API. If no value is provided, default revision 1 is created
- apiVersion
- String
Indicates the version identifier of the API if the API is versioned
- apiRevisionDescription
- String
Description of the API Revision.
- apiVersionDescription
- String
Description of the API Version.
- apiVersionSetId
- String
A resource identifier for the related ApiVersionSet.
Specifies whether an API or Product subscription is required for accessing the API.
- termsOfServiceUrl
- String
A URL to the Terms of Service for the API. MUST be in the format of a URL.
- contact
- ApiContactInformation
Contact information for the API.
- license
- ApiLicenseInformation
License information for the API.
- sourceApiId
- String
API identifier of the source API.
- displayName
- String
API name. Must be 1 to 300 characters long.
- serviceUrl
- String
Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
- apiVersionSet
- ApiVersionSetContractDetails
Version set details
