通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ApiManagementServiceUpdateParameters Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

public class ApiManagementServiceUpdateParameters
extends ApimResource

Parameter supplied to Update Api Management Service.

Constructor Summary

Constructor Description
ApiManagementServiceUpdateParameters()

Method Summary

Modifier and Type Method and Description
java.util.List<AdditionalLocation> additionalLocations()

Get additional datacenter locations of the API Management service.
java.util.List<CertificateConfiguration> certificates()

Get list of Certificates that need to be installed in the API Management service.
org.joda.time.DateTime createdAtUtc()

Get 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.
java.util.Map<java.lang.String,java.lang.String> customProperties()

Get 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.
java.lang.Boolean enableClientCertificate()

Get property only meant to be used for Consumption SKU Service.
java.lang.String etag()

Get eTag of the resource.
java.lang.String gatewayRegionalUrl()

Get gateway URL of the API Management service in the Default Region.
java.lang.String gatewayUrl()

Get gateway URL of the API Management service.
java.util.List<HostnameConfiguration> hostnameConfigurations()

Get custom hostname configuration of the API Management service.
ApiManagementServiceIdentity identity()

Get managed service identity of the Api Management service.
java.lang.String managementApiUrl()

Get management API endpoint URL of the API Management service.
java.lang.String notificationSenderEmail()

Get email address from which the notification will be sent.
java.lang.String portalUrl()

Get publisher portal endpoint Url of the API Management service.
java.util.List<java.lang.String> privateIPAddresses()

Get private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network.
java.lang.String provisioningState()

Get 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.
java.util.List<java.lang.String> publicIPAddresses()

Get public Static Load Balanced IP addresses of the API Management service in Primary region.
java.lang.String publisherEmail()

Get publisher email.
java.lang.String publisherName()

Get publisher name.
java.lang.String scmUrl()

Get sCM endpoint URL of the API Management service.
ApiManagementServiceSkuProperties sku()

Get sKU properties of the API Management service.
java.lang.String targetProvisioningState()

Get the provisioning state of the API Management service, which is targeted by the long running operation started on the service.
VirtualNetworkConfiguration virtualNetworkConfiguration()

Get virtual network configuration of the API Management service.
VirtualNetworkType virtualNetworkType()

Get the type of VPN in which API Management service needs to be configured in.
ApiManagementServiceUpdateParameters withAdditionalLocations(List<AdditionalLocation> additionalLocations)

Set additional datacenter locations of the API Management service.
ApiManagementServiceUpdateParameters withCertificates(List<CertificateConfiguration> certificates)

Set list of Certificates that need to be installed in the API Management service.
ApiManagementServiceUpdateParameters withCustomProperties(Map<String,String> customProperties)

Set 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.
ApiManagementServiceUpdateParameters withEnableClientCertificate(Boolean enableClientCertificate)

Set property only meant to be used for Consumption SKU Service.
ApiManagementServiceUpdateParameters withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)

Set custom hostname configuration of the API Management service.
ApiManagementServiceUpdateParameters withIdentity(ApiManagementServiceIdentity identity)

Set managed service identity of the Api Management service.
ApiManagementServiceUpdateParameters withNotificationSenderEmail(String notificationSenderEmail)

Set email address from which the notification will be sent.
ApiManagementServiceUpdateParameters withPublisherEmail(String publisherEmail)

Set publisher email.
ApiManagementServiceUpdateParameters withPublisherName(String publisherName)

Set publisher name.
ApiManagementServiceUpdateParameters withSku(ApiManagementServiceSkuProperties sku)

Set sKU properties of the API Management service.
ApiManagementServiceUpdateParameters withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)

Set virtual network configuration of the API Management service.
ApiManagementServiceUpdateParameters withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set the type of VPN in which API Management service needs to be configured in.

Methods inherited from com.microsoft.azure.ProxyResource

com.microsoft.azure.ProxyResource.id com.microsoft.azure.ProxyResource.name com.microsoft.azure.ProxyResource.type

Methods inherited from ApimResource

tags withTags

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ApiManagementServiceUpdateParameters

public ApiManagementServiceUpdateParameters()

Method Details

additionalLocations

public List<AdditionalLocation> additionalLocations()

Get additional datacenter locations of the API Management service.

Returns:

the additionalLocations value

certificates

public List<CertificateConfiguration> certificates()

Get 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 DateTime createdAtUtc()

Get 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<String,String> customProperties()

Get 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 1st 2018 and `False` otherwise. Http2 setting's default value is `False`.

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.

Returns:

the customProperties value

enableClientCertificate

public Boolean enableClientCertificate()

Get 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 eTag of the resource.

Returns:

the etag value

gatewayRegionalUrl

public String gatewayRegionalUrl()

Get gateway URL of the API Management service in the Default Region.

Returns:

the gatewayRegionalUrl value

gatewayUrl

public String gatewayUrl()

Get gateway URL of the API Management service.

Returns:

the gatewayUrl value

hostnameConfigurations

public List<HostnameConfiguration> hostnameConfigurations()

Get custom hostname configuration of the API Management service.

Returns:

the hostnameConfigurations value

identity

public ApiManagementServiceIdentity identity()

Get managed service identity of the Api Management service.

Returns:

the identity value

managementApiUrl

public String managementApiUrl()

Get management API endpoint URL of the API Management service.

Returns:

the managementApiUrl value

notificationSenderEmail

public String notificationSenderEmail()

Get email address from which the notification will be sent.

Returns:

the notificationSenderEmail value

portalUrl

public String portalUrl()

Get publisher portal endpoint Url of the API Management service.

Returns:

the portalUrl value

privateIPAddresses

public List<String> privateIPAddresses()

Get 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 and Premium SKU.

Returns:

the privateIPAddresses value

provisioningState

public String provisioningState()

Get 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

publicIPAddresses

public List<String> publicIPAddresses()

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

Returns:

the publicIPAddresses value

publisherEmail

public String publisherEmail()

Get publisher email.

Returns:

the publisherEmail value

publisherName

public String publisherName()

Get publisher name.

Returns:

the publisherName value

scmUrl

public String scmUrl()

Get sCM endpoint URL of the API Management service.

Returns:

the scmUrl value

sku

public ApiManagementServiceSkuProperties sku()

Get sKU properties of the API Management service.

Returns:

the sku value

targetProvisioningState

public String targetProvisioningState()

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

Returns:

the targetProvisioningState value

virtualNetworkConfiguration

public VirtualNetworkConfiguration virtualNetworkConfiguration()

Get virtual network configuration of the API Management service.

Returns:

the virtualNetworkConfiguration value

virtualNetworkType

public VirtualNetworkType virtualNetworkType()

Get 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'.

Returns:

the virtualNetworkType value

withAdditionalLocations

public ApiManagementServiceUpdateParameters withAdditionalLocations(List<AdditionalLocation> additionalLocations)

Set additional datacenter locations of the API Management service.

Parameters:

additionalLocations - the additionalLocations value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withCertificates

public ApiManagementServiceUpdateParameters withCertificates(List<CertificateConfiguration> certificates)

Set 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.

withCustomProperties

public ApiManagementServiceUpdateParameters withCustomProperties(Map<String,String> customProperties)

Set 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 1st 2018 and `False` otherwise. Http2 setting's default value is `False`.

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.

Parameters:

customProperties - the customProperties value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withEnableClientCertificate

public ApiManagementServiceUpdateParameters withEnableClientCertificate(Boolean enableClientCertificate)

Set 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.

withHostnameConfigurations

public ApiManagementServiceUpdateParameters withHostnameConfigurations(List<HostnameConfiguration> hostnameConfigurations)

Set custom hostname configuration of the API Management service.

Parameters:

hostnameConfigurations - the hostnameConfigurations value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withIdentity

public ApiManagementServiceUpdateParameters withIdentity(ApiManagementServiceIdentity identity)

Set managed service identity of the Api Management service.

Parameters:

identity - the identity value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withNotificationSenderEmail

public ApiManagementServiceUpdateParameters withNotificationSenderEmail(String notificationSenderEmail)

Set email address from which the notification will be sent.

Parameters:

notificationSenderEmail - the notificationSenderEmail value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withPublisherEmail

public ApiManagementServiceUpdateParameters withPublisherEmail(String publisherEmail)

Set publisher email.

Parameters:

publisherEmail - the publisherEmail value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withPublisherName

public ApiManagementServiceUpdateParameters withPublisherName(String publisherName)

Set publisher name.

Parameters:

publisherName - the publisherName value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withSku

public ApiManagementServiceUpdateParameters withSku(ApiManagementServiceSkuProperties sku)

Set sKU properties of the API Management service.

Parameters:

sku - the sku value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withVirtualNetworkConfiguration

public ApiManagementServiceUpdateParameters withVirtualNetworkConfiguration(VirtualNetworkConfiguration virtualNetworkConfiguration)

Set virtual network configuration of the API Management service.

Parameters:

virtualNetworkConfiguration - the virtualNetworkConfiguration value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

withVirtualNetworkType

public ApiManagementServiceUpdateParameters withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set 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'.

Parameters:

virtualNetworkType - the virtualNetworkType value to set

Returns:

the ApiManagementServiceUpdateParameters object itself.

Applies to