Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/KubernetesConfiguration/docs/Az.KubernetesConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
Module Name: Az.KubernetesConfiguration
Module Guid: 5a3ae8d3-8682-4ae7-8ec2-d41c0383da2b
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.kubernetesconfiguration
Help Version: 1.0.0.0
Locale: en-US
---

# Az.KubernetesConfiguration Module
## Description
Microsoft Azure PowerShell: KubernetesConfiguration cmdlets

## Az.KubernetesConfiguration Cmdlets
### [Get-AzKubernetesConfiguration](Get-AzKubernetesConfiguration.md)
Gets details of the Source Control Configuration.

### [New-AzKubernetesConfiguration](New-AzKubernetesConfiguration.md)
Create a new Kubernetes Source Control Configuration.

### [Remove-AzKubernetesConfiguration](Remove-AzKubernetesConfiguration.md)
This will delete the YAML file used to set up the Source control configuration, thus stopping future sync from the source repo.

238 changes: 238 additions & 0 deletions src/KubernetesConfiguration/docs/Get-AzKubernetesConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
---
external help file:
Module Name: Az.KubernetesConfiguration
online version: https://docs.microsoft.com/en-us/powershell/module/az.kubernetesconfiguration/get-azkubernetesconfiguration
schema: 2.0.0
---

# Get-AzKubernetesConfiguration

## SYNOPSIS
Gets details of the Source Control Configuration.

## SYNTAX

### List (Default)
```
Get-AzKubernetesConfiguration -ClusterName <String> -ClusterRp <String> -ClusterType <String>
-ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
```

### Get
```
Get-AzKubernetesConfiguration -ClusterName <String> -ClusterRp <String> -ClusterType <String> -Name <String>
-ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<CommonParameters>]
```

### GetViaIdentity
```
Get-AzKubernetesConfiguration -InputObject <IKubernetesConfigurationIdentity> [-DefaultProfile <PSObject>]
[<CommonParameters>]
```

## DESCRIPTION
Gets details of the Source Control Configuration.

## EXAMPLES

### Example 1: Get all configurations of kubernetes cluster
```powershell
PS C:\> Get-AzKubernetesConfiguration -ResourceGroupName azureps-manual-test -ClusterName ps-connaks-t02 -ClusterRp Microsoft.Kubernetes -ClusterType ConnectedClusters

Name Type
---- ----
conf-test01 Microsoft.KubernetesConfiguration/sourceControlConfigurations
```

This command gets all configurations of kubernetes cluster.

### Example 2: Get a configuration of kubernetes cluster by name
```powershell
PS C:\> Get-AzKubernetesConfiguration -ResourceGroupName azureps-manual-test -ClusterName ps-connaks-t02 -ClusterRp Microsoft.Kubernetes -ClusterType ConnectedClusters -Name conf-t02

Name Type
---- ----
conf-t02 Microsoft.KubernetesConfiguration/sourceControlConfigurations
```

This command gets a configuration of kubernetes cluster by name.

### Example 3: Get a configuration of kubernetes cluster by object
```powershell
PS C:\> $kubConf = New-AzKubernetesConfiguration -Name conf-test02 -ClusterName connaks-dkc29c -ResourceGroupName connaks-rg-w9vlnp -RepositoryUrl http://github.com/xxxx
PS C:\> Get-AzKubernetesConfiguration -InputObject $kubConf

Name Type
---- ----
conf-t02 Microsoft.KubernetesConfiguration/sourceControlConfigurations
```

This command gets a configuration of kubernetes cluster by object.

### Example 4: Get a configuration of kubernetes cluster by pipeline
```powershell
PS C:\> @{Id='/subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/connaks-rg-w9vlnp/providers/Microsoft.Kubernetes/connectedClusters/connaks-d983yc/providers/Microsoft.KubernetesConfiguration/sourceControlConfigurations/conf-test01'} | Get-AzKubernetesConfiguration

Name Type
---- ----
conf-test01 Microsoft.KubernetesConfiguration/sourceControlConfigurations
```

This command gets a configuration of kubernetes cluster by pipeline.

## PARAMETERS

### -ClusterName
The name of the kubernetes cluster.

```yaml
Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClusterRp
The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters).

```yaml
Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClusterType
The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters).

```yaml
Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -Name
Name of the Source Control Configuration.

```yaml
Type: System.String
Parameter Sets: Get
Aliases: SourceControlConfigurationName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ResourceGroupName
The name of the resource group.

```yaml
Type: System.String
Parameter Sets: Get, List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SubscriptionId
The Azure subscription ID.
This is a GUID-formatted string (e.g.
00000000-0000-0000-0000-000000000000)

```yaml
Type: System.String[]
Parameter Sets: Get, List
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.KubernetesConfiguration.Models.IKubernetesConfigurationIdentity

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.KubernetesConfiguration.Models.Api20191101Preview.ISourceControlConfiguration

## 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 <IKubernetesConfigurationIdentity>: Identity Parameter
- `[ClusterName <String>]`: The name of the kubernetes cluster.
- `[ClusterResourceName <String>]`: The Kubernetes cluster resource name - either managedClusters (for AKS clusters) or connectedClusters (for OnPrem K8S clusters).
- `[ClusterRp <String>]`: The Kubernetes cluster RP - either Microsoft.ContainerService (for AKS clusters) or Microsoft.Kubernetes (for OnPrem K8S clusters).
- `[Id <String>]`: Resource identity path
- `[ResourceGroupName <String>]`: The name of the resource group.
- `[SourceControlConfigurationName <String>]`: Name of the Source Control Configuration.
- `[SubscriptionId <String>]`: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

## RELATED LINKS

Loading