|
| 1 | +--- |
| 2 | +external help file: Az.ADDomainServices-help.xml |
| 3 | +Module Name: Az.ADDomainServices |
| 4 | +online version: https://learn.microsoft.com/powershell/module/az.addomainservices/get-azaddomainservice |
| 5 | +schema: 2.0.0 |
| 6 | +content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/ADDomainServices/help/Get-AzADDomainService.md |
| 7 | +original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/ADDomainServices/help/Get-AzADDomainService.md |
| 8 | +--- |
| 9 | + |
| 10 | +# Get-AzADDomainService |
| 11 | + |
| 12 | +## SYNOPSIS |
| 13 | +The Get Domain Service operation retrieves a json representation of the Domain Service. |
| 14 | + |
| 15 | +## SYNTAX |
| 16 | + |
| 17 | +### List (Default) |
| 18 | +``` |
| 19 | +Get-AzADDomainService [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] |
| 20 | + [<CommonParameters>] |
| 21 | +``` |
| 22 | + |
| 23 | +### Get |
| 24 | +``` |
| 25 | +Get-AzADDomainService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] |
| 26 | + [-DefaultProfile <PSObject>] [<CommonParameters>] |
| 27 | +``` |
| 28 | + |
| 29 | +### List1 |
| 30 | +``` |
| 31 | +Get-AzADDomainService -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] |
| 32 | + [<CommonParameters>] |
| 33 | +``` |
| 34 | + |
| 35 | +### GetViaIdentity |
| 36 | +``` |
| 37 | +Get-AzADDomainService -InputObject <IAdDomainServicesIdentity> [-DefaultProfile <PSObject>] |
| 38 | + [<CommonParameters>] |
| 39 | +``` |
| 40 | + |
| 41 | +## DESCRIPTION |
| 42 | +The Get Domain Service operation retrieves a json representation of the Domain Service. |
| 43 | + |
| 44 | +## EXAMPLES |
| 45 | + |
| 46 | +### Example 1: Get All ADDomainService By default |
| 47 | +```powershell |
| 48 | +Get-AzADDomainService |
| 49 | +``` |
| 50 | + |
| 51 | +```output |
| 52 | +Name Domain Name Location Sku |
| 53 | +---- ----------- -------- --- |
| 54 | +youriADdomain youriAddomain.com westus Enterprise |
| 55 | +``` |
| 56 | + |
| 57 | +Get All ADDomainService By default |
| 58 | + |
| 59 | +### Example 2: Get ADDomainService By ResourceGroup and name |
| 60 | +```powershell |
| 61 | +Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain |
| 62 | +``` |
| 63 | + |
| 64 | +```output |
| 65 | +Name Domain Name Location Sku |
| 66 | +---- ----------- -------- --- |
| 67 | +youriADdomain youriAddomain.com westus Enterprise |
| 68 | +``` |
| 69 | + |
| 70 | +Get ADDomainService By ResourceGroup and name |
| 71 | + |
| 72 | +### Example 3: Get all ADDomainService By ResourceGroup |
| 73 | +```powershell |
| 74 | +Get-AzADDomainService -ResourceGroupName youriADdomain |
| 75 | +``` |
| 76 | + |
| 77 | +```output |
| 78 | +Name Domain Name Location Sku |
| 79 | +---- ----------- -------- --- |
| 80 | +youriADdomain youriAddomain.com westus Enterprise |
| 81 | +``` |
| 82 | + |
| 83 | +Get all ADDomainService By ResourceGroup |
| 84 | + |
| 85 | +### Example 4: Get ADDomainService By InputObject |
| 86 | +```powershell |
| 87 | +$getAzAddomain = Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain |
| 88 | +Get-AzADDomainService -InputObject $getAzAddomain |
| 89 | +``` |
| 90 | + |
| 91 | +```output |
| 92 | +Name Domain Name Location Sku |
| 93 | +---- ----------- -------- --- |
| 94 | +youriADdomain youriAddomain.com westus Enterprise |
| 95 | +``` |
| 96 | + |
| 97 | +Get ADDomainService By InputObject |
| 98 | + |
| 99 | +## PARAMETERS |
| 100 | + |
| 101 | +### -DefaultProfile |
| 102 | +The DefaultProfile parameter is not functional. |
| 103 | +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. |
| 104 | + |
| 105 | +```yaml |
| 106 | +Type: System.Management.Automation.PSObject |
| 107 | +Parameter Sets: (All) |
| 108 | +Aliases: AzureRMContext, AzureCredential |
| 109 | + |
| 110 | +Required: False |
| 111 | +Position: Named |
| 112 | +Default value: None |
| 113 | +Accept pipeline input: False |
| 114 | +Accept wildcard characters: False |
| 115 | +``` |
| 116 | +
|
| 117 | +### -InputObject |
| 118 | +Identity Parameter |
| 119 | +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. |
| 120 | +
|
| 121 | +```yaml |
| 122 | +Type: Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity |
| 123 | +Parameter Sets: GetViaIdentity |
| 124 | +Aliases: |
| 125 | + |
| 126 | +Required: True |
| 127 | +Position: Named |
| 128 | +Default value: None |
| 129 | +Accept pipeline input: True (ByValue) |
| 130 | +Accept wildcard characters: False |
| 131 | +``` |
| 132 | +
|
| 133 | +### -Name |
| 134 | +The name of the domain service. |
| 135 | +
|
| 136 | +```yaml |
| 137 | +Type: System.String |
| 138 | +Parameter Sets: Get |
| 139 | +Aliases: DomainServiceName |
| 140 | + |
| 141 | +Required: True |
| 142 | +Position: Named |
| 143 | +Default value: None |
| 144 | +Accept pipeline input: False |
| 145 | +Accept wildcard characters: False |
| 146 | +``` |
| 147 | +
|
| 148 | +### -ResourceGroupName |
| 149 | +The name of the resource group within the user's subscription. |
| 150 | +The name is case insensitive. |
| 151 | +
|
| 152 | +```yaml |
| 153 | +Type: System.String |
| 154 | +Parameter Sets: Get, List1 |
| 155 | +Aliases: |
| 156 | + |
| 157 | +Required: True |
| 158 | +Position: Named |
| 159 | +Default value: None |
| 160 | +Accept pipeline input: False |
| 161 | +Accept wildcard characters: False |
| 162 | +``` |
| 163 | +
|
| 164 | +### -SubscriptionId |
| 165 | +Gets subscription credentials which uniquely identify the Microsoft Azure subscription. |
| 166 | +The subscription ID forms part of the URI for every service call. |
| 167 | +
|
| 168 | +```yaml |
| 169 | +Type: System.String[] |
| 170 | +Parameter Sets: List, Get, List1 |
| 171 | +Aliases: |
| 172 | + |
| 173 | +Required: False |
| 174 | +Position: Named |
| 175 | +Default value: (Get-AzContext).Subscription.Id |
| 176 | +Accept pipeline input: False |
| 177 | +Accept wildcard characters: False |
| 178 | +``` |
| 179 | +
|
| 180 | +### CommonParameters |
| 181 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 182 | +
|
| 183 | +## INPUTS |
| 184 | +
|
| 185 | +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity |
| 186 | +
|
| 187 | +## OUTPUTS |
| 188 | +
|
| 189 | +### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IDomainService |
| 190 | +
|
| 191 | +## NOTES |
| 192 | +
|
| 193 | +## RELATED LINKS |
0 commit comments