Package com.azure.resourcemanager.azurestackhci.models

Interface ArcSettings

public interface ArcSettings

Resource collection API of ArcSettings.

Method Summary

Modifier and Type	Method	Description
ArcIdentityResponse	createIdentity(String resourceGroupName, String clusterName, String arcSettingName)	Create Aad identity for arc settings.
ArcIdentityResponse	createIdentity(String resourceGroupName, String clusterName, String arcSettingName, com.azure.core.util.Context context)	Create Aad identity for arc settings.
ArcSetting.DefinitionStages.Blank	define(String name)	Begins definition for a new ArcSetting resource.
void	delete(String resourceGroupName, String clusterName, String arcSettingName)	Delete ArcSetting resource details of HCI Cluster.
void	delete(String resourceGroupName, String clusterName, String arcSettingName, com.azure.core.util.Context context)	Delete ArcSetting resource details of HCI Cluster.
void	deleteById(String id)	Delete ArcSetting resource details of HCI Cluster.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete ArcSetting resource details of HCI Cluster.
PasswordCredential	generatePassword(String resourceGroupName, String clusterName, String arcSettingName)	Generate password for arc settings.
com.azure.core.http.rest.Response<PasswordCredential>	generatePasswordWithResponse(String resourceGroupName, String clusterName, String arcSettingName, com.azure.core.util.Context context)	Generate password for arc settings.
ArcSetting	get(String resourceGroupName, String clusterName, String arcSettingName)	Get ArcSetting resource details of HCI Cluster.
ArcSetting	getById(String id)	Get ArcSetting resource details of HCI Cluster.
com.azure.core.http.rest.Response<ArcSetting>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get ArcSetting resource details of HCI Cluster.
com.azure.core.http.rest.Response<ArcSetting>	getWithResponse(String resourceGroupName, String clusterName, String arcSettingName, com.azure.core.util.Context context)	Get ArcSetting resource details of HCI Cluster.
com.azure.core.http.rest.PagedIterable<ArcSetting>	listByCluster(String resourceGroupName, String clusterName)	Get ArcSetting resources of HCI Cluster.
com.azure.core.http.rest.PagedIterable<ArcSetting>	listByCluster(String resourceGroupName, String clusterName, com.azure.core.util.Context context)	Get ArcSetting resources of HCI Cluster.

Method Detail

listByCluster

com.azure.core.http.rest.PagedIterable<ArcSetting> listByCluster(String resourceGroupName,
                                                                 String clusterName)

Get ArcSetting resources of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

Returns:

arcSetting resources of HCI Cluster as paginated response with PagedIterable.

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.

listByCluster

com.azure.core.http.rest.PagedIterable<ArcSetting> listByCluster(String resourceGroupName,
                                                                 String clusterName,
                                                                 com.azure.core.util.Context context)

Get ArcSetting resources of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

context - The context to associate with this operation.

Returns:

arcSetting resources of HCI Cluster as paginated response with PagedIterable.

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.

get

ArcSetting get(String resourceGroupName,
               String clusterName,
               String arcSettingName)

Get ArcSetting resource details of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

Returns:

arcSetting resource details of HCI Cluster.

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.

getWithResponse

com.azure.core.http.rest.Response<ArcSetting> getWithResponse(String resourceGroupName,
                                                              String clusterName,
                                                              String arcSettingName,
                                                              com.azure.core.util.Context context)

Get ArcSetting resource details of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

context - The context to associate with this operation.

Returns:

arcSetting resource details of HCI Cluster 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.

delete

void delete(String resourceGroupName,
            String clusterName,
            String arcSettingName)

Delete ArcSetting resource details of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

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.

delete

void delete(String resourceGroupName,
            String clusterName,
            String arcSettingName,
            com.azure.core.util.Context context)

Delete ArcSetting resource details of HCI Cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

context - The context to associate with this operation.

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.

generatePassword

PasswordCredential generatePassword(String resourceGroupName,
                                    String clusterName,
                                    String arcSettingName)

Generate password for arc settings.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

Returns:

the 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.

generatePasswordWithResponse

com.azure.core.http.rest.Response<PasswordCredential> generatePasswordWithResponse(String resourceGroupName,
                                                                                   String clusterName,
                                                                                   String arcSettingName,
                                                                                   com.azure.core.util.Context context)

Generate password for arc settings.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

context - The context to associate with this operation.

Returns:

the response body 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.

createIdentity

ArcIdentityResponse createIdentity(String resourceGroupName,
                                   String clusterName,
                                   String arcSettingName)

Create Aad identity for arc settings.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

Returns:

arcIdentity details.

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.

createIdentity

ArcIdentityResponse createIdentity(String resourceGroupName,
                                   String clusterName,
                                   String arcSettingName,
                                   com.azure.core.util.Context context)

Create Aad identity for arc settings.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

clusterName - The name of the cluster.

arcSettingName - The name of the proxy resource holding details of HCI ArcSetting information.

context - The context to associate with this operation.

Returns:

arcIdentity details.

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.

getById

ArcSetting getById(String id)

Get ArcSetting resource details of HCI Cluster.

Parameters:

id - the resource ID.

Returns:

arcSetting resource details of HCI Cluster 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.

getByIdWithResponse

com.azure.core.http.rest.Response<ArcSetting> getByIdWithResponse(String id,
                                                                  com.azure.core.util.Context context)

Get ArcSetting resource details of HCI Cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

arcSetting resource details of HCI Cluster 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.

deleteById

void deleteById(String id)

Delete ArcSetting resource details of HCI Cluster.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete ArcSetting resource details of HCI Cluster.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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.

define

ArcSetting.DefinitionStages.Blank define(String name)

Begins definition for a new ArcSetting resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ArcSetting definition.