Share via


ApiCreateOrUpdateContent Class

Definition

Summary of revision metadata.

public class ApiCreateOrUpdateContent : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ApiCreateOrUpdateContent>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ApiCreateOrUpdateContent>
type ApiCreateOrUpdateContent = class
    interface IJsonModel<ApiCreateOrUpdateContent>
    interface IPersistableModel<ApiCreateOrUpdateContent>
Public Class ApiCreateOrUpdateContent
Implements IJsonModel(Of ApiCreateOrUpdateContent), IPersistableModel(Of ApiCreateOrUpdateContent)
Inheritance
ApiCreateOrUpdateContent
Implements

Constructors

ApiCreateOrUpdateContent()

Initializes a new instance of ApiCreateOrUpdateContent.

Properties

ApiRevision

Describes the revision of the API. If no value is provided, default revision 1 is created.

ApiRevisionDescription

Description of the API Revision.

ApiType

Type of API.

ApiVersion

Indicates the version identifier of the API if the API is versioned.

ApiVersionDescription

Description of the API Version.

ApiVersionSet

Version set details.

ApiVersionSetId

A resource identifier for the related ApiVersionSet.

AuthenticationSettings

Collection of authentication settings included into this API.

Contact

Contact information for the API.

Description

Description of the API. May include HTML formatting tags.

DisplayName

API name. Must be 1 to 300 characters long.

Format

Format of the Content in which the API is getting imported. New formats can be added in the future.

IsCurrent

Indicates if API revision is current api revision.

IsOnline

Indicates if API revision is accessible via the gateway.

IsSubscriptionRequired

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

License

License information for the API.

Path

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

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

ServiceLink

Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

SoapApiType

Type of API to create.

  • http creates a REST API
  • soap creates a SOAP pass-through API
  • websocket creates websocket API
  • graphql creates GraphQL API. New types can be added in the future.
SourceApiId

API identifier of the source API.

SubscriptionKeyParameterNames

Protocols over which API is made available.

TermsOfServiceLink

A URL to the Terms of Service for the API. MUST be in the format of a URL.

TranslateRequiredQueryParametersConduct

Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'.

Value

Content value when Importing an API.

WsdlSelector

Criteria to limit import of WSDL to a subset of the document.

Explicit Interface Implementations

IJsonModel<ApiCreateOrUpdateContent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ApiCreateOrUpdateContent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiCreateOrUpdateContent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ApiCreateOrUpdateContent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ApiCreateOrUpdateContent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to