ApiManagementServiceBaseProperties Class

Definition

Namespace:

Microsoft.Azure.Management.ApiManagement.Models

Assembly:

Microsoft.Azure.Management.ApiManagement.dll

Package:

Microsoft.Azure.Management.ApiManagement v8.0.0-preview

Base Properties of an API Management service resource description.

public class ApiManagementServiceBaseProperties

type ApiManagementServiceBaseProperties = class

Public Class ApiManagementServiceBaseProperties

Inheritance

Object

ApiManagementServiceBaseProperties

Constructors

ApiManagementServiceBaseProperties()

Initializes a new instance of the ApiManagementServiceBaseProperties class.

ApiManagementServiceBaseProperties(String, String, String, Nullable<DateTime>, String, String, String, String, String, String, IList<HostnameConfiguration>, IList<String>, IList<String>, String, String, VirtualNetworkConfiguration, IList<AdditionalLocation>, IDictionary<String,String>, IList<CertificateConfiguration>, Nullable<Boolean>, Nullable<Boolean>, String, ApiVersionConstraint, Nullable<Boolean>, IList<RemotePrivateEndpointConnectionWrapper>, String)

Initializes a new instance of the ApiManagementServiceBaseProperties class.

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: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
CustomProperties	Gets or sets custom properties of the API Management service.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.</br>Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.</br>Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.</br></br>You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384
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.
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.
ManagementApiUrl	Gets management API endpoint URL of the API Management service.
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'
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.
TargetProvisioningState	Gets the provisioning state of the API Management service, which is targeted by the long running operation started on the service.
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'

Methods

Validate()

Validate the object.