ApiManagementServiceResource Interface
public interface ApiManagementServiceResource
An immutable client-side representation of ApiManagementServiceResource.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abstract
List<Additional |
additionalLocations()
Gets the additional |
|
abstract
Api |
apiVersionConstraint()
Gets the api |
|
abstract
Api |
applyNetworkConfigurationUpdates()
Updates the Microsoft. |
|
abstract
Api |
applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)
Updates the Microsoft. |
|
abstract
Api |
backup(ApiManagementServiceBackupRestoreParameters parameters)
Creates a backup of the API Management service to the given Azure Storage Account. |
|
abstract
Api |
backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)
Creates a backup of the API Management service to the given Azure Storage Account. |
|
abstract
List<Certificate |
certificates()
Gets the certificates property: List of Certificates that need to be installed in the API Management service. |
|
abstract
Offset |
createdAtUtc()
Gets the created |
| abstract Map<String,String> |
customProperties()
Gets the custom |
| abstract String |
developerPortalUrl()
Gets the developer |
| abstract Boolean |
disableGateway()
Gets the disable |
| abstract Boolean |
enableClientCertificate()
Gets the enable |
| abstract String |
etag()
Gets the etag property: ETag of the resource. |
| abstract String |
gatewayRegionalUrl()
Gets the gateway |
| abstract String |
gatewayUrl()
Gets the gateway |
|
abstract
Api |
getSsoToken()
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. |
|
abstract
Response<Api |
getSsoTokenWithResponse(Context context)
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes. |
|
abstract
List<Hostname |
hostnameConfigurations()
Gets the hostname |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Api |
identity()
Gets the identity property: Managed service identity of the Api Management service. |
|
abstract
Api |
innerModel()
Gets the inner com. |
| abstract String |
location()
Gets the location property: Resource location. |
| abstract String |
managementApiUrl()
Gets the management |
|
abstract
Api |
migrateToStv2()
Upgrades an API Management service to the Stv2 platform. |
|
abstract
Api |
migrateToStv2(Context context)
Upgrades an API Management service to the Stv2 platform. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Nat |
natGatewayState()
Gets the nat |
| abstract String |
notificationSenderEmail()
Gets the notification |
| abstract List<String> |
outboundPublicIpAddresses()
Gets the outbound |
|
abstract
Platform |
platformVersion()
Gets the platform |
| abstract String |
portalUrl()
Gets the portal |
|
abstract
List<Remote |
privateEndpointConnections()
Gets the private |
| abstract List<String> |
privateIpAddresses()
Gets the private |
| abstract String |
provisioningState()
Gets the provisioning |
| abstract String |
publicIpAddressId()
Gets the public |
| abstract List<String> |
publicIpAddresses()
Gets the public |
|
abstract
Public |
publicNetworkAccess()
Gets the public |
| abstract String |
publisherEmail()
Gets the publisher |
| abstract String |
publisherName()
Gets the publisher |
|
abstract
Api |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Api |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract Boolean |
restore()
Gets the restore property: Undelete Api Management Service if it was previously soft-deleted. |
| abstract String |
scmUrl()
Gets the scm |
|
abstract
Api |
sku()
Gets the sku property: SKU properties of the API Management service. |
|
abstract
System |
systemData()
Gets the system |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
| abstract String |
targetProvisioningState()
Gets the target |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Api |
|
abstract
Virtual |
virtualNetworkConfiguration()
Gets the virtual |
|
abstract
Virtual |
virtualNetworkType()
Gets the virtual |
| abstract List<String> |
zones()
Gets the zones property: A list of availability zones denoting where the resource needs to come from. |
Method Details
additionalLocations
public abstract List
Gets the additionalLocations property: Additional datacenter locations of the API Management service.
Returns:
apiVersionConstraint
public abstract ApiVersionConstraint apiVersionConstraint()
Gets the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.
Returns:
applyNetworkConfigurationUpdates
public abstract ApiManagementServiceResource applyNetworkConfigurationUpdates()
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
Returns:
applyNetworkConfigurationUpdates
public abstract ApiManagementServiceResource applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, Context context)
Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
Parameters:
Returns:
backup
public abstract ApiManagementServiceResource backup(ApiManagementServiceBackupRestoreParameters parameters)
Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
Parameters:
Returns:
backup
public abstract ApiManagementServiceResource backup(ApiManagementServiceBackupRestoreParameters parameters, Context context)
Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
Parameters:
Returns:
certificates
public abstract List
Gets 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:
createdAtUtc
public abstract OffsetDateTime createdAtUtc()
Gets 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:
customProperties
public abstract Map
Gets 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:
developerPortalUrl
public abstract String developerPortalUrl()
Gets the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.
Returns:
disableGateway
public abstract Boolean disableGateway()
Gets 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:
enableClientCertificate
public abstract Boolean enableClientCertificate()
Gets 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:
etag
public abstract String etag()
Gets the etag property: ETag of the resource.
Returns:
gatewayRegionalUrl
public abstract String gatewayRegionalUrl()
Gets the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.
Returns:
gatewayUrl
public abstract String gatewayUrl()
Gets the gatewayUrl property: Gateway URL of the API Management service.
Returns:
getSsoToken
public abstract ApiManagementServiceGetSsoTokenResult getSsoToken()
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
Returns:
getSsoTokenWithResponse
public abstract Response
Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
Parameters:
Returns:
hostnameConfigurations
public abstract List
Gets the hostnameConfigurations property: Custom hostname configuration of the API Management service.
Returns:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
identity
public abstract ApiManagementServiceIdentity identity()
Gets the identity property: Managed service identity of the Api Management service.
Returns:
innerModel
public abstract ApiManagementServiceResourceInner innerModel()
Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner object.
Returns:
location
public abstract String location()
Gets the location property: Resource location.
Returns:
managementApiUrl
public abstract String managementApiUrl()
Gets the managementApiUrl property: Management API endpoint URL of the API Management service.
Returns:
migrateToStv2
public abstract ApiManagementServiceResource migrateToStv2()
Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.
Returns:
migrateToStv2
public abstract ApiManagementServiceResource migrateToStv2(Context context)
Upgrades an API Management service to the Stv2 platform. For details refer to https://aka.ms/apim-migrate-stv2. This change is not reversible. This is long running operation and could take several minutes to complete.
Parameters:
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
natGatewayState
public abstract NatGatewayState natGatewayState()
Gets the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
Returns:
notificationSenderEmail
public abstract String notificationSenderEmail()
Gets the notificationSenderEmail property: Email address from which the notification will be sent.
Returns:
outboundPublicIpAddresses
public abstract List
Gets the outboundPublicIpAddresses property: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
Returns:
platformVersion
public abstract PlatformVersion platformVersion()
Gets the platformVersion property: Compute Platform Version running the service in this location.
Returns:
portalUrl
public abstract String portalUrl()
Gets the portalUrl property: Publisher portal endpoint Url of the API Management service.
Returns:
privateEndpointConnections
public abstract List
Gets the privateEndpointConnections property: List of Private Endpoint Connections of this service.
Returns:
privateIpAddresses
public abstract List
Gets 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:
provisioningState
public abstract String provisioningState()
Gets 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:
publicIpAddressId
public abstract String publicIpAddressId()
Gets 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:
publicIpAddresses
public abstract List
Gets 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:
publicNetworkAccess
public abstract PublicNetworkAccess publicNetworkAccess()
Gets 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:
publisherEmail
public abstract String publisherEmail()
Gets the publisherEmail property: Publisher email.
Returns:
publisherName
public abstract String publisherName()
Gets the publisherName property: Publisher name.
Returns:
refresh
public abstract ApiManagementServiceResource refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract ApiManagementServiceResource refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
restore
public abstract Boolean restore()
Gets 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:
scmUrl
public abstract String scmUrl()
Gets the scmUrl property: SCM endpoint URL of the API Management service.
Returns:
sku
public abstract ApiManagementServiceSkuProperties sku()
Gets the sku property: SKU properties of the API Management service.
Returns:
systemData
public abstract SystemData systemData()
Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
Returns:
tags
public abstract Map
Gets the tags property: Resource tags.
Returns:
targetProvisioningState
public abstract String targetProvisioningState()
Gets the targetProvisioningState property: The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract ApiManagementServiceResource.Update update()
Begins update for the ApiManagementServiceResource resource.
Returns:
virtualNetworkConfiguration
public abstract VirtualNetworkConfiguration virtualNetworkConfiguration()
Gets the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.
Returns:
virtualNetworkType
public abstract VirtualNetworkType virtualNetworkType()
Gets 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:
zones
public abstract List
Gets the zones property: A list of availability zones denoting where the resource needs to come from.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for