Get-AzSearchNetworkSecurityPerimeterConfiguration

Module:

Az.Search Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Gets an Azure AI Search service network security perimeter configuration.

Syntax

Default (Default)

Get-AzSearchNetworkSecurityPerimeterConfiguration
    [-ResourceGroupName] <String>
    [-ServiceName] <String>
    [[-Name] <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Get-AzSearchNetworkSecurityPerimeterConfiguration cmdlet gets the specified Azure AI Search service network security perimeter configuration.

Examples

Example 1

Get-AzSearchNetworkSecurityPerimeterConfiguration -ResourceGroupName rg1 -ServiceName mysearchservice -Name 00000001-2222-3333-4444-111144444444.assoc1 | ConvertTo-Json

{
  "Name": "00000001-2222-3333-4444-111144444444.assoc1",
  "Id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "Type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "ProvisioningState": "Accepted",
  "NetworkSecurityPerimeter": {
    "Id": "/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
    "Location": "westus"
    },
  "ResourceAssociation": {
    "Name": "assoc1",
    "AccessMode": "Enforced"
  },
  "Profile": {
    "name": "profile1",
    "accessRulesVersion": 0,
    "accessRules": [
      {
        "name": "rule1",
        "properties": {
        "direction": "Inbound",
        "addressPrefixes": [
          "148.0.0.0/8",
          "152.4.6.0/24"
          ]
        }
      }
    ]
  }
}

Get an Azure AI Search service network security perimeter configuration with specified parameters.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Azure AI Search Service network security perimeter configuration name

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	2
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

Resource Group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ServiceName

Azure AI Search Service name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

Outputs

Microsoft.Azure.Commands.Management.Search.Models.PSNetworkSecurityPerimeterConfiguration)