ApiManagementServiceResource 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.
A single API Management service resource in List or Get response.
[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiManagementServiceResource : Microsoft.Azure.Management.ApiManagement.Models.ApimResource[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiManagementServiceResource = class
inherit ApimResourcePublic Class ApiManagementServiceResource
Inherits ApimResource- Inheritance
- Attributes
Constructors
Properties
| AdditionalLocations |
Gets or sets additional datacenter locations of the API Management service. |
| ApiVersionConstraint |
Gets or sets control Plane Apis version constraint for the API Management service. |
| Certificates |
Gets or sets list of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10. |
| CreatedAtUtc |
Gets creation UTC date of the API Management service.The date
conforms to the following format: |
| CustomProperties |
Gets or sets custom properties of the API Management
service.</br>Setting
|
| DeveloperPortalUrl |
Gets dEveloper Portal endpoint URL of the API Management service. |
| DisableGateway |
Gets or sets property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region. |
| EnableClientCertificate |
Gets or sets 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 |
Gets eTag of the resource. |
| GatewayRegionalUrl |
Gets gateway URL of the API Management service in the Default Region. |
| GatewayUrl |
Gets gateway URL of the API Management service. |
| HostnameConfigurations |
Gets or sets custom hostname configuration of the API Management service. |
| Id |
Gets resource ID. (Inherited from ApimResource) |
| Identity |
Gets or sets managed service identity of the Api Management service. |
| Location |
Gets or sets resource location. |
| ManagementApiUrl |
Gets management API endpoint URL of the API Management service. |
| Name |
Gets resource name. (Inherited from ApimResource) |
| NotificationSenderEmail |
Gets or sets email address from which the notification will be sent. |
| PlatformVersion |
Gets compute Platform Version running the service in this location. Possible values include: 'undetermined', 'stv1', 'stv2', 'mtv1' |
| PortalUrl |
Gets publisher portal endpoint Url of the API Management service. |
| PrivateEndpointConnections |
Gets or sets list of Private Endpoint Connections of this service. |
| PrivateIPAddresses |
Gets 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 |
Gets 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 |
Gets public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU. |
| PublicIpAddressId |
Gets or sets 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 |
Gets or sets 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'. Possible values include: 'Enabled', 'Disabled' |
| PublisherEmail |
Gets or sets publisher email. |
| PublisherName |
Gets or sets publisher name. |
| Restore |
Gets or sets 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. |
| ScmUrl |
Gets SCM endpoint URL of the API Management service. |
| Sku |
Gets or sets SKU properties of the API Management service. |
| SystemData |
Gets metadata pertaining to creation and last modification of the resource. |
| Tags |
Gets or sets resource tags. (Inherited from ApimResource) |
| TargetProvisioningState |
Gets the provisioning state of the API Management service, which is targeted by the long running operation started on the service. |
| Type |
Gets resource type for API Management resource is set to Microsoft.ApiManagement. (Inherited from ApimResource) |
| VirtualNetworkConfiguration |
Gets or sets virtual network configuration of the API Management service. |
| VirtualNetworkType |
Gets or sets 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. Possible values include: 'None', 'External', 'Internal' |
| Zones |
Gets or sets a list of availability zones denoting where the resource needs to come from. |
Methods
| Validate() |
Validate the object. |
Applies to
Azure SDK for .NET