Package com.azure.resourcemanager.apimanagement.models

Interface ApiManagementServiceResource

public interface ApiManagementServiceResource
An immutable client-side representation of ApiManagementServiceResource.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • sku

      ApiManagementServiceSkuProperties sku()
      Gets the sku property: SKU properties of the API Management service.
      Returns:
      the sku value.

    • identity

      ApiManagementServiceIdentity identity()
      Gets the identity property: Managed service identity of the Api Management service.
      Returns:
      the identity value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • location

      String location()
      Gets the location property: Resource location.
      Returns:
      the location value.

    • etag

      String etag()
      Gets the etag property: ETag of the resource.
      Returns:
      the etag value.

    • zones

      List<String> zones()
      Gets the zones property: A list of availability zones denoting where the resource needs to come from.
      Returns:
      the zones value.

    • publisherEmail

      String publisherEmail()
      Gets the publisherEmail property: Publisher email.
      Returns:
      the publisherEmail value.

    • publisherName

      String publisherName()
      Gets the publisherName property: Publisher name.
      Returns:
      the publisherName value.

    • notificationSenderEmail

      String notificationSenderEmail()
      Gets the notificationSenderEmail property: Email address from which the notification will be sent.
      Returns:
      the notificationSenderEmail value.

    • provisioningState

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

    • targetProvisioningState

      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:
      the targetProvisioningState value.

    • createdAtUtc

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

    • gatewayUrl

      String gatewayUrl()
      Gets the gatewayUrl property: Gateway URL of the API Management service.
      Returns:
      the gatewayUrl value.

    • gatewayRegionalUrl

      String gatewayRegionalUrl()
      Gets the gatewayRegionalUrl property: Gateway URL of the API Management service in the Default Region.
      Returns:
      the gatewayRegionalUrl value.

    • portalUrl

      String portalUrl()
      Gets the portalUrl property: Publisher portal endpoint Url of the API Management service.
      Returns:
      the portalUrl value.

    • managementApiUrl

      String managementApiUrl()
      Gets the managementApiUrl property: Management API endpoint URL of the API Management service.
      Returns:
      the managementApiUrl value.

    • scmUrl

      String scmUrl()
      Gets the scmUrl property: SCM endpoint URL of the API Management service.
      Returns:
      the scmUrl value.

    • developerPortalUrl

      String developerPortalUrl()
      Gets the developerPortalUrl property: DEveloper Portal endpoint URL of the API Management service.
      Returns:
      the developerPortalUrl value.

    • hostnameConfigurations

      List<HostnameConfiguration> hostnameConfigurations()
      Gets the hostnameConfigurations property: Custom hostname configuration of the API Management service.
      Returns:
      the hostnameConfigurations value.

    • publicIpAddresses

      List<String> publicIpAddresses()
      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:
      the publicIpAddresses value.

    • privateIpAddresses

      List<String> privateIpAddresses()
      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:
      the privateIpAddresses value.

    • publicIpAddressId

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

    • publicNetworkAccess

      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:
      the publicNetworkAccess value.

    • configurationApi

      ConfigurationApi configurationApi()
      Gets the configurationApi property: Configuration API configuration of the API Management service.
      Returns:
      the configurationApi value.

    • virtualNetworkConfiguration

      VirtualNetworkConfiguration virtualNetworkConfiguration()
      Gets the virtualNetworkConfiguration property: Virtual network configuration of the API Management service.
      Returns:
      the virtualNetworkConfiguration value.

    • additionalLocations

      List<AdditionalLocation> additionalLocations()
      Gets the additionalLocations property: Additional datacenter locations of the API Management service.
      Returns:
      the additionalLocations value.

    • customProperties

      Map<String,String> customProperties()
      Gets 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.

    • certificates

      List<CertificateConfiguration> certificates()
      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:
      the certificates value.

    • enableClientCertificate

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

    • natGatewayState

      NatGatewayState natGatewayState()
      Gets the natGatewayState property: Property can be used to enable NAT Gateway for this API Management service.
      Returns:
      the natGatewayState value.

    • outboundPublicIpAddresses

      List<String> outboundPublicIpAddresses()
      Gets 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

      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:
      the disableGateway value.

    • virtualNetworkType

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

    • apiVersionConstraint

      ApiVersionConstraint apiVersionConstraint()
      Gets the apiVersionConstraint property: Control Plane Apis version constraint for the API Management service.
      Returns:
      the apiVersionConstraint value.

    • restore

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

    • privateEndpointConnections

      List<RemotePrivateEndpointConnectionWrapper> privateEndpointConnections()
      Gets the privateEndpointConnections property: List of Private Endpoint Connections of this service.
      Returns:
      the privateEndpointConnections value.

    • platformVersion

      PlatformVersion platformVersion()
      Gets the platformVersion property: Compute Platform Version running the service in this location.
      Returns:
      the platformVersion value.

    • legacyPortalStatus

      LegacyPortalStatus legacyPortalStatus()
      Gets the legacyPortalStatus property: Status of legacy portal in the API Management service.
      Returns:
      the legacyPortalStatus value.

    • developerPortalStatus

      DeveloperPortalStatus developerPortalStatus()
      Gets the developerPortalStatus property: Status of developer portal in this API Management service.
      Returns:
      the developerPortalStatus value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      ApiManagementServiceResourceInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceResourceInner object.
      Returns:
      the inner object.

    • update

      ApiManagementServiceResource.Update update()
      Begins update for the ApiManagementServiceResource resource.
      Returns:
      the stage of resource update.

    • refresh

      ApiManagementServiceResource refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ApiManagementServiceResource refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • backup

      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:
      parameters - Parameters supplied to the ApiManagementService_Backup operation.
      Returns:
      a single API Management service resource in List or Get response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • backup

      ApiManagementServiceResource backup(ApiManagementServiceBackupRestoreParameters parameters, com.azure.core.util.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:
      parameters - Parameters supplied to the ApiManagementService_Backup operation.
      context - The context to associate with this operation.
      Returns:
      a single API Management service resource in List or Get response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • migrateToStv2

      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:
      a single API Management service resource in List or Get response.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • migrateToStv2

      ApiManagementServiceResource migrateToStv2(MigrateToStv2Contract parameters, com.azure.core.util.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:
      parameters - Optional parameters supplied to migrate service.
      context - The context to associate with this operation.
      Returns:
      a single API Management service resource in List or Get response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getSsoTokenWithResponse

      com.azure.core.http.rest.Response<ApiManagementServiceGetSsoTokenResult> getSsoTokenWithResponse(com.azure.core.util.Context context)
      Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the Single-Sign-On token for the API Management Service which is valid for 5 Minutes along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getSsoToken

      ApiManagementServiceGetSsoTokenResult getSsoToken()
      Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
      Returns:
      the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • applyNetworkConfigurationUpdates

      ApiManagementServiceResource applyNetworkConfigurationUpdates()
      Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
      Returns:
      a single API Management service resource in List or Get response.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • applyNetworkConfigurationUpdates

      ApiManagementServiceResource applyNetworkConfigurationUpdates(ApiManagementServiceApplyNetworkConfigurationParameters parameters, com.azure.core.util.Context context)
      Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
      Parameters:
      parameters - Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.
      context - The context to associate with this operation.
      Returns:
      a single API Management service resource in List or Get response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.