azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.f...

365 строки
23 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor"
name: "FrontDoor"
nameWithType: "FrontDoor"
summary: "An immutable client-side representation of Front<wbr>Door."
syntax: "public interface **FrontDoor**"
methods:
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.backendPools()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.backendPools()"
name: "backendPools()"
nameWithType: "FrontDoor.backendPools()"
summary: "Gets the backend<wbr>Pools property: Backend pools available to routing rules."
modifiers:
- "abstract"
syntax: "public abstract List<BackendPool> backendPools()"
desc: "Gets the backendPools property: Backend pools available to routing rules."
returns:
description: "the backendPools value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.BackendPool?alt=com.azure.resourcemanager.frontdoor.models.BackendPool&text=BackendPool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.backendPoolsSettings()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.backendPoolsSettings()"
name: "backendPoolsSettings()"
nameWithType: "FrontDoor.backendPoolsSettings()"
summary: "Gets the backend<wbr>Pools<wbr>Settings property: Settings for all backend<wbr>Pools."
modifiers:
- "abstract"
syntax: "public abstract BackendPoolsSettings backendPoolsSettings()"
desc: "Gets the backendPoolsSettings property: Settings for all backendPools."
returns:
description: "the backendPoolsSettings value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.BackendPoolsSettings?alt=com.azure.resourcemanager.frontdoor.models.BackendPoolsSettings&text=BackendPoolsSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.cname()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.cname()"
name: "cname()"
nameWithType: "FrontDoor.cname()"
summary: "Gets the cname property: The host that each frontend<wbr>Endpoint must CNAME to."
modifiers:
- "abstract"
syntax: "public abstract String cname()"
desc: "Gets the cname property: The host that each frontendEndpoint must CNAME to."
returns:
description: "the cname value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.enabledState()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.enabledState()"
name: "enabledState()"
nameWithType: "FrontDoor.enabledState()"
summary: "Gets the enabled<wbr>State property: Operational status of the Front Door load balancer."
modifiers:
- "abstract"
syntax: "public abstract FrontDoorEnabledState enabledState()"
desc: "Gets the enabledState property: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'."
returns:
description: "the enabledState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorEnabledState?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorEnabledState&text=FrontDoorEnabledState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.extendedProperties()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.extendedProperties()"
name: "extendedProperties()"
nameWithType: "FrontDoor.extendedProperties()"
summary: "Gets the extended<wbr>Properties property: Key-Value pair representing additional properties for frontdoor."
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> extendedProperties()"
desc: "Gets the extendedProperties property: Key-Value pair representing additional properties for frontdoor."
returns:
description: "the extendedProperties value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.friendlyName()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.friendlyName()"
name: "friendlyName()"
nameWithType: "FrontDoor.friendlyName()"
summary: "Gets the friendly<wbr>Name property: A friendly name for the front<wbr>Door."
modifiers:
- "abstract"
syntax: "public abstract String friendlyName()"
desc: "Gets the friendlyName property: A friendly name for the frontDoor."
returns:
description: "the friendlyName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.frontdoorId()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.frontdoorId()"
name: "frontdoorId()"
nameWithType: "FrontDoor.frontdoorId()"
summary: "Gets the frontdoor<wbr>Id property: The Id of the frontdoor."
modifiers:
- "abstract"
syntax: "public abstract String frontdoorId()"
desc: "Gets the frontdoorId property: The Id of the frontdoor."
returns:
description: "the frontdoorId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.frontendEndpoints()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.frontendEndpoints()"
name: "frontendEndpoints()"
nameWithType: "FrontDoor.frontendEndpoints()"
summary: "Gets the frontend<wbr>Endpoints property: Frontend endpoints available to routing rules."
modifiers:
- "abstract"
syntax: "public abstract List<FrontendEndpoint> frontendEndpoints()"
desc: "Gets the frontendEndpoints property: Frontend endpoints available to routing rules."
returns:
description: "the frontendEndpoints value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontendEndpoint?alt=com.azure.resourcemanager.frontdoor.models.FrontendEndpoint&text=FrontendEndpoint\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.healthProbeSettings()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.healthProbeSettings()"
name: "healthProbeSettings()"
nameWithType: "FrontDoor.healthProbeSettings()"
summary: "Gets the health<wbr>Probe<wbr>Settings property: Health probe settings associated with this Front Door instance."
modifiers:
- "abstract"
syntax: "public abstract List<HealthProbeSettingsModel> healthProbeSettings()"
desc: "Gets the healthProbeSettings property: Health probe settings associated with this Front Door instance."
returns:
description: "the healthProbeSettings value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.HealthProbeSettingsModel&text=HealthProbeSettingsModel\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.id()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.id()"
name: "id()"
nameWithType: "FrontDoor.id()"
summary: "Gets the id property: Fully qualified resource Id for the resource."
modifiers:
- "abstract"
syntax: "public abstract String id()"
desc: "Gets the id property: Fully qualified resource Id for the resource."
returns:
description: "the id value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.innerModel()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.innerModel()"
name: "innerModel()"
nameWithType: "FrontDoor.innerModel()"
summary: "Gets the inner com.<wbr>azure.<wbr>resourcemanager.<wbr>frontdoor.<wbr>fluent.<wbr>models.<wbr>Front<wbr>Door<wbr>Inner object."
modifiers:
- "abstract"
syntax: "public abstract FrontDoorInner innerModel()"
desc: "Gets the inner com.azure.resourcemanager.frontdoor.fluent.models.FrontDoorInner object."
returns:
description: "the inner object."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.fluent.models.FrontDoorInner?alt=com.azure.resourcemanager.frontdoor.fluent.models.FrontDoorInner&text=FrontDoorInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.loadBalancingSettings()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.loadBalancingSettings()"
name: "loadBalancingSettings()"
nameWithType: "FrontDoor.loadBalancingSettings()"
summary: "Gets the load<wbr>Balancing<wbr>Settings property: Load balancing settings associated with this Front Door instance."
modifiers:
- "abstract"
syntax: "public abstract List<LoadBalancingSettingsModel> loadBalancingSettings()"
desc: "Gets the loadBalancingSettings property: Load balancing settings associated with this Front Door instance."
returns:
description: "the loadBalancingSettings value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.LoadBalancingSettingsModel?alt=com.azure.resourcemanager.frontdoor.models.LoadBalancingSettingsModel&text=LoadBalancingSettingsModel\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.location()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.location()"
name: "location()"
nameWithType: "FrontDoor.location()"
summary: "Gets the location property: The geo-location where the resource lives."
modifiers:
- "abstract"
syntax: "public abstract String location()"
desc: "Gets the location property: The geo-location where the resource lives."
returns:
description: "the location value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.name()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.name()"
name: "name()"
nameWithType: "FrontDoor.name()"
summary: "Gets the name property: The name of the resource."
modifiers:
- "abstract"
syntax: "public abstract String name()"
desc: "Gets the name property: The name of the resource."
returns:
description: "the name value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.provisioningState()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.provisioningState()"
name: "provisioningState()"
nameWithType: "FrontDoor.provisioningState()"
summary: "Gets the provisioning<wbr>State property: Provisioning state of the Front Door."
modifiers:
- "abstract"
syntax: "public abstract String provisioningState()"
desc: "Gets the provisioningState property: Provisioning state of the Front Door."
returns:
description: "the provisioningState value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.refresh()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.refresh()"
name: "refresh()"
nameWithType: "FrontDoor.refresh()"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
syntax: "public abstract FrontDoor refresh()"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.refresh(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.refresh(Context context)"
name: "refresh(Context context)"
nameWithType: "FrontDoor.refresh(Context context)"
summary: "Refreshes the resource to sync with Azure."
modifiers:
- "abstract"
parameters:
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FrontDoor refresh(Context context)"
desc: "Refreshes the resource to sync with Azure."
returns:
description: "the refreshed resource."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.region()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.region()"
name: "region()"
nameWithType: "FrontDoor.region()"
summary: "Gets the region of the resource."
modifiers:
- "abstract"
syntax: "public abstract Region region()"
desc: "Gets the region of the resource."
returns:
description: "the region of the resource."
type: "<xref href=\"com.azure.core.management.Region?alt=com.azure.core.management.Region&text=Region\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.regionName()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.regionName()"
name: "regionName()"
nameWithType: "FrontDoor.regionName()"
summary: "Gets the name of the resource region."
modifiers:
- "abstract"
syntax: "public abstract String regionName()"
desc: "Gets the name of the resource region."
returns:
description: "the name of the resource region."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.resourceGroupName()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.resourceGroupName()"
name: "resourceGroupName()"
nameWithType: "FrontDoor.resourceGroupName()"
summary: "Gets the name of the resource group."
modifiers:
- "abstract"
syntax: "public abstract String resourceGroupName()"
desc: "Gets the name of the resource group."
returns:
description: "the name of the resource group."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.resourceState()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.resourceState()"
name: "resourceState()"
nameWithType: "FrontDoor.resourceState()"
summary: "Gets the resource<wbr>State property: Resource status of the Front Door or Front Door Sub<wbr>Resource."
modifiers:
- "abstract"
syntax: "public abstract FrontDoorResourceState resourceState()"
desc: "Gets the resourceState property: Resource status of the Front Door or Front Door SubResource. Resource status of the Front Door."
returns:
description: "the resourceState value."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoorResourceState?alt=com.azure.resourcemanager.frontdoor.models.FrontDoorResourceState&text=FrontDoorResourceState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.routingRules()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.routingRules()"
name: "routingRules()"
nameWithType: "FrontDoor.routingRules()"
summary: "Gets the routing<wbr>Rules property: Routing rules associated with this Front Door."
modifiers:
- "abstract"
syntax: "public abstract List<RoutingRule> routingRules()"
desc: "Gets the routingRules property: Routing rules associated with this Front Door."
returns:
description: "the routingRules value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.RoutingRule?alt=com.azure.resourcemanager.frontdoor.models.RoutingRule&text=RoutingRule\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.rulesEngines()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.rulesEngines()"
name: "rulesEngines()"
nameWithType: "FrontDoor.rulesEngines()"
summary: "Gets the rules<wbr>Engines property: Rules Engine Configurations available to routing rules."
modifiers:
- "abstract"
syntax: "public abstract List<RulesEngine> rulesEngines()"
desc: "Gets the rulesEngines property: Rules Engine Configurations available to routing rules."
returns:
description: "the rulesEngines value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.RulesEngine?alt=com.azure.resourcemanager.frontdoor.models.RulesEngine&text=RulesEngine\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.tags()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.tags()"
name: "tags()"
nameWithType: "FrontDoor.tags()"
summary: "Gets the tags property: Resource tags."
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> tags()"
desc: "Gets the tags property: Resource tags."
returns:
description: "the tags value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.type()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.type()"
name: "type()"
nameWithType: "FrontDoor.type()"
summary: "Gets the type property: The type of the resource."
modifiers:
- "abstract"
syntax: "public abstract String type()"
desc: "Gets the type property: The type of the resource."
returns:
description: "the type value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.update()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.update()"
name: "update()"
nameWithType: "FrontDoor.update()"
summary: "Begins update for the Front<wbr>Door resource."
modifiers:
- "abstract"
syntax: "public abstract FrontDoor.Update update()"
desc: "Begins update for the FrontDoor resource."
returns:
description: "the stage of resource update."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor.Update?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor.Update&text=Update\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.validateCustomDomain(com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.validateCustomDomain(ValidateCustomDomainInput customDomainProperties)"
name: "validateCustomDomain(ValidateCustomDomainInput customDomainProperties)"
nameWithType: "FrontDoor.validateCustomDomain(ValidateCustomDomainInput customDomainProperties)"
summary: "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS."
modifiers:
- "abstract"
parameters:
- description: "Custom domain to be validated."
name: "customDomainProperties"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput?alt=com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput&text=ValidateCustomDomainInput\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ValidateCustomDomainOutput validateCustomDomain(ValidateCustomDomainInput customDomainProperties)"
desc: "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS."
returns:
description: "output of custom domain validation."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainOutput?alt=com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainOutput&text=ValidateCustomDomainOutput\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoor.validateCustomDomainWithResponse(com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoor.validateCustomDomainWithResponse(ValidateCustomDomainInput customDomainProperties, Context context)"
name: "validateCustomDomainWithResponse(ValidateCustomDomainInput customDomainProperties, Context context)"
nameWithType: "FrontDoor.validateCustomDomainWithResponse(ValidateCustomDomainInput customDomainProperties, Context context)"
summary: "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS."
modifiers:
- "abstract"
parameters:
- description: "Custom domain to be validated."
name: "customDomainProperties"
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput?alt=com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput&text=ValidateCustomDomainInput\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Response<ValidateCustomDomainOutput> validateCustomDomainWithResponse(ValidateCustomDomainInput customDomainProperties, Context context)"
desc: "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS."
returns:
description: "output of custom domain validation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainOutput?alt=com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainOutput&text=ValidateCustomDomainOutput\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "An immutable client-side representation of FrontDoor."
metadata: {}
package: "com.azure.resourcemanager.frontdoor.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0