GatewayApiData Class
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.
Summary of revision metadata.
public class GatewayApiData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.GatewayApiData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.GatewayApiData>
type GatewayApiData = class
inherit ResourceData
interface IJsonModel<GatewayApiData>
interface IPersistableModel<GatewayApiData>
Public Class GatewayApiData
Inherits ResourceData
Implements IJsonModel(Of GatewayApiData), IPersistableModel(Of GatewayApiData)
- Inheritance
- Implements
Constructors
GatewayApiData() |
Initializes a new instance of GatewayApiData. |
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. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
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. |
Name |
The name of the resource. (Inherited from ResourceData) |
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. |
ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
ServiceLink |
Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. |
SourceApiId |
API identifier of the source API. |
SubscriptionKeyParameterNames |
Protocols over which API is made available. |
SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
TermsOfServiceLink |
A URL to the Terms of Service for the API. MUST be in the format of a URL. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ResourceData) |
Explicit Interface Implementations
IJsonModel<GatewayApiData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<GatewayApiData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<GatewayApiData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<GatewayApiData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<GatewayApiData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |