Class ApiManagementServiceUpdateProperties
- java.lang.Object
-
- com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBaseProperties
-
- com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceUpdateProperties
-
public final class ApiManagementServiceUpdateProperties extends ApiManagementServiceBaseProperties
Properties of an API Management service resource description.
-
-
Constructor Summary
Constructors Constructor Description ApiManagementServiceUpdateProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
publisherEmail()
Get the publisherEmail property: Publisher email.String
publisherName()
Get the publisherName property: Publisher name.void
validate()
Validates the instance.ApiManagementServiceUpdateProperties
withAdditionalLocations(List<AdditionalLocation> additionalLocations)
Set the additionalLocations property: Additional datacenter locations of the API Management service.ApiManagementServiceUpdateProperties
withApiVersionConstraint(ApiVersionConstraint apiVersionConstraint)
Set the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.ApiManagementServiceUpdateProperties
withCertificates(List<CertificateConfiguration> certificates)
Set the certificates property: List of Certificates that need to be installed in the API Management service.ApiManagementServiceUpdateProperties
withCustomProperties(Map<String,String> customProperties)
Set the customProperties property: 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.ApiManagementServiceUpdateProperties
withDisableGateway(Boolean disableGateway)
Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations.ApiManagementServiceUpdateProperties
withEnableClientCertificate(Boolean enableClientCertificate)
Set the enableClientCertificate property: Property only meant to be used for Consumption SKU Service.ApiManagementServiceUpdateProperties
withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)
Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.ApiManagementServiceUpdateProperties
withNotificationSenderEmail(String notificationSenderEmail)
Set the notificationSenderEmail property: Email address from which the notification will be sent.ApiManagementServiceUpdateProperties
withPrivateEndpointConnections(List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections)
Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.ApiManagementServiceUpdateProperties
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.ApiManagementServiceUpdateProperties
withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service.ApiManagementServiceUpdateProperties
withPublisherEmail(String publisherEmail)
Set the publisherEmail property: Publisher email.ApiManagementServiceUpdateProperties
withPublisherName(String publisherName)
Set the publisherName property: Publisher name.ApiManagementServiceUpdateProperties
withRestore(Boolean restore)
Set the restore property: Undelete Api Management Service if it was previously soft-deleted.ApiManagementServiceUpdateProperties
withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)
Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.ApiManagementServiceUpdateProperties
withVirtualNetworkType(VirtualNetworkType virtualNetworkType)
Set the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in.-
Methods inherited from class com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBaseProperties
additionalLocations, apiVersionConstraint, certificates, createdAtUtc, customProperties, developerPortalUrl, disableGateway, enableClientCertificate, gatewayRegionalUrl, gatewayUrl, hostnameConfigurations, managementApiUrl, notificationSenderEmail, platformVersion, portalUrl, privateEndpointConnections, privateIpAddresses, provisioningState, publicIpAddresses, publicIpAddressId, publicNetworkAccess, restore, scmUrl, targetProvisioningState, virtualNetworkConfiguration, virtualNetworkType
-
-
-
-
Method Detail
-
publisherEmail
public String publisherEmail()
Get the publisherEmail property: Publisher email.- Returns:
- the publisherEmail value.
-
withPublisherEmail
public ApiManagementServiceUpdateProperties withPublisherEmail(String publisherEmail)
Set the publisherEmail property: Publisher email.- Parameters:
publisherEmail
- the publisherEmail value to set.- Returns:
- the ApiManagementServiceUpdateProperties object itself.
-
publisherName
public String publisherName()
Get the publisherName property: Publisher name.- Returns:
- the publisherName value.
-
withPublisherName
public ApiManagementServiceUpdateProperties withPublisherName(String publisherName)
Set the publisherName property: Publisher name.- Parameters:
publisherName
- the publisherName value to set.- Returns:
- the ApiManagementServiceUpdateProperties object itself.
-
withNotificationSenderEmail
public ApiManagementServiceUpdateProperties withNotificationSenderEmail(String notificationSenderEmail)
Set the notificationSenderEmail property: Email address from which the notification will be sent.- Overrides:
withNotificationSenderEmail
in classApiManagementServiceBaseProperties
- Parameters:
notificationSenderEmail
- the notificationSenderEmail value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withHostnameConfigurations
public ApiManagementServiceUpdateProperties withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)
Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.- Overrides:
withHostnameConfigurations
in classApiManagementServiceBaseProperties
- Parameters:
hostnameConfigurations
- the hostnameConfigurations value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withPublicIpAddressId
public ApiManagementServiceUpdateProperties 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.- Overrides:
withPublicIpAddressId
in classApiManagementServiceBaseProperties
- Parameters:
publicIpAddressId
- the publicIpAddressId value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withPublicNetworkAccess
public ApiManagementServiceUpdateProperties 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'.- Overrides:
withPublicNetworkAccess
in classApiManagementServiceBaseProperties
- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withVirtualNetworkConfiguration
public ApiManagementServiceUpdateProperties withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)
Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.- Overrides:
withVirtualNetworkConfiguration
in classApiManagementServiceBaseProperties
- Parameters:
virtualNetworkConfiguration
- the virtualNetworkConfiguration value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withAdditionalLocations
public ApiManagementServiceUpdateProperties withAdditionalLocations(List<AdditionalLocation> additionalLocations)
Set the additionalLocations property: Additional datacenter locations of the API Management service.- Overrides:
withAdditionalLocations
in classApiManagementServiceBaseProperties
- Parameters:
additionalLocations
- the additionalLocations value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withCustomProperties
public ApiManagementServiceUpdateProperties withCustomProperties(Map<String,String> customProperties)
Set the customProperties property: 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.- Overrides:
withCustomProperties
in classApiManagementServiceBaseProperties
- Parameters:
customProperties
- the customProperties value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withCertificates
public ApiManagementServiceUpdateProperties withCertificates(List<CertificateConfiguration> 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.- Overrides:
withCertificates
in classApiManagementServiceBaseProperties
- Parameters:
certificates
- the certificates value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withEnableClientCertificate
public ApiManagementServiceUpdateProperties 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.- Overrides:
withEnableClientCertificate
in classApiManagementServiceBaseProperties
- Parameters:
enableClientCertificate
- the enableClientCertificate value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withDisableGateway
public ApiManagementServiceUpdateProperties 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.- Overrides:
withDisableGateway
in classApiManagementServiceBaseProperties
- Parameters:
disableGateway
- the disableGateway value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withVirtualNetworkType
public ApiManagementServiceUpdateProperties 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.- Overrides:
withVirtualNetworkType
in classApiManagementServiceBaseProperties
- Parameters:
virtualNetworkType
- the virtualNetworkType value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withApiVersionConstraint
public ApiManagementServiceUpdateProperties withApiVersionConstraint(ApiVersionConstraint apiVersionConstraint)
Set the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.- Overrides:
withApiVersionConstraint
in classApiManagementServiceBaseProperties
- Parameters:
apiVersionConstraint
- the apiVersionConstraint value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withRestore
public ApiManagementServiceUpdateProperties 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.- Overrides:
withRestore
in classApiManagementServiceBaseProperties
- Parameters:
restore
- the restore value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
withPrivateEndpointConnections
public ApiManagementServiceUpdateProperties withPrivateEndpointConnections(List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections)
Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.- Overrides:
withPrivateEndpointConnections
in classApiManagementServiceBaseProperties
- Parameters:
privateEndpointConnections
- the privateEndpointConnections value to set.- Returns:
- the ApiManagementServiceBaseProperties object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classApiManagementServiceBaseProperties
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-