Class ApiManagementServiceUpdateParameters
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.models.ApimResource
com.azure.resourcemanager.apimanagement.models.ApiManagementServiceUpdateParameters
- All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
Parameter supplied to Update Api Management Service.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of ApiManagementServiceUpdateParameters class. -
Method Summary
Modifier and TypeMethodDescriptionGet the additionalLocations property: Additional datacenter locations of the API Management service.Get the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.Get the certificates property: List of Certificates that need to be installed in the API Management service.Get the configurationApi property: Configuration API configuration of the API Management service.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.Get 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.Get the developerPortalStatus property: Status of developer portal in this API Management service.Get the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.Get the disableGateway property: Property only valid for an Api Management service deployed in multiple locations.Get the enableClientCertificate property: Property only meant to be used for Consumption SKU Service.etag()Get the etag property: ETag of the resource.fromJson(com.azure.json.JsonReader jsonReader) Reads an instance of ApiManagementServiceUpdateParameters from the JsonReader.Get the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.Get the gatewayUrl property: Gateway URL of the API Management service.Get the hostnameConfigurations property: Custom hostname configuration of the API Management service.id()Get the id property: Fully qualified resource Id for the resource.identity()Get the identity property: Managed service identity of the Api Management service.Get the legacyPortalStatus property: Status of legacy portal in the API Management service.Get the managementApiUrl property: Management API endpoint URL of the API Management service.name()Get the name property: The name of the resource.Get the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.Get the notificationSenderEmail property: Email address from which the notification will be sent.Get the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service.Get the platformVersion property: Compute Platform Version running the service in this location.Get the portalUrl property: Publisher portal endpoint Url of the API Management service.Get the privateEndpointConnections property: List of Private Endpoint Connections of this service.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.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.Get the publicIpAddresses property: Public Static Load Balanced IP addresses of the API Management service in Primary region.Get the publicIpAddressId property: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region.Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service.Get the publisherEmail property: Publisher email.Get the publisherName property: Publisher name.restore()Get the restore property: Undelete Api Management Service if it was previously soft-deleted.scmUrl()Get the scmUrl property: SCM endpoint URL of the API Management service.sku()Get the sku property: SKU properties of the API Management service.Get the targetProvisioningState property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) type()Get the type property: The type of the resource.voidvalidate()Validates the instance.Get the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.Get the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in.withAdditionalLocations(List<AdditionalLocation> additionalLocations) Set the additionalLocations property: Additional datacenter locations of the API Management service.withApiVersionConstraint(ApiVersionConstraint apiVersionConstraint) Set the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.withCertificates(List<CertificateConfiguration> certificates) Set the certificates property: List of Certificates that need to be installed in the API Management service.withConfigurationApi(ConfigurationApi configurationApi) Set the configurationApi property: Configuration API configuration of the API Management service.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.withDeveloperPortalStatus(DeveloperPortalStatus developerPortalStatus) Set the developerPortalStatus property: Status of developer portal in this API Management service.withDisableGateway(Boolean disableGateway) Set the disableGateway property: Property only valid for an Api Management service deployed in multiple locations.withEnableClientCertificate(Boolean enableClientCertificate) Set the enableClientCertificate property: Property only meant to be used for Consumption SKU Service.withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations) Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.withIdentity(ApiManagementServiceIdentity identity) Set the identity property: Managed service identity of the Api Management service.withLegacyPortalStatus(LegacyPortalStatus legacyPortalStatus) Set the legacyPortalStatus property: Status of legacy portal in the API Management service.withNatGatewayState(NatGatewayState natGatewayState) Set the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.withNotificationSenderEmail(String notificationSenderEmail) Set the notificationSenderEmail property: Email address from which the notification will be sent.withPrivateEndpointConnections(List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections) Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.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.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this API Management service.withPublisherEmail(String publisherEmail) Set the publisherEmail property: Publisher email.withPublisherName(String publisherName) Set the publisherName property: Publisher name.withRestore(Boolean restore) Set the restore property: Undelete Api Management Service if it was previously soft-deleted.Set the sku property: SKU properties of the API Management service.Set the tags property: Resource tags.withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration) Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.withVirtualNetworkType(VirtualNetworkType virtualNetworkType) Set the virtualNetworkType property: The type of VPN in which API Management service needs to be configured in.Set the zones property: A list of availability zones denoting where the resource needs to come from.zones()Get the zones property: A list of availability zones denoting where the resource needs to come from.Methods inherited from class com.azure.resourcemanager.apimanagement.models.ApimResource
tagsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
ApiManagementServiceUpdateParameters
public ApiManagementServiceUpdateParameters()Creates an instance of ApiManagementServiceUpdateParameters class.
-
-
Method Details
-
sku
Get the sku property: SKU properties of the API Management service.- Returns:
- the sku value.
-
withSku
Set the sku property: SKU properties of the API Management service.- Parameters:
sku- the sku value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
identity
Get the identity property: Managed service identity of the Api Management service.- Returns:
- the identity value.
-
withIdentity
Set the identity property: Managed service identity of the Api Management service.- Parameters:
identity- the identity value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
etag
Get the etag property: ETag of the resource.- Returns:
- the etag value.
-
zones
Get the zones property: A list of availability zones denoting where the resource needs to come from.- Returns:
- the zones value.
-
withZones
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 ApiManagementServiceUpdateParameters object itself.
-
type
Get the type property: The type of the resource.- Overrides:
typein classApimResource- Returns:
- the type value.
-
name
Get the name property: The name of the resource.- Overrides:
namein classApimResource- Returns:
- the name value.
-
id
Get the id property: Fully qualified resource Id for the resource.- Overrides:
idin classApimResource- Returns:
- the id value.
-
withTags
Set the tags property: Resource tags.- Overrides:
withTagsin classApimResource- Parameters:
tags- the tags value to set.- Returns:
- the ApimResource object itself.
-
publisherEmail
Get the publisherEmail property: Publisher email.- Returns:
- the publisherEmail value.
-
withPublisherEmail
Set the publisherEmail property: Publisher email.- Parameters:
publisherEmail- the publisherEmail value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
publisherName
Get the publisherName property: Publisher name.- Returns:
- the publisherName value.
-
withPublisherName
Set the publisherName property: Publisher name.- Parameters:
publisherName- the publisherName value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
notificationSenderEmail
Get the notificationSenderEmail property: Email address from which the notification will be sent.- Returns:
- the notificationSenderEmail value.
-
withNotificationSenderEmail
public ApiManagementServiceUpdateParameters 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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
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.
-
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.
-
gatewayUrl
Get the gatewayUrl property: Gateway URL of the API Management service.- Returns:
- the gatewayUrl value.
-
gatewayRegionalUrl
Get the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.- Returns:
- the gatewayRegionalUrl value.
-
portalUrl
Get the portalUrl property: Publisher portal endpoint Url of the API Management service.- Returns:
- the portalUrl value.
-
managementApiUrl
Get the managementApiUrl property: Management API endpoint URL of the API Management service.- Returns:
- the managementApiUrl value.
-
scmUrl
Get the scmUrl property: SCM endpoint URL of the API Management service.- Returns:
- the scmUrl value.
-
developerPortalUrl
Get the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.- Returns:
- the developerPortalUrl value.
-
hostnameConfigurations
Get the hostnameConfigurations property: Custom hostname configuration of the API Management service.- Returns:
- the hostnameConfigurations value.
-
withHostnameConfigurations
public ApiManagementServiceUpdateParameters withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations) Set the hostnameConfigurations property: Custom hostname configuration of the API Management service.- Parameters:
hostnameConfigurations- the hostnameConfigurations value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
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.
-
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.
-
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.
-
withPublicIpAddressId
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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
withPublicNetworkAccess
public ApiManagementServiceUpdateParameters 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 ApiManagementServiceUpdateParameters object itself.
-
configurationApi
Get the configurationApi property: Configuration API configuration of the API Management service.- Returns:
- the configurationApi value.
-
withConfigurationApi
Set the configurationApi property: Configuration API configuration of the API Management service.- Parameters:
configurationApi- the configurationApi value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
virtualNetworkConfiguration
Get the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.- Returns:
- the virtualNetworkConfiguration value.
-
withVirtualNetworkConfiguration
public ApiManagementServiceUpdateParameters withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration) Set the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.- Parameters:
virtualNetworkConfiguration- the virtualNetworkConfiguration value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
additionalLocations
Get the additionalLocations property: Additional datacenter locations of the API Management service.- Returns:
- the additionalLocations value.
-
withAdditionalLocations
public ApiManagementServiceUpdateParameters withAdditionalLocations(List<AdditionalLocation> additionalLocations) Set the additionalLocations property: Additional datacenter locations of the API Management service.- Parameters:
additionalLocations- the additionalLocations value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
customProperties
Get 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 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.</br></br>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.</br> 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.
-
withCustomProperties
public ApiManagementServiceUpdateParameters 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 1, 2018 and `False` otherwise. Http2 setting's default value is `False`.</br></br>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.</br> 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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
withCertificates
public ApiManagementServiceUpdateParameters 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.- Parameters:
certificates- the certificates value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
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.
-
withEnableClientCertificate
public ApiManagementServiceUpdateParameters 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 ApiManagementServiceUpdateParameters object itself.
-
natGatewayState
Get the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.- Returns:
- the natGatewayState value.
-
withNatGatewayState
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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
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.
-
withDisableGateway
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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
withVirtualNetworkType
public ApiManagementServiceUpdateParameters 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 ApiManagementServiceUpdateParameters object itself.
-
apiVersionConstraint
Get the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.- Returns:
- the apiVersionConstraint value.
-
withApiVersionConstraint
public ApiManagementServiceUpdateParameters 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 ApiManagementServiceUpdateParameters object itself.
-
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.
-
withRestore
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 ApiManagementServiceUpdateParameters object itself.
-
privateEndpointConnections
Get the privateEndpointConnections property: List of Private Endpoint Connections of this service.- Returns:
- the privateEndpointConnections value.
-
withPrivateEndpointConnections
public ApiManagementServiceUpdateParameters withPrivateEndpointConnections(List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections) Set the privateEndpointConnections property: List of Private Endpoint Connections of this service.- Parameters:
privateEndpointConnections- the privateEndpointConnections value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
platformVersion
Get the platformVersion property: Compute Platform Version running the service in this location.- Returns:
- the platformVersion value.
-
legacyPortalStatus
Get the legacyPortalStatus property: Status of legacy portal in the API Management service.- Returns:
- the legacyPortalStatus value.
-
withLegacyPortalStatus
public ApiManagementServiceUpdateParameters withLegacyPortalStatus(LegacyPortalStatus legacyPortalStatus) Set the legacyPortalStatus property: Status of legacy portal in the API Management service.- Parameters:
legacyPortalStatus- the legacyPortalStatus value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
developerPortalStatus
Get the developerPortalStatus property: Status of developer portal in this API Management service.- Returns:
- the developerPortalStatus value.
-
withDeveloperPortalStatus
public ApiManagementServiceUpdateParameters withDeveloperPortalStatus(DeveloperPortalStatus developerPortalStatus) Set the developerPortalStatus property: Status of developer portal in this API Management service.- Parameters:
developerPortalStatus- the developerPortalStatus value to set.- Returns:
- the ApiManagementServiceUpdateParameters object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validatein classApimResource- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>- Overrides:
toJsonin classApimResource- Throws:
IOException
-
fromJson
public static ApiManagementServiceUpdateParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of ApiManagementServiceUpdateParameters from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of ApiManagementServiceUpdateParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException- If the deserialized JSON object was missing any required properties.IOException- If an error occurs while reading the ApiManagementServiceUpdateParameters.
-