ArcSettings interface
Interface representing a ArcSettings.
Methods
Method Details
beginCreateIdentity(string, string, string, ArcSettingsCreateIdentityOptionalParams)
Create Aad identity for arc settings.
function beginCreateIdentity(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsCreateIdentityOptionalParams): Promise<PollerLike<PollOperationState<ArcIdentityResponse>, ArcIdentityResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<ArcIdentityResponse>, ArcIdentityResponse>>
beginCreateIdentityAndWait(string, string, string, ArcSettingsCreateIdentityOptionalParams)
Create Aad identity for arc settings.
function beginCreateIdentityAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsCreateIdentityOptionalParams): Promise<ArcIdentityResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
The options parameters.
Returns
Promise<ArcIdentityResponse>
beginDelete(string, string, string, ArcSettingsDeleteOptionalParams)
Delete ArcSetting resource details of HCI Cluster.
function beginDelete(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
- options
- ArcSettingsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, ArcSettingsDeleteOptionalParams)
Delete ArcSetting resource details of HCI Cluster.
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
- options
- ArcSettingsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
create(string, string, string, ArcSetting, ArcSettingsCreateOptionalParams)
Create ArcSetting for HCI cluster.
function create(resourceGroupName: string, clusterName: string, arcSettingName: string, arcSetting: ArcSetting, options?: ArcSettingsCreateOptionalParams): Promise<ArcSetting>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
- arcSetting
- ArcSetting
Parameters supplied to the Create ArcSetting resource for this HCI cluster.
- options
- ArcSettingsCreateOptionalParams
The options parameters.
Returns
Promise<ArcSetting>
generatePassword(string, string, string, ArcSettingsGeneratePasswordOptionalParams)
Generate password for arc settings.
function generatePassword(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsGeneratePasswordOptionalParams): Promise<PasswordCredential>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
The options parameters.
Returns
Promise<PasswordCredential>
get(string, string, string, ArcSettingsGetOptionalParams)
Get ArcSetting resource details of HCI Cluster.
function get(resourceGroupName: string, clusterName: string, arcSettingName: string, options?: ArcSettingsGetOptionalParams): Promise<ArcSetting>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
- options
- ArcSettingsGetOptionalParams
The options parameters.
Returns
Promise<ArcSetting>
listByCluster(string, string, ArcSettingsListByClusterOptionalParams)
Get ArcSetting resources of HCI Cluster.
function listByCluster(resourceGroupName: string, clusterName: string, options?: ArcSettingsListByClusterOptionalParams): PagedAsyncIterableIterator<ArcSetting, ArcSetting[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
The options parameters.
Returns
update(string, string, string, ArcSettingsPatch, ArcSettingsUpdateOptionalParams)
Update ArcSettings for HCI cluster.
function update(resourceGroupName: string, clusterName: string, arcSettingName: string, arcSetting: ArcSettingsPatch, options?: ArcSettingsUpdateOptionalParams): Promise<ArcSetting>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- clusterName
-
string
The name of the cluster.
- arcSettingName
-
string
The name of the proxy resource holding details of HCI ArcSetting information.
- arcSetting
- ArcSettingsPatch
ArcSettings parameters that needs to be updated
- options
- ArcSettingsUpdateOptionalParams
The options parameters.
Returns
Promise<ArcSetting>