New-SIAPolicyProviderDefinition
SYNOPSIS
Creates an object defining Provider data for inclusion in a SIA policy.
SYNTAX
AWS
New-SIAPolicyProviderDefinition [-AWS] [-regions <String[]>] [-tags <PSObject[]>] [-vpcIds <String[]>]
[-accountIds <String[]>] [-ProviderDefinition <PSObject>] [<CommonParameters>]
Azure
New-SIAPolicyProviderDefinition [-Azure] [-regions <String[]>] [-tags <PSObject[]>]
[-resourceGroups <String[]>] [-vnetIds <String[]>] [-subscriptions <String[]>]
[-ProviderDefinition <PSObject>] [<CommonParameters>]
OnPrem
New-SIAPolicyProviderDefinition [-OnPrem] [-fqdnRulesConjunction <String>] -fqdnRules <PSObject[]>
[-ProviderDefinition <PSObject>] [<CommonParameters>]
GCP
New-SIAPolicyProviderDefinition [-GCP] [-regions <String[]>] [-vpcIds <String[]>] [-labels <PSObject[]>]
[-projects <String[]>] [-ProviderDefinition <PSObject>] [<CommonParameters>]
DESCRIPTION
Defines the data and criteria for providers supported in SIA.
Target machines matching the criteria will be accessible via a policy containing the definition.
The object output by this function is provided as input for the `providersData` parameter of the `New-SIAPolicy` function.
EXAMPLES
Example 1
$Provider = New-SIAPolicyProviderDefinition -OnPrem -fqdnRulesConjunction OR -fqdnRules $FQDNrules
Creates a provider definition for on-premise connections.
The `$FQDNrules` value is output from the `New-SIAPolicyFQDNRuleDefinition` function.
The `$Provider` variable in the above example is used as input for the `providersData` parameter of the `New-SIAPolicy` function.
Example 2
$Provider = New-SIAPolicyProviderDefinition -AWS -regions "us-east-1","us-east-2" -tags @{"Key"="env";"Value"=@("prod")}
Creates a provider definition for AWS connections.
The `$Provider` variable in the above example is used as input for the `providersData` parameter of the `New-SIAPolicy` function.
Example 3
$Provider = New-SIAPolicyProviderDefinition -Azure -regions "eastus2","eastus" -tags @{"Key"="env";"Value"=@("prod")}
Creates a provider definition for Azure connections.
The `$Provider` variable in the above example is used as input for the `providersData` parameter of the `New-SIAPolicy` function.
Example 4
$Provider = New-SIAPolicyProviderDefinition -GCP -regions "asia-east1","us-east1" -labels @{"Key"="env";"Value"=@("prod")}
Creates a provider definition for GCP connections.
The `$Provider` variable in the above example is used as input for the `providersData` parameter of the `New-SIAPolicy` function.
Example 5
$Provider = New-SIAPolicyProviderDefinition -OnPrem -fqdnRulesConjunction OR -fqdnRules $FQDNrules
$Provider = New-SIAPolicyProviderDefinition -AWS -regions "us-east-1","us-east-2" -tags @{"Key"="env";"Value"=@("prod")} -ProviderDefinition $Provider
$Provider = New-SIAPolicyProviderDefinition -Azure -regions "eastus2","eastus" -tags @{"Key"="env";"Value"=@("prod")} -ProviderDefinition $Provider
$Provider = New-SIAPolicyProviderDefinition -GCP -regions "asia-east1","us-east1" -labels @{"Key"="env";"Value"=@("prod")} -ProviderDefinition $Provider
Creates a provider definition for on-premise, AWS, Azure & GCP connections.
The `$FQDNrules` value is output from the `New-SIAPolicyFQDNRuleDefinition` function.
The `$Provider` variable in the above example is used as input for the `providersData` parameter of the `New-SIAPolicy` function.
PARAMETERS
-AWS
Specify to define an AWS provider object.
Type: SwitchParameter
Parameter Sets: AWS
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Azure
Specify to define an Azure provider object.
Type: SwitchParameter
Parameter Sets: Azure
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-GCP
Specify to define a GCP provider object.
Type: SwitchParameter
Parameter Sets: GCP
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-OnPrem
Specify to define an On-Premise provider object.
Type: SwitchParameter
Parameter Sets: OnPrem
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ProviderDefinition
Add additional data to previous output from `New-SIAPolicyProviderDefinition`.
Used to create defninitions which cover multiple providers to be included in a single SIA policy.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-accountIds
AWS Account IDs.
Leave empty for all AWS Accounts.
Type: String[]
Parameter Sets: AWS
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-fqdnRules
Accepts output from New-SIAPolicyFQDNRuleDefinition.
List of FQDN rules applied to the connection
Type: PSObject[]
Parameter Sets: OnPrem
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-fqdnRulesConjunction
FQDN Rules relationship (AND/OR).
Type: String
Parameter Sets: OnPrem
Aliases:
Accepted values: AND, OR
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-labels
A list of key/value pairs that have been defined as custom labels for GCP VMs.
Leave empty for all labels
Type: PSObject[]
Parameter Sets: GCP
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-projects
GCP project IDs.
Leave empty for all projects.
Type: String[]
Parameter Sets: GCP
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-regions
AWS, Azure or GCP region names.
Leave empty for all regions.
Type: String[]
Parameter Sets: AWS, Azure, GCP
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-resourceGroups
A list of Azure resource group IDs.
Leave empty for all resource groups
Type: String[]
Parameter Sets: Azure
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-subscriptions
Azure subscription IDs.
Leave empty for all subscriptions.
Type: String[]
Parameter Sets: Azure
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-tags
A list of key/value pairs that have been defined as custom tags for Azure VMs or AWS instances.
Leave empty for all tags
Type: PSObject[]
Parameter Sets: AWS, Azure
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-vnetIds
A list of Azure VNet IDs.
Leave empty for all VNets.
Type: String[]
Parameter Sets: Azure
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-vpcIds
A list of AWS or GCP VPC IDs.
Leave empty for all VPCs.
Type: String[]
Parameter Sets: AWS, GCP
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.