Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*/
package com.microsoft.azure.management.resources.fluentcore.arm.models;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.resources.ResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.Region;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
Base interface for resources in resource groups.
Type parameters: - <TManager> – the manager object type representing the service
- <InnerT> – the wrapped, inner, auto-generated implementation object type
/**
* Base interface for resources in resource groups.
* @param <TManager> the manager object type representing the service
* @param <InnerT> the wrapped, inner, auto-generated implementation object type
*/
@Fluent()
public interface GroupableResource<TManager, InnerT> extends
Resource,
HasResourceGroup,
HasManager<TManager>,
HasInner<InnerT> {
Grouping of all the definition stages.
/**
* Grouping of all the definition stages.
*/
interface DefinitionStages {
A resource definition allowing a resource group to be selected.
Region of the groupable resource will be used for new resource group
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing a resource group to be selected.
* <p>
* Region of the groupable resource will be used for new resource group
*
* @param <T> the next stage of the definition
*/
interface WithGroup<T> extends
WithExistingResourceGroup<T>,
WithNewResourceGroup<T> {
}
A resource definition allowing a resource group to be selected.
Region has to be specified explicitly to create a new resource group
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing a resource group to be selected.
* <p>
* Region has to be specified explicitly to create a new resource group
*
* @param <T> the next stage of the definition
*/
interface WithGroupAndRegion<T> extends
WithExistingResourceGroup<T>,
WithNewResourceGroupWithRegion<T> {
}
A resource definition allowing a new resource group to be created in the same
region as groupable resource.
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing a new resource group to be created in the same
* region as groupable resource.
*
* @param <T> the next stage of the definition
*/
interface WithNewResourceGroup<T> extends
WithCreatableResourceGroup<T> {
Creates a new resource group to put the resource in.
The group will be created in the same location as the resource.
Params: - name – the name of the new group
Returns: the next stage of the definition
/**
* Creates a new resource group to put the resource in.
* <p>
* The group will be created in the same location as the resource.
* @param name the name of the new group
* @return the next stage of the definition
*/
T withNewResourceGroup(String name);
Creates a new resource group to put the resource in.
The group will be created in the same location as the resource.
The group's name is automatically derived from the resource's name.
Returns: the next stage of the definition
/**
* Creates a new resource group to put the resource in.
* <p>
* The group will be created in the same location as the resource.
* The group's name is automatically derived from the resource's name.
* @return the next stage of the definition
*/
T withNewResourceGroup();
}
A resource definition allowing a new resource group to be created in a different
region .
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing a new resource group to be created in a different
* region .
*
* @param <T> the next stage of the definition
*/
interface WithNewResourceGroupWithRegion<T> extends
WithCreatableResourceGroup<T> {
Creates a new resource group to put the resource in.
The group will be created in the same location as the resource.
Params: - name – the name of the new group
- region – the region where resource group needs to be created
Returns: the next stage of the definition
/**
* Creates a new resource group to put the resource in.
* <p>
* The group will be created in the same location as the resource.
*
* @param name the name of the new group
* @param region the region where resource group needs to be created
* @return the next stage of the definition
*/
T withNewResourceGroup(String name, Region region);
Creates a new resource group to put the resource in.
The group will be created in the same location as the resource.
The group's name is automatically derived from the resource's name.
Params: - region – the region where resource group needs to be created
Returns: the next stage of the definition
/**
* Creates a new resource group to put the resource in.
* <p>
* The group will be created in the same location as the resource.
* The group's name is automatically derived from the resource's name.
*
* @param region the region where resource group needs to be created
* @return the next stage of the definition
*/
T withNewResourceGroup(Region region);
}
A resource definition allowing a new creatable resource group to be specified.
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing a new creatable resource group to be specified.
*
* @param <T> the next stage of the definition
*/
interface WithCreatableResourceGroup<T> {
Creates a new resource group to put the resource in, based on the definition specified.
Params: - groupDefinition – a creatable definition for a new resource group
Returns: the next stage of the definition
/**
* Creates a new resource group to put the resource in, based on the definition specified.
* @param groupDefinition a creatable definition for a new resource group
* @return the next stage of the definition
*/
T withNewResourceGroup(Creatable<ResourceGroup> groupDefinition);
}
A resource definition allowing an existing resource group to be selected.
Type parameters: - <T> – the next stage of the definition
/**
* A resource definition allowing an existing resource group to be selected.
*
* @param <T> the next stage of the definition
*/
interface WithExistingResourceGroup<T> {
Associates the resource with an existing resource group.
Params: - groupName – the name of an existing resource group to put this resource in.
Returns: the next stage of the definition
/**
* Associates the resource with an existing resource group.
* @param groupName the name of an existing resource group to put this resource in.
* @return the next stage of the definition
*/
T withExistingResourceGroup(String groupName);
Associates the resource with an existing resource group.
Params: - group – an existing resource group to put the resource in
Returns: the next stage of the definition
/**
* Associates the resource with an existing resource group.
* @param group an existing resource group to put the resource in
* @return the next stage of the definition
*/
T withExistingResourceGroup(ResourceGroup group);
}
}
}