ApiManagementServicePatch 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.
Parameter supplied to Update Api Management Service.
public class ApiManagementServicePatch : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ApiManagementServicePatch>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ApiManagementServicePatch>type ApiManagementServicePatch = class
inherit ResourceData
interface IJsonModel<ApiManagementServicePatch>
interface IPersistableModel<ApiManagementServicePatch>Public Class ApiManagementServicePatch
Inherits ResourceData
Implements IJsonModel(Of ApiManagementServicePatch), IPersistableModel(Of ApiManagementServicePatch)- Inheritance
- Implements
Constructors
| ApiManagementServicePatch() |
Initializes a new instance of ApiManagementServicePatch. |
Properties
| AdditionalLocations |
Additional datacenter locations of the API Management service. |
| Certificates |
List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. |
| CreatedAtUtc |
Creation UTC date of the API Management service.The date conforms to the following format: |
| CustomProperties |
Custom properties of the API Management service.</br>Setting |
| DeveloperPortalStatus |
Status of developer portal in this API Management service. |
| DeveloperPortalUri |
DEveloper Portal endpoint URL of the API Management service. |
| DisableGateway |
Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. |
| EnableClientCertificate |
Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway. |
| ETag |
ETag of the resource. |
| GatewayRegionalUri |
Gateway URL of the API Management service in the Default Region. |
| GatewayUri |
Gateway URL of the API Management service. |
| HostnameConfigurations |
Custom hostname configuration of the API Management service. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| Identity |
Managed service identity of the Api Management service. |
| LegacyApi |
Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'. |
| LegacyPortalStatus |
Status of legacy portal in the API Management service. |
| ManagementApiUri |
Management API endpoint URL of the API Management service. |
| MinApiVersion |
Limit control plane API calls to API Management service with version equal to or newer than this value. |
| Name |
The name of the resource. (Inherited from ResourceData) |
| NatGatewayState |
Property can be used to enable NAT Gateway for this API Management service. |
| NotificationSenderEmail |
Email address from which the notification will be sent. |
| OutboundPublicIPAddresses |
Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. |
| PlatformVersion |
Compute Platform Version running the service in this location. |
| PortalUri |
Publisher portal endpoint Url of the API Management service. |
| PrivateEndpointConnections |
List of Private Endpoint Connections of this service. |
| PrivateIPAddresses |
Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. |
| ProvisioningState |
The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. |
| PublicIPAddresses |
Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. |
| PublicIPAddressId |
Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. |
| PublicNetworkAccess |
Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'. |
| PublisherEmail |
Publisher email. |
| PublisherName |
Publisher name. |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| Restore |
Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored. |
| ScmUri |
SCM endpoint URL of the API Management service. |
| Sku |
SKU properties of the API Management service. |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| Tags |
Resource tags. |
| TargetProvisioningState |
The provisioning state of the API Management service, which is targeted by the long running operation started on the service. |
| VirtualNetworkConfiguration |
Virtual network configuration of the API Management service. |
| VirtualNetworkType |
The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. |
| Zones |
A list of availability zones denoting where the resource needs to come from. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ResourceData) |
Explicit Interface Implementations
| IJsonModel<ApiManagementServicePatch>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ApiManagementServicePatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ApiManagementServicePatch>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ApiManagementServicePatch>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ApiManagementServicePatch>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
