Skip to content

Latest commit

 

History

History
182 lines (146 loc) · 5.14 KB

Get-AzSecurityConnector.md

File metadata and controls

182 lines (146 loc) · 5.14 KB
Raw
external help file Module Name online version schema
Az.Security-help.xml
Az.Security
2.0.0

Get-AzSecurityConnector

SYNOPSIS

Retrieves details of a specific security connector

SYNTAX

List (Default)

Get-AzSecurityConnector [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [<CommonParameters>]

Get

Get-AzSecurityConnector -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>] [<CommonParameters>]

List1

Get-AzSecurityConnector -ResourceGroupName <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentity

Get-AzSecurityConnector -InputObject <ISecurityIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

DESCRIPTION

Retrieves details of a specific security connector

EXAMPLES

Example 1: Get Security Connector resource by name

Get-AzSecurityConnector -ResourceGroupName "dfdtest-sdk" -Name "dfdsdktests-azdo-01"
EnvironmentData                 : {
                                    "environmentType": "AzureDevOpsScope"
                                  }
EnvironmentName                 : AzureDevOps
Etag                            : 
HierarchyIdentifier             : 4a8eb7f1-f533-48c5-b102-9b09e90906b7
HierarchyIdentifierTrialEndDate : 
Id                              : /subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourcegroups/dfdtest-sdk/providers/Microsoft.Security/securityConnectors/dfdsdktests-azdo-01
Kind                            : 
Location                        : centralus
Name                            : dfdsdktests-azdo-01
Offering                        : {{
                                    "offeringType": "CspmMonitorAzureDevOps"
                                  }}
ResourceGroupName               : dfdtest-sdk
SystemDataCreatedAt             : 12/7/2023 6:38:36 AM
SystemDataCreatedBy             : c3d82ccb-fee1-430c-949e-6c0a217c00a8
SystemDataCreatedByType         : Application
SystemDataLastModifiedAt        : 2/14/2024 2:11:46 AM
SystemDataLastModifiedBy        : c3d82ccb-fee1-430c-949e-6c0a217c00a8
SystemDataLastModifiedByType    : Application
Tag                             : {}
Type                            : Microsoft.Security/securityconnectors

Example 2: List Security Connectors by subscription

Get-AzSecurityConnector
Name                ResourceGroupName        EnvironmentName Location  HierarchyIdentifier
----                -----------------        --------------- --------  -------------------
dfdsdktests-azdo-01 dfdtest-sdk              AzureDevOps     centralus 4a8eb7f1-f533-48c5-b102-9b09e90906b7
dfdsdktests-gl-01   dfdtest-sdk              GitLab          centralus 7a1f4efe-f8c6-48e7-b7ef-1b45994ed602
dfdsdktests-gh-01   dfdtest-sdk              Github          centralus bc12ba4d-b89c-486e-85e1-d803e7d80525
aws-sdktest01       securityconnectors-tests AWS             CentralUS 891376984375
gcp-sdktest01       securityconnectors-tests GCP             CentralUS 843025268399

PARAMETERS

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

Type: Microsoft.Azure.PowerShell.Cmdlets.Security.Models.ISecurityIdentity
Parameter Sets: GetViaIdentity
Aliases:

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

-Name

The security connector name.

Type: System.String
Parameter Sets: Get
Aliases: SecurityConnectorName

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.

Type: System.String
Parameter Sets: Get, List1
Aliases:

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

-SubscriptionId

Azure subscription ID

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

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.Security.Models.ISecurityIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.Security.Models.ISecurityConnector

NOTES

RELATED LINKS