-
Notifications
You must be signed in to change notification settings - Fork 392
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-po…
…wershell into poli
- Loading branch information
Showing
6,404 changed files
with
1,476,880 additions
and
9 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
Module Name: Az.ADDomainServices | ||
Module Guid: bba49006-4c09-406e-8fad-dd48d1b381e7 | ||
Download Help Link: https://learn.microsoft.com/powershell/module/az.addomainservices | ||
Help Version: 1.0.0.0 | ||
Locale: en-US | ||
content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Az.ADDomainServices.md | ||
original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Az.ADDomainServices.md | ||
--- | ||
|
||
# Az.ADDomainServices Module | ||
## Description | ||
Microsoft Azure PowerShell: AdDomainServices cmdlets | ||
|
||
## Az.ADDomainServices Cmdlets | ||
### [Get-AzADDomainService](Get-AzADDomainService.md) | ||
The Get Domain Service operation retrieves a json representation of the Domain Service. | ||
|
||
### [New-AzADDomainService](New-AzADDomainService.md) | ||
The Create Domain Service operation creates a new domain service with the specified parameters. | ||
If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. | ||
|
||
### [New-AzADDomainServiceForestTrustObject](New-AzADDomainServiceForestTrustObject.md) | ||
Create an in-memory object for ForestTrust. | ||
|
||
### [New-AzADDomainServiceReplicaSetObject](New-AzADDomainServiceReplicaSetObject.md) | ||
Create an in-memory object for ReplicaSet. | ||
|
||
### [Remove-AzADDomainService](Remove-AzADDomainService.md) | ||
The Delete Domain Service operation deletes an existing Domain Service. | ||
|
||
### [Update-AzADDomainService](Update-AzADDomainService.md) | ||
The Update Domain Service operation can be used to update the existing deployment. | ||
The update call only supports the properties listed in the PATCH body. | ||
|
205 changes: 205 additions & 0 deletions
205
azps-10.1.0/Az.ADDomainServices/Get-AzADDomainService.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,205 @@ | ||
--- | ||
external help file: | ||
Module Name: Az.ADDomainServices | ||
online version: https://learn.microsoft.com/powershell/module/az.addomainservices/get-azaddomainservice | ||
schema: 2.0.0 | ||
content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Get-AzADDomainService.md | ||
original_content_git_url: https://github.com/Azure/azure-powershell/blob/main/src/ADDomainServices/help/Get-AzADDomainService.md | ||
--- | ||
|
||
# Get-AzADDomainService | ||
|
||
## SYNOPSIS | ||
The Get Domain Service operation retrieves a json representation of the Domain Service. | ||
|
||
## SYNTAX | ||
|
||
### List (Default) | ||
``` | ||
Get-AzADDomainService [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>] | ||
``` | ||
|
||
### Get | ||
``` | ||
Get-AzADDomainService -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>] | ||
[-DefaultProfile <PSObject>] [<CommonParameters>] | ||
``` | ||
|
||
### GetViaIdentity | ||
``` | ||
Get-AzADDomainService -InputObject <IAdDomainServicesIdentity> [-DefaultProfile <PSObject>] | ||
[<CommonParameters>] | ||
``` | ||
|
||
### List1 | ||
``` | ||
Get-AzADDomainService -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] | ||
[<CommonParameters>] | ||
``` | ||
|
||
## DESCRIPTION | ||
The Get Domain Service operation retrieves a json representation of the Domain Service. | ||
|
||
## EXAMPLES | ||
|
||
### Example 1: Get All ADDomainService By default | ||
```powershell | ||
Get-AzADDomainService | ||
``` | ||
|
||
```output | ||
Name Domain Name Location Sku | ||
---- ----------- -------- --- | ||
youriADdomain youriAddomain.com westus Enterprise | ||
``` | ||
|
||
Get All ADDomainService By default | ||
|
||
### Example 2: Get ADDomainService By ResourceGroup and name | ||
```powershell | ||
Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain | ||
``` | ||
|
||
```output | ||
Name Domain Name Location Sku | ||
---- ----------- -------- --- | ||
youriADdomain youriAddomain.com westus Enterprise | ||
``` | ||
|
||
Get ADDomainService By ResourceGroup and name | ||
|
||
### Example 3: Get all ADDomainService By ResourceGroup | ||
```powershell | ||
Get-AzADDomainService -ResourceGroupName youriADdomain | ||
``` | ||
|
||
```output | ||
Name Domain Name Location Sku | ||
---- ----------- -------- --- | ||
youriADdomain youriAddomain.com westus Enterprise | ||
``` | ||
|
||
Get all ADDomainService By ResourceGroup | ||
|
||
### Example 4: Get ADDomainService By InputObject | ||
```powershell | ||
$getAzAddomain = Get-AzADDomainService -Name youriADdomain -ResourceGroupName youriADdomain | ||
Get-AzADDomainService -InputObject $getAzAddomain | ||
``` | ||
|
||
```output | ||
Name Domain Name Location Sku | ||
---- ----------- -------- --- | ||
youriADdomain youriAddomain.com westus Enterprise | ||
``` | ||
|
||
Get ADDomainService By InputObject | ||
|
||
## PARAMETERS | ||
|
||
### -DefaultProfile | ||
The credentials, account, tenant, and subscription used for communication with Azure. | ||
|
||
```yaml | ||
Type: System.Management.Automation.PSObject | ||
Parameter Sets: (All) | ||
Aliases: AzureRMContext, AzureCredential | ||
|
||
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.ADDomainServices.Models.IAdDomainServicesIdentity | ||
Parameter Sets: GetViaIdentity | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: True (ByValue) | ||
Accept wildcard characters: False | ||
``` | ||
### -Name | ||
The name of the domain service. | ||
```yaml | ||
Type: System.String | ||
Parameter Sets: Get | ||
Aliases: DomainServiceName | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -ResourceGroupName | ||
The name of the resource group within the user's subscription. | ||
The name is case insensitive. | ||
```yaml | ||
Type: System.String | ||
Parameter Sets: Get, List1 | ||
Aliases: | ||
|
||
Required: True | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -SubscriptionId | ||
Gets subscription credentials which uniquely identify the Microsoft Azure subscription. | ||
The subscription ID forms part of the URI for every service call. | ||
```yaml | ||
Type: System.String[] | ||
Parameter Sets: Get, List, List1 | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: (Get-AzContext).Subscription.Id | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### CommonParameters | ||
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). | ||
## INPUTS | ||
### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.IAdDomainServicesIdentity | ||
## OUTPUTS | ||
### Microsoft.Azure.PowerShell.Cmdlets.ADDomainServices.Models.Api202001.IDomainService | ||
## NOTES | ||
ALIASES | ||
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 `<IAdDomainServicesIdentity>`: Identity Parameter | ||
- `[DomainServiceName <String>]`: The name of the domain service. | ||
- `[Id <String>]`: Resource identity path | ||
- `[ResourceGroupName <String>]`: The name of the resource group within the user's subscription. The name is case insensitive. | ||
- `[SubscriptionId <String>]`: Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. | ||
|
||
## RELATED LINKS | ||
|
Oops, something went wrong.