Skip to content

Commit

Permalink
Fix the help files (Azure#24402)
Browse files Browse the repository at this point in the history 
* Fix the help files

* Fix the help files

* Update the description of parameters
  • Loading branch information
@wyunchi-ms
wyunchi-ms authored Mar 18, 2024
1 parent 52e4d78 commit c618b57
Show file tree
Hide file tree
Showing 120 changed files with 5,864 additions and 8,644 deletions.
202 changes: 84 additions & 118 deletions src/ConnectedVMware/ConnectedVMware/help/Get-AzConnectedVMwareCluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,70 +14,116 @@ Implements cluster GET method.

### List (Default)
```
Get-AzConnectedVMwareCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Break]
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
Get-AzConnectedVMwareCluster [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Get
```
Get-AzConnectedVMwareCluster -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials] [<CommonParameters>]
[-DefaultProfile <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### List1
```
Get-AzConnectedVMwareCluster -ResourceGroupName <String> [-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>] [-Break] [-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>] [-ProxyCredential <PSCredential>]
[-ProxyUseDefaultCredentials] [<CommonParameters>]
[-DefaultProfile <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### GetViaIdentity
```
Get-AzConnectedVMwareCluster -InputObject <IConnectedVMwareIdentity> [-DefaultProfile <PSObject>] [-Break]
[-HttpPipelineAppend <SendAsyncStep[]>] [-HttpPipelinePrepend <SendAsyncStep[]>] [-Proxy <Uri>]
[-ProxyCredential <PSCredential>] [-ProxyUseDefaultCredentials] [<CommonParameters>]
Get-AzConnectedVMwareCluster -InputObject <IConnectedVMwareIdentity> [-DefaultProfile <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Implements cluster GET method.

## EXAMPLES

### EXAMPLE 1
```
### Example 1: List Clusters in current subscription
```powershell
Get-AzConnectedVMwareCluster -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"
```

### EXAMPLE 2
```output
Kind Location Name ResourceGroupName
---- -------- ---- -----------------
eastus test-cluster1 test-rg1
eastus test-cluster2 test-rg2
eastus test-cluster3 test-rg3
eastus test-cluster4 test-rg4
eastus test-cluster5 test-rg5
eastus test-cluster6 test-rg6
eastus test-cluster7 test-rg7
eastus test-cluster8 test-rg8
```

This command lists Clusters in current subscription.

### Example 2: List Clusters in a resource group
```powershell
Get-AzConnectedVMwareCluster -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"
```

### EXAMPLE 3
```
Get-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"
```output
Kind Location Name ResourceGroupName
---- -------- ---- -----------------
eastus test-cluster1 test-rg
eastus test-cluster2 test-rg
```

## PARAMETERS
This command lists Clusters in a resource group named `test-rg`.

### -Break
Wait for .NET debugger to attach
### Example 3: Get a specific Cluster
```powershell
Get-AzConnectedVMwareCluster -Name "test-cluster" -ResourceGroupName "test-rg" -SubscriptionId "204898ee-cd13-4332-b9d4-55ca5c25496d"
```

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
```output
CustomResourceName : dd163232-210f-4f82-8b0c-9866a2eac862
DatastoreId :
ExtendedLocationName : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourcegroups/test-rg/providers/microsoft.extendedlocation/customlocations/test-cl
ExtendedLocationType : CustomLocation
Id : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/clusters/test-cluster
InventoryItemId :
Kind :
Location : eastus2euap
MoName : Cluster-1
MoRefId : domain-c7
Name : test-cluster
NetworkId :
ProvisioningState : Succeeded
ResourceGroupName : test-rg
Statuses : {{
"type": "Ready",
"status": "True",
"lastUpdatedAt": "2021-08-25T09:48:12.9989085Z"
}, {
"type": "Idle",
"status": "True",
"lastUpdatedAt": "2021-08-25T09:48:12.9989085Z"
}}
SystemDataCreatedAt : 8/25/2021 9:38:06 AM
SystemDataCreatedBy : xyz
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 8/25/2021 9:48:13 AM
SystemDataLastModifiedBy : ac9dc5fe-b644-4832-9d03-d9f1ab70c5f7
SystemDataLastModifiedByType : Application
Tag : {
}
TotalCpuMHz :
TotalMemoryGb :
Type : microsoft.connectedvmwarevsphere/clusters
UsedCpuMHz :
UsedMemoryGb :
Uuid : dd163232-210f-4f82-8b0c-9866a2eac862
VCenterId : /subscriptions/204898ee-cd13-4332-b9d4-55ca5c25496d/resourceGroups/test-rg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/test-vc
```

This command gets a Cluster named `test-cluster` in a resource group named `test-rg`.

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
## PARAMETERS

### -DefaultProfile
The DefaultProfile parameter is not functional.
Expand All @@ -95,39 +141,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Runtime.SendAsyncStep[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity
Expand Down Expand Up @@ -156,13 +171,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Proxy
The URI for the proxy server to use
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: System.Uri
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases:
Aliases: proga

Required: False
Position: Named
Expand All @@ -171,36 +186,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProxyCredential
Credentials for a proxy server to use for the remote call
```yaml
Type: System.Management.Automation.PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProxyUseDefaultCredentials
Use the default credentials for the proxy
```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
### -ResourceGroupName
The Resource Group Name.
Expand All @@ -226,7 +211,7 @@ Aliases:

Required: False
Position: Named
Default value: None
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -237,30 +222,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## INPUTS
### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.IConnectedVMwareIdentity
## OUTPUTS
### Microsoft.Azure.PowerShell.Cmdlets.ConnectedVMware.Models.ICluster
## NOTES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties.
For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT \<IConnectedVMwareIdentity\>: Identity Parameter
\[ClusterName \<String\>\]: Name of the cluster.
\[DatastoreName \<String\>\]: Name of the datastore.
\[HostName \<String\>\]: Name of the host.
\[Id \<String\>\]: Resource identity path
\[InventoryItemName \<String\>\]: Name of the inventoryItem.
\[ResourceGroupName \<String\>\]: The Resource Group Name.
\[ResourcePoolName \<String\>\]: Name of the resourcePool.
\[ResourceUri \<String\>\]: The fully qualified Azure Resource manager identifier of the Hybrid Compute machine resource to be extended.
\[SubscriptionId \<String\>\]: The Subscription ID.
\[VcenterName \<String\>\]: Name of the vCenter.
\[VirtualMachineTemplateName \<String\>\]: Name of the virtual machine template resource.
\[VirtualNetworkName \<String\>\]: Name of the virtual network resource.
## RELATED LINKS
[https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarecluster](https://learn.microsoft.com/powershell/module/az.connectedvmware/get-azconnectedvmwarecluster)
Loading

0 comments on commit c618b57

Please sign in to comment.