Share via


ArmApiManagementModelFactory.ApiPatch Method

Definition

Initializes a new instance of ApiPatch.

public static Azure.ResourceManager.ApiManagement.Models.ApiPatch ApiPatch (string description = default, Azure.ResourceManager.ApiManagement.Models.AuthenticationSettingsContract authenticationSettings = default, Azure.ResourceManager.ApiManagement.Models.SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames = default, Azure.ResourceManager.ApiManagement.Models.ApiType? apiType = default, string apiRevision = default, string apiVersion = default, bool? isCurrent = default, bool? isOnline = default, string apiRevisionDescription = default, string apiVersionDescription = default, Azure.Core.ResourceIdentifier apiVersionSetId = default, bool? isSubscriptionRequired = default, string termsOfServiceLink = default, Azure.ResourceManager.ApiManagement.Models.ApiContactInformation contact = default, Azure.ResourceManager.ApiManagement.Models.ApiLicenseInformation license = default, string displayName = default, string serviceLink = default, string path = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.ApiOperationInvokableProtocol> protocols = default);
static member ApiPatch : string * Azure.ResourceManager.ApiManagement.Models.AuthenticationSettingsContract * Azure.ResourceManager.ApiManagement.Models.SubscriptionKeyParameterNamesContract * Nullable<Azure.ResourceManager.ApiManagement.Models.ApiType> * string * string * Nullable<bool> * Nullable<bool> * string * string * Azure.Core.ResourceIdentifier * Nullable<bool> * string * Azure.ResourceManager.ApiManagement.Models.ApiContactInformation * Azure.ResourceManager.ApiManagement.Models.ApiLicenseInformation * string * string * string * seq<Azure.ResourceManager.ApiManagement.Models.ApiOperationInvokableProtocol> -> Azure.ResourceManager.ApiManagement.Models.ApiPatch
Public Shared Function ApiPatch (Optional description As String = Nothing, Optional authenticationSettings As AuthenticationSettingsContract = Nothing, Optional subscriptionKeyParameterNames As SubscriptionKeyParameterNamesContract = Nothing, Optional apiType As Nullable(Of ApiType) = 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 ResourceIdentifier = Nothing, Optional isSubscriptionRequired As Nullable(Of Boolean) = Nothing, Optional termsOfServiceLink As String = Nothing, Optional contact As ApiContactInformation = Nothing, Optional license As ApiLicenseInformation = Nothing, Optional displayName As String = Nothing, Optional serviceLink As String = Nothing, Optional path As String = Nothing, Optional protocols As IEnumerable(Of ApiOperationInvokableProtocol) = Nothing) As ApiPatch

Parameters

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
Nullable<ApiType>

Type of API.

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.

isCurrent
Nullable<Boolean>

Indicates if API revision is current api revision.

isOnline
Nullable<Boolean>

Indicates if API revision is accessible via the gateway.

apiRevisionDescription
String

Description of the API Revision.

apiVersionDescription
String

Description of the API Version.

apiVersionSetId
ResourceIdentifier

A resource identifier for the related ApiVersionSet.

isSubscriptionRequired
Nullable<Boolean>

Specifies whether an API or Product subscription is required for accessing the API.

termsOfServiceLink
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.

displayName
String

API name.

serviceLink
String

Absolute URL of the backend service implementing this API.

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.

protocols
IEnumerable<ApiOperationInvokableProtocol>

Describes on which protocols the operations in this API can be invoked.

Returns

A new ApiPatch instance for mocking.

Applies to