ApiManagementServiceResourceInner Class

Package:

com.azure.resourcemanager.apimanagement.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.apimanagement.models.ApimResource
    • • com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner

public final class ApiManagementServiceResourceInner
extends ApimResource

A single API Management service resource in List or Get response.

Constructor Summary

Constructor	Description
ApiManagementServiceResourceInner()	Creates an instance of ApiManagementServiceResourceInner class.

Method Summary

Modifier and Type	Method and Description
List<AdditionalLocation>	additionalLocations() Get the additionalLocations property: Additional datacenter locations of the API Management service.
ApiVersionConstraint	apiVersionConstraint() Get the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.
List<CertificateConfiguration>	certificates() Get the certificates property: List of Certificates that need to be installed in the API Management service.
OffsetDateTime	createdAtUtc() Get the createdAtUtc property: 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.
Map<String,String>	customProperties() Get the customProperties property: Custom properties of the API Management service. 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). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service. Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults.
String	developerPortalUrl() Get the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.
Boolean	disableGateway() Get the disableGateway property: Property only valid for an Api Management service deployed in multiple locations.
Boolean	enableClientCertificate() Get the enableClientCertificate property: Property only meant to be used for Consumption SKU Service.
String	etag() Get the etag property: ETag of the resource.
String	gatewayRegionalUrl() Get the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.
String	gatewayUrl() Get the gatewayUrl property: Gateway URL of the API Management service.
List<HostnameConfiguration>	hostnameConfigurations() Get the hostnameConfigurations property: Custom hostname configuration of the API Management service.
ApiManagementServiceIdentity	identity() Get the identity property: Managed service identity of the Api Management service.
String	location() Get the location property: Resource location.
String	managementApiUrl() Get the managementApiUrl property: Management API endpoint URL of the API Management service.
NatGatewayState	natGatewayState() Get the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
String	notificationSenderEmail() Get the notificationSenderEmail property: Email address from which the notification will be sent.
List<String>	outboundPublicIpAddresses() Get the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service.
PlatformVersion	platformVersion() Get the platformVersion property: Compute Platform Version running the service in this location.
String	portalUrl() Get the portalUrl property: Publisher portal endpoint Url of the API Management service.
List<RemotePrivateEndpointConnectionWrapper>	privateEndpointConnections() Get the privateEndpointConnections property: List of Private Endpoint Connections of this service.
List<String>	privateIpAddresses() Get the privateIpAddresses property: Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network.
String	provisioningState() Get the provisioningState property: 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.
String	publicIpAddressId() Get the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region.
List<String>	publicIpAddresses() Get the publicIpAddresses property: Public Static Load Balanced IP addresses of the API Management service in Primary region.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service.
String	publisherEmail() Get the publisherEmail property: Publisher email.
String	publisherName() Get the publisherName property: Publisher name.
Boolean	restore() Get the restore property: Undelete Api Management Service if it was previously soft-deleted.
String	scmUrl() Get the scmUrl property: SCM endpoint URL of the API Management service.
ApiManagementServiceSkuProperties	sku() Get the sku property: SKU properties of the API Management service.
SystemData	systemData() Get the systemData property: Metadata pertaining to creation and last modification of the resource.
String	targetProvisioningState() Get the targetProvisioningState property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
void	validate() Validates the instance.
VirtualNetworkConfiguration	virtualNetworkConfiguration() Get the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.
VirtualNetworkType	virtualNetworkType() Get the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in.
ApiManagementServiceResourceInner	withAdditionalLocations(List<AdditionalLocation> additionalLocations) Set the additionalLocations property: Additional datacenter locations of the API Management service.
ApiManagementServiceResourceInner	withApiVersionConstraint(ApiVersionConstraint apiVersionConstraint) Set the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.
ApiManagementServiceResourceInner	withCertificates(List<CertificateConfiguration> certificates) Set the certificates property: List of Certificates that need to be installed in the API Management service.
ApiManagementServiceResourceInner	withCustomProperties(Map<String,String> customProperties) Set the customProperties property: Custom properties of the API Management service. 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). Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends. Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service. Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults.
ApiManagementServiceResourceInner	withDisableGateway(Boolean disableGateway) Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations.
ApiManagementServiceResourceInner	withEnableClientCertificate(Boolean enableClientCertificate) Set the enableClientCertificate property: Property only meant to be used for Consumption SKU Service.
ApiManagementServiceResourceInner	withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations) Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.
ApiManagementServiceResourceInner	withIdentity(ApiManagementServiceIdentity identity) Set the identity property: Managed service identity of the Api Management service.
ApiManagementServiceResourceInner	withLocation(String location) Set the location property: Resource location.
ApiManagementServiceResourceInner	withNatGatewayState(NatGatewayState natGatewayState) Set the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
ApiManagementServiceResourceInner	withNotificationSenderEmail(String notificationSenderEmail) Set the notificationSenderEmail property: Email address from which the notification will be sent.
ApiManagementServiceResourceInner	withPrivateEndpointConnections(List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections) Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.
ApiManagementServiceResourceInner	withPublicIpAddressId(String publicIpAddressId) Set the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region.
ApiManagementServiceResourceInner	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service.
ApiManagementServiceResourceInner	withPublisherEmail(String publisherEmail) Set the publisherEmail property: Publisher email.
ApiManagementServiceResourceInner	withPublisherName(String publisherName) Set the publisherName property: Publisher name.
ApiManagementServiceResourceInner	withRestore(Boolean restore) Set the restore property: Undelete Api Management Service if it was previously soft-deleted.
ApiManagementServiceResourceInner	withSku(ApiManagementServiceSkuProperties sku) Set the sku property: SKU properties of the API Management service.
ApiManagementServiceResourceInner	withTags(Map<String,String> tags) Set the tags property: Resource tags.
ApiManagementServiceResourceInner	withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration) Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.
ApiManagementServiceResourceInner	withVirtualNetworkType(VirtualNetworkType virtualNetworkType) Set the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in.
ApiManagementServiceResourceInner	withZones(List<String> zones) Set the zones property: A list of availability zones denoting where the resource needs to come from.
List<String>	zones() Get the zones property: A list of availability zones denoting where the resource needs to come from.

Methods inherited from ProxyResource

id name type

Methods inherited from ApimResource

tags validate withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApiManagementServiceResourceInner

public ApiManagementServiceResourceInner()

Creates an instance of ApiManagementServiceResourceInner class.

Method Details

additionalLocations

public List additionalLocations()

Get the additionalLocations property: Additional datacenter locations of the API Management service.

Returns:

the additionalLocations value.

apiVersionConstraint

public ApiVersionConstraint apiVersionConstraint()

Get the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.

Returns:

the apiVersionConstraint value.

certificates

public List certificates()

Get the certificates property: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Returns:

the certificates value.

createdAtUtc

public OffsetDateTime createdAtUtc()

Get the createdAtUtc property: 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.

Returns:

the createdAtUtc value.

customProperties

public Map customProperties()

Get the customProperties property: Custom properties of the API Management service.
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).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
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 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following 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: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,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.

Returns:

the customProperties value.

developerPortalUrl

public String developerPortalUrl()

Get the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.

Returns:

the developerPortalUrl value.

disableGateway

public Boolean disableGateway()

Get the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

Returns:

the disableGateway value.

enableClientCertificate

public Boolean enableClientCertificate()

Get the enableClientCertificate property: 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.

Returns:

the enableClientCertificate value.

etag

public String etag()

Get the etag property: ETag of the resource.

Returns:

the etag value.

gatewayRegionalUrl

public String gatewayRegionalUrl()

Get the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.

Returns:

the gatewayRegionalUrl value.

gatewayUrl

public String gatewayUrl()

Get the gatewayUrl property: Gateway URL of the API Management service.

Returns:

the gatewayUrl value.

hostnameConfigurations

public List hostnameConfigurations()

Get the hostnameConfigurations property: Custom hostname configuration of the API Management service.

Returns:

the hostnameConfigurations value.

identity

public ApiManagementServiceIdentity identity()

Get the identity property: Managed service identity of the Api Management service.

Returns:

the identity value.

location

public String location()

Get the location property: Resource location.

Returns:

the location value.

managementApiUrl

public String managementApiUrl()

Get the managementApiUrl property: Management API endpoint URL of the API Management service.

Returns:

the managementApiUrl value.

natGatewayState

public NatGatewayState natGatewayState()

Get the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.

Returns:

the natGatewayState value.

notificationSenderEmail

public String notificationSenderEmail()

Get the notificationSenderEmail property: Email address from which the notification will be sent.

Returns:

the notificationSenderEmail value.

outboundPublicIpAddresses

public List outboundPublicIpAddresses()

Get the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.

Returns:

the outboundPublicIpAddresses value.

platformVersion

public PlatformVersion platformVersion()

Get the platformVersion property: Compute Platform Version running the service in this location.

Returns:

the platformVersion value.

portalUrl

public String portalUrl()

Get the portalUrl property: Publisher portal endpoint Url of the API Management service.

Returns:

the portalUrl value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of Private Endpoint Connections of this service.

Returns:

the privateEndpointConnections value.

privateIpAddresses

public List privateIpAddresses()

Get the privateIpAddresses property: 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.

Returns:

the privateIpAddresses value.

provisioningState

public String provisioningState()

Get the provisioningState property: 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.

Returns:

the provisioningState value.

publicIpAddressId

public String publicIpAddressId()

Get the publicIpAddressId property: 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.

Returns:

the publicIpAddressId value.

publicIpAddresses

public List publicIpAddresses()

Get the publicIpAddresses property: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

Returns:

the publicIpAddresses value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: 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'.

Returns:

the publicNetworkAccess value.

publisherEmail

public String publisherEmail()

Get the publisherEmail property: Publisher email.

Returns:

the publisherEmail value.

publisherName

public String publisherName()

Get the publisherName property: Publisher name.

Returns:

the publisherName value.

restore

public Boolean restore()

Get the restore property: 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.

Returns:

the restore value.

scmUrl

public String scmUrl()

Get the scmUrl property: SCM endpoint URL of the API Management service.

Returns:

the scmUrl value.

sku

public ApiManagementServiceSkuProperties sku()

Get the sku property: SKU properties of the API Management service.

Returns:

the sku value.

systemData

public SystemData systemData()

Get the systemData property: Metadata pertaining to creation and last modification of the resource.

Returns:

the systemData value.

targetProvisioningState

public String targetProvisioningState()

Get the targetProvisioningState property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.

Returns:

the targetProvisioningState value.

validate

public void validate()

Validates the instance.

Overrides:

ApiManagementServiceResourceInner.validate()

virtualNetworkConfiguration

public VirtualNetworkConfiguration virtualNetworkConfiguration()

Get the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.

Returns:

the virtualNetworkConfiguration value.

virtualNetworkType

public VirtualNetworkType virtualNetworkType()

Get the virtualNetworkType property: 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.

Returns:

the virtualNetworkType value.

withAdditionalLocations

public ApiManagementServiceResourceInner withAdditionalLocations(List additionalLocations)

Set the additionalLocations property: Additional datacenter locations of the API Management service.

Parameters:

additionalLocations - the additionalLocations value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withApiVersionConstraint

public ApiManagementServiceResourceInner withApiVersionConstraint(ApiVersionConstraint apiVersionConstraint)

Set the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.

Parameters:

apiVersionConstraint - the apiVersionConstraint value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withCertificates

public ApiManagementServiceResourceInner withCertificates(List certificates)

Set the certificates property: List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

Parameters:

certificates - the certificates value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withCustomProperties

public ApiManagementServiceResourceInner withCustomProperties(Map customProperties)

Set the customProperties property: Custom properties of the API Management service.
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).
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` can be used to disable just TLS 1.1.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` can be used to disable TLS 1.0 on an API Management service.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` can be used to disable just TLS 1.1 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` can be used to disable TLS 1.0 for communications with backends.
Setting `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` can be used to enable HTTP2 protocol on an API Management service.
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 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.

You can disable any of the following 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: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,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.

Parameters:

customProperties - the customProperties value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withDisableGateway

public ApiManagementServiceResourceInner withDisableGateway(Boolean disableGateway)

Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

Parameters:

disableGateway - the disableGateway value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withEnableClientCertificate

public ApiManagementServiceResourceInner withEnableClientCertificate(Boolean enableClientCertificate)

Set the enableClientCertificate property: 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.

Parameters:

enableClientCertificate - the enableClientCertificate value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withHostnameConfigurations

public ApiManagementServiceResourceInner withHostnameConfigurations(List hostnameConfigurations)

Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.

Parameters:

hostnameConfigurations - the hostnameConfigurations value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withIdentity

public ApiManagementServiceResourceInner withIdentity(ApiManagementServiceIdentity identity)

Set the identity property: Managed service identity of the Api Management service.

Parameters:

identity - the identity value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withLocation

public ApiManagementServiceResourceInner withLocation(String location)

Set the location property: Resource location.

Parameters:

location - the location value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withNatGatewayState

public ApiManagementServiceResourceInner withNatGatewayState(NatGatewayState natGatewayState)

Set the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.

Parameters:

natGatewayState - the natGatewayState value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withNotificationSenderEmail

public ApiManagementServiceResourceInner withNotificationSenderEmail(String notificationSenderEmail)

Set the notificationSenderEmail property: Email address from which the notification will be sent.

Parameters:

notificationSenderEmail - the notificationSenderEmail value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withPrivateEndpointConnections

public ApiManagementServiceResourceInner withPrivateEndpointConnections(List privateEndpointConnections)

Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.

Parameters:

privateEndpointConnections - the privateEndpointConnections value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withPublicIpAddressId

public ApiManagementServiceResourceInner withPublicIpAddressId(String publicIpAddressId)

Set the publicIpAddressId property: 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.

Parameters:

publicIpAddressId - the publicIpAddressId value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withPublicNetworkAccess

public ApiManagementServiceResourceInner withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: 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'.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withPublisherEmail

public ApiManagementServiceResourceInner withPublisherEmail(String publisherEmail)

Set the publisherEmail property: Publisher email.

Parameters:

publisherEmail - the publisherEmail value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withPublisherName

public ApiManagementServiceResourceInner withPublisherName(String publisherName)

Set the publisherName property: Publisher name.

Parameters:

publisherName - the publisherName value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withRestore

public ApiManagementServiceResourceInner withRestore(Boolean restore)

Set the restore property: 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.

Parameters:

restore - the restore value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withSku

public ApiManagementServiceResourceInner withSku(ApiManagementServiceSkuProperties sku)

Set the sku property: SKU properties of the API Management service.

Parameters:

sku - the sku value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withTags

public ApiManagementServiceResourceInner withTags(Map tags)

Set the tags property: Resource tags.

Overrides:

ApiManagementServiceResourceInner.withTags(Map<String,String> tags)

Parameters:

tags

withVirtualNetworkConfiguration

public ApiManagementServiceResourceInner withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)

Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.

Parameters:

virtualNetworkConfiguration - the virtualNetworkConfiguration value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withVirtualNetworkType

public ApiManagementServiceResourceInner withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set the virtualNetworkType property: 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.

Parameters:

virtualNetworkType - the virtualNetworkType value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

withZones

public ApiManagementServiceResourceInner withZones(List zones)

Set the zones property: A list of availability zones denoting where the resource needs to come from.

Parameters:

zones - the zones value to set.

Returns:

the ApiManagementServiceResourceInner object itself.

zones

public List zones()

Get the zones property: A list of availability zones denoting where the resource needs to come from.

Returns:

the zones value.