Interface ApiManagementGatewayResource
public interface ApiManagementGatewayResource
An immutable client-side representation of ApiManagementGatewayResource.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the ApiManagementGatewayResource definition.static interfaceThe ApiManagementGatewayResource definition stages.static interfaceThe template for ApiManagementGatewayResource update.static interfaceThe ApiManagementGatewayResource update stages. -
Method Summary
Modifier and TypeMethodDescriptionbackend()Gets the backend property: Information regarding how the gateway should integrate with backend systems.Gets the configurationApi property: Information regarding the Configuration API of the API Management gateway.Gets the createdAtUtc property: Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.etag()Gets the etag property: ETag of the resource.frontend()Gets the frontend property: Information regarding how the gateway should be exposed.id()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementGatewayResourceInner object.location()Gets the location property: Resource location.name()Gets the name property: The name of the resource.Gets the provisioningState property: The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Regionregion()Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.sku()Gets the sku property: SKU properties of the API Management gateway.com.azure.core.management.SystemDataGets the systemData property: Metadata pertaining to creation and last modification of the resource.tags()Gets the tags property: Resource tags.Gets the targetProvisioningState property: The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.type()Gets the type property: The type of the resource.update()Begins update for the ApiManagementGatewayResource resource.Gets the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.
-
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
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
sku
Gets the sku property: SKU properties of the API Management gateway.- Returns:
- the sku 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.
-
provisioningState
String provisioningState()Gets the provisioningState property: The current provisioning state of the API Management gateway 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 gateway, which is targeted by the long running operation started on the gateway.- Returns:
- the targetProvisioningState value.
-
createdAtUtc
OffsetDateTime createdAtUtc()Gets the createdAtUtc property: Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.- Returns:
- the createdAtUtc value.
-
frontend
FrontendConfiguration frontend()Gets the frontend property: Information regarding how the gateway should be exposed.- Returns:
- the frontend value.
-
backend
BackendConfiguration backend()Gets the backend property: Information regarding how the gateway should integrate with backend systems.- Returns:
- the backend value.
-
configurationApi
GatewayConfigurationApi configurationApi()Gets the configurationApi property: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.- Returns:
- the configurationApi value.
-
virtualNetworkType
VirtualNetworkType virtualNetworkType()Gets the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.- Returns:
- the virtualNetworkType 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
ApiManagementGatewayResourceInner innerModel()Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementGatewayResourceInner object.- Returns:
- the inner object.
-
update
ApiManagementGatewayResource.Update update()Begins update for the ApiManagementGatewayResource resource.- Returns:
- the stage of resource update.
-
refresh
ApiManagementGatewayResource refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-