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

280 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors"
name: "FrontDoors"
nameWithType: "FrontDoors"
summary: "Resource collection API of Front<wbr>Doors."
syntax: "public interface **FrontDoors**"
methods:
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.define(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.define(String name)"
name: "define(String name)"
nameWithType: "FrontDoors.define(String name)"
summary: "Begins definition for a new Front<wbr>Door resource."
modifiers:
- "abstract"
parameters:
- description: "resource name."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FrontDoor.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new FrontDoor resource."
returns:
description: "the first stage of the new FrontDoor definition."
type: "<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor.DefinitionStages.Blank?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.delete(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.delete(String resourceGroupName, String frontDoorName, Context context)"
name: "delete(String resourceGroupName, String frontDoorName, Context context)"
nameWithType: "FrontDoors.delete(String resourceGroupName, String frontDoorName, Context context)"
summary: "Deletes an existing Front Door with the specified parameters."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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 void delete(String resourceGroupName, String frontDoorName, Context context)"
desc: "Deletes an existing Front Door with the specified parameters."
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "FrontDoors.deleteById(String id)"
summary: "Deletes an existing Front Door with the specified parameters."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteById(String id)"
desc: "Deletes an existing Front Door with the specified parameters."
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "FrontDoors.deleteByIdWithResponse(String id, Context context)"
summary: "Deletes an existing Front Door with the specified parameters."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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 void deleteByIdWithResponse(String id, Context context)"
desc: "Deletes an existing Front Door with the specified parameters."
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.deleteByResourceGroup(String resourceGroupName, String frontDoorName)"
name: "deleteByResourceGroup(String resourceGroupName, String frontDoorName)"
nameWithType: "FrontDoors.deleteByResourceGroup(String resourceGroupName, String frontDoorName)"
summary: "Deletes an existing Front Door with the specified parameters."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteByResourceGroup(String resourceGroupName, String frontDoorName)"
desc: "Deletes an existing Front Door with the specified parameters."
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getById(String id)"
name: "getById(String id)"
nameWithType: "FrontDoors.getById(String id)"
summary: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FrontDoor getById(String id)"
desc: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
returns:
description: "a Front Door with the specified Front Door name under the specified subscription and resource group along\n 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.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.FrontDoors.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "FrontDoors.getByIdWithResponse(String id, Context context)"
summary: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
modifiers:
- "abstract"
parameters:
- description: "the resource ID."
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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<FrontDoor> getByIdWithResponse(String id, Context context)"
desc: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
returns:
description: "a Front Door with the specified Front Door name under the specified subscription and resource group along\n 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.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getByResourceGroup(String resourceGroupName, String frontDoorName)"
name: "getByResourceGroup(String resourceGroupName, String frontDoorName)"
nameWithType: "FrontDoors.getByResourceGroup(String resourceGroupName, String frontDoorName)"
summary: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FrontDoor getByResourceGroup(String resourceGroupName, String frontDoorName)"
desc: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
returns:
description: "a Front Door with the specified Front Door name under the specified subscription and resource group."
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.FrontDoors.getByResourceGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, Context context)"
name: "getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, Context context)"
nameWithType: "FrontDoors.getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, Context context)"
summary: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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<FrontDoor> getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, Context context)"
desc: "Gets a Front Door with the specified Front Door name under the specified subscription and resource group."
returns:
description: "a Front Door with the specified Front Door name under the specified subscription and resource group along\n 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.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.list()"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.list()"
name: "list()"
nameWithType: "FrontDoors.list()"
summary: "Lists all of the Front Doors within an Azure subscription."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<FrontDoor> list()"
desc: "Lists all of the Front Doors within an Azure subscription."
returns:
description: "result of the request to list Front Doors as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.list(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.list(Context context)"
name: "list(Context context)"
nameWithType: "FrontDoors.list(Context context)"
summary: "Lists all of the Front Doors within an Azure subscription."
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 PagedIterable<FrontDoor> list(Context context)"
desc: "Lists all of the Front Doors within an Azure subscription."
returns:
description: "result of the request to list Front Doors as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.listByResourceGroup(java.lang.String)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.listByResourceGroup(String resourceGroupName)"
name: "listByResourceGroup(String resourceGroupName)"
nameWithType: "FrontDoors.listByResourceGroup(String resourceGroupName)"
summary: "Lists all of the Front Doors within a resource group under a subscription."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<FrontDoor> listByResourceGroup(String resourceGroupName)"
desc: "Lists all of the Front Doors within a resource group under a subscription."
returns:
description: "result of the request to list Front Doors as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.listByResourceGroup(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.listByResourceGroup(String resourceGroupName, Context context)"
name: "listByResourceGroup(String resourceGroupName, Context context)"
nameWithType: "FrontDoors.listByResourceGroup(String resourceGroupName, Context context)"
summary: "Lists all of the Front Doors within a resource group under a subscription."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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 PagedIterable<FrontDoor> listByResourceGroup(String resourceGroupName, Context context)"
desc: "Lists all of the Front Doors within a resource group under a subscription."
returns:
description: "result of the request to list Front Doors as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.frontdoor.models.FrontDoor?alt=com.azure.resourcemanager.frontdoor.models.FrontDoor&text=FrontDoor\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.frontdoor.models.FrontDoors.validateCustomDomain(java.lang.String,java.lang.String,com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.validateCustomDomain(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties)"
name: "validateCustomDomain(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties)"
nameWithType: "FrontDoors.validateCustomDomain(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties)"
summary: "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS."
modifiers:
- "abstract"
parameters:
- description: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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(String resourceGroupName, String frontDoorName, 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.FrontDoors.validateCustomDomainWithResponse(java.lang.String,java.lang.String,com.azure.resourcemanager.frontdoor.models.ValidateCustomDomainInput,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.frontdoor.models.FrontDoors.validateCustomDomainWithResponse(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties, Context context)"
name: "validateCustomDomainWithResponse(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties, Context context)"
nameWithType: "FrontDoors.validateCustomDomainWithResponse(String resourceGroupName, String frontDoorName, 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: "Name of the Resource group within the Azure subscription."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Name of the Front Door which is globally unique."
name: "frontDoorName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- 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(String resourceGroupName, String frontDoorName, 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: "Resource collection API of FrontDoors."
metadata: {}
package: "com.azure.resourcemanager.frontdoor.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-frontdoor:1.0.0