Share via


AssociatedApiProperties Class

Definition

API contract properties for the Tag Resources.

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

Properties

ApiRevision

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

(Inherited from ApiEntityBaseContract)
ApiRevisionDescription

Description of the API Revision.

(Inherited from ApiEntityBaseContract)
ApiType

Type of API.

(Inherited from ApiEntityBaseContract)
ApiVersion

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

(Inherited from ApiEntityBaseContract)
ApiVersionDescription

Description of the API Version.

(Inherited from ApiEntityBaseContract)
ApiVersionSetId

A resource identifier for the related ApiVersionSet.

(Inherited from ApiEntityBaseContract)
AuthenticationSettings

Collection of authentication settings included into this API.

(Inherited from ApiEntityBaseContract)
Contact

Contact information for the API.

(Inherited from ApiEntityBaseContract)
Description

Description of the API. May include HTML formatting tags.

(Inherited from ApiEntityBaseContract)
Id

API identifier in the form /apis/{apiId}.

IsCurrent

Indicates if API revision is current api revision.

(Inherited from ApiEntityBaseContract)
IsOnline

Indicates if API revision is accessible via the gateway.

(Inherited from ApiEntityBaseContract)
IsSubscriptionRequired

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

(Inherited from ApiEntityBaseContract)
License

License information for the API.

(Inherited from ApiEntityBaseContract)
Name

API name.

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.

ServiceUri

Absolute URL of the backend service implementing this API.

SubscriptionKeyParameterNames

Protocols over which API is made available.

(Inherited from ApiEntityBaseContract)
TermsOfServiceLink

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

(Inherited from ApiEntityBaseContract)

Explicit Interface Implementations

IJsonModel<ApiEntityBaseContract>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from ApiEntityBaseContract)
IJsonModel<ApiEntityBaseContract>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ApiEntityBaseContract)
IJsonModel<AssociatedApiProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AssociatedApiProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ApiEntityBaseContract>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ApiEntityBaseContract)
IPersistableModel<ApiEntityBaseContract>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from ApiEntityBaseContract)
IPersistableModel<ApiEntityBaseContract>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ApiEntityBaseContract)
IPersistableModel<AssociatedApiProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AssociatedApiProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AssociatedApiProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to