Network Security Perimeter Configurations - Get

Layanan:: Search Management

Versi API:: 2025-05-01

Mendapatkan konfigurasi perimeter keamanan jaringan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}?api-version=2025-05-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
nspConfigName	path	True	string minLength: 38 maxLength: 100 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\.[a-z][a-z0-9]*$	Nama konfigurasi perimeter keamanan jaringan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nama layanan Azure AI Search yang terkait dengan grup sumber daya yang ditentukan.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	NetworkSecurityPerimeterConfiguration	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get an NSP config by name

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-05-01

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/NetworkSecurityPerimeterConfigurationsGet.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().Get(ctx, "rg1", "mysearchservice", "00000001-2222-3333-4444-111144444444.assoc1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.NetworkSecurityPerimeterConfigurationsClientGetResponse{
	// 	NetworkSecurityPerimeterConfiguration: &armsearch.NetworkSecurityPerimeterConfiguration{
	// 		Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 			NetworkSecurityPerimeter: &armsearch.NetworkSecurityPerimeter{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 				Location: to.Ptr("westus"),
	// 			},
	// 			Profile: &armsearch.NetworkSecurityProfile{
	// 				Name: to.Ptr("profile1"),
	// 				AccessRules: []*armsearch.AccessRule{
	// 					{
	// 						Name: to.Ptr("rule1"),
	// 						Properties: &armsearch.AccessRuleProperties{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("148.0.0.0/8"),
	// 								to.Ptr("152.4.6.0/24"),
	// 							},
	// 							Direction: to.Ptr(armsearch.AccessRuleDirectionInbound),
	// 						},
	// 					},
	// 				},
	// 				AccessRulesVersion: to.Ptr[int32](0),
	// 			},
	// 			ProvisioningState: to.Ptr(armsearch.NetworkSecurityPerimeterConfigurationProvisioningStateAccepted),
	// 			ResourceAssociation: &armsearch.ResourceAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				AccessMode: to.Ptr(armsearch.ResourceAssociationAccessModeEnforced),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "properties": {
    "networkSecurityPerimeter": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "profile": {
      "name": "profile1",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ],
            "direction": "Inbound"
          }
        }
      ],
      "accessRulesVersion": 0
    },
    "provisioningState": "Accepted",
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    }
  }
}

Definisi

Nama	Deskripsi
AccessRule	Aturan akses dalam profil konfigurasi perimeter keamanan jaringan
AccessRuleDirection	Arah Aturan Akses
AccessRuleProperties	Properti Aturan Akses
CloudError	Berisi informasi tentang kesalahan API.
CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
createdByType	Jenis identitas yang membuat sumber daya.
IssueType	Jenis masalah
NetworkSecurityPerimeter	Informasi tentang perimeter keamanan jaringan (NSP)
NetworkSecurityPerimeterConfiguration	Sumber daya konfigurasi perimeter keamanan jaringan (NSP)
NetworkSecurityPerimeterConfigurationProperties	Properti konfigurasi keamanan jaringan.
NetworkSecurityPerimeterConfigurationProvisioningState	Status provisi konfigurasi perimeter keamanan jaringan yang sedang dibuat atau diperbarui.
NetworkSecurityProfile	Profil konfigurasi perimeter keamanan jaringan
ProvisioningIssue	Menjelaskan masalah provisi untuk konfigurasi perimeter keamanan jaringan
ProvisioningIssueProperties	Detail masalah provisi untuk konfigurasi perimeter keamanan jaringan (NSP). Penyedia sumber daya harus menghasilkan elemen masalah provisi terpisah untuk setiap masalah terpisah yang terdeteksi, dan menyertakan deskripsi yang bermakna dan khas, serta suggestedResourceIds dan suggestedAccessRules yang sesuai
ResourceAssociation	Informasi tentang asosiasi sumber daya
ResourceAssociationAccessMode	Mode akses asosiasi sumber daya
Severity	Tingkat keparahan masalah.
Subscriptions	Langganan untuk aturan masuk
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

AccessRule

Objek

Aturan akses dalam profil konfigurasi perimeter keamanan jaringan

Nama	Jenis	Deskripsi
name	string	Nama aturan akses
properties	AccessRuleProperties	Properti Aturan Akses

AccessRuleDirection

Enumerasi

Arah Aturan Akses

Nilai	Deskripsi
Inbound	Berlaku untuk lalu lintas jaringan masuk ke sumber daya aman.
Outbound	Berlaku untuk lalu lintas jaringan keluar dari sumber daya aman

AccessRuleProperties

Objek

Properti Aturan Akses

Nama	Jenis	Deskripsi
addressPrefixes	string[]	Awalan alamat dalam format CIDR untuk aturan masuk
direction	AccessRuleDirection	Arah Aturan Akses
emailAddresses	string[]	Alamat email untuk aturan keluar
fullyQualifiedDomainNames	string[]	Nama domain yang sepenuhnya memenuhi syarat (FQDN) untuk aturan keluar
networkSecurityPerimeters	NetworkSecurityPerimeter[]	Perimeter keamanan jaringan untuk aturan masuk
phoneNumbers	string[]	Nomor telepon untuk aturan keluar
subscriptions	Subscriptions[]	Langganan untuk aturan masuk

CloudError

Objek

Berisi informasi tentang kesalahan API.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.
message	string	Deskripsi singkat tentang kesalahan yang mengisyaratkan apa yang salah (untuk informasi detail/penelusuran kesalahan merujuk ke properti 'error.message').

CloudErrorBody

Objek

Menjelaskan kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan yang menjelaskan kondisi kesalahan lebih tepat daripada kode status HTTP. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.
details	CloudErrorBody[]	Berisi kesalahan berlapis yang terkait dengan kesalahan ini.
message	string	Pesan yang menjelaskan kesalahan secara rinci dan menyediakan informasi penelusuran kesalahan.
target	string	Target kesalahan tertentu (misalnya, nama properti dalam kesalahan).

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

IssueType

Enumerasi

Jenis masalah

Nilai	Deskripsi
Unknown	Jenis masalah yang tidak diketahui
ConfigurationPropagationFailure	Terjadi kesalahan saat menerapkan konfigurasi perimeter keamanan jaringan (NSP).
MissingPerimeterConfiguration	Masalah konektivitas jaringan terjadi pada sumber daya yang dapat diatasi dengan menambahkan sumber daya baru ke perimeter keamanan jaringan (NSP) atau dengan memodifikasi aturan akses.
MissingIdentityConfiguration	Identitas terkelola belum dikaitkan dengan sumber daya. Sumber daya masih akan dapat memvalidasi lalu lintas masuk dari perimeter keamanan jaringan (NSP) atau aturan akses masuk yang cocok, tetapi tidak akan dapat melakukan akses keluar sebagai anggota NSP.

NetworkSecurityPerimeter

Objek

Informasi tentang perimeter keamanan jaringan (NSP)

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya Azure yang sepenuhnya memenuhi syarat dari sumber daya NSP
location	string	Lokasi perimeter keamanan jaringan
perimeterGuid	string (uuid)	ID unik universal (UUID) dari perimeter keamanan jaringan

NetworkSecurityPerimeterConfiguration

Objek

Sumber daya konfigurasi perimeter keamanan jaringan (NSP)

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties	NetworkSecurityPerimeterConfigurationProperties	Properti konfigurasi keamanan jaringan.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Objek

Properti konfigurasi keamanan jaringan.

Nama	Jenis	Deskripsi
networkSecurityPerimeter	NetworkSecurityPerimeter	Informasi tentang perimeter keamanan jaringan (NSP)
profile	NetworkSecurityProfile	Profil konfigurasi perimeter keamanan jaringan
provisioningIssues	ProvisioningIssue[]	Daftar masalah provisi, jika ada
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	Status provisi konfigurasi perimeter keamanan jaringan yang sedang dibuat atau diperbarui.
resourceAssociation	ResourceAssociation	Informasi tentang asosiasi sumber daya

NetworkSecurityPerimeterConfigurationProvisioningState

Enumerasi

Status provisi konfigurasi perimeter keamanan jaringan yang sedang dibuat atau diperbarui.

Nilai	Deskripsi
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Objek

Profil konfigurasi perimeter keamanan jaringan

Nama	Jenis	Deskripsi
accessRules	AccessRule[]	Daftar Aturan Akses
accessRulesVersion	integer (int32)	Versi aturan akses saat ini
diagnosticSettingsVersion	integer (int32)	Versi pengaturan diagnostik saat ini
enabledLogCategories	string[]	Daftar kategori log yang diaktifkan
name	string	Nama profil

ProvisioningIssue

Objek

Menjelaskan masalah provisi untuk konfigurasi perimeter keamanan jaringan

Nama	Jenis	Deskripsi
name	string	Nama masalah
properties	ProvisioningIssueProperties	Detail masalah provisi untuk konfigurasi perimeter keamanan jaringan (NSP). Penyedia sumber daya harus menghasilkan elemen masalah provisi terpisah untuk setiap masalah terpisah yang terdeteksi, dan menyertakan deskripsi yang bermakna dan khas, serta suggestedResourceIds dan suggestedAccessRules yang sesuai

ProvisioningIssueProperties

Objek

Detail masalah provisi untuk konfigurasi perimeter keamanan jaringan (NSP). Penyedia sumber daya harus menghasilkan elemen masalah provisi terpisah untuk setiap masalah terpisah yang terdeteksi, dan menyertakan deskripsi yang bermakna dan khas, serta suggestedResourceIds dan suggestedAccessRules yang sesuai

Nama	Jenis	Deskripsi
description	string	Deskripsi masalah
issueType	IssueType	Jenis masalah
severity	Severity	Tingkat keparahan masalah.
suggestedAccessRules	AccessRule[]	Aturan akses yang dapat ditambahkan ke profil keamanan jaringan (NSP) untuk memulihkan masalah.
suggestedResourceIds	string[] (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat dari sumber daya yang disarankan yang dapat dikaitkan dengan perimeter keamanan jaringan (NSP) untuk memulihkan masalah.

ResourceAssociation

Objek

Informasi tentang asosiasi sumber daya

Nama	Jenis	Deskripsi
accessMode	ResourceAssociationAccessMode	Mode akses asosiasi sumber daya
name	string	Nama asosiasi sumber daya

ResourceAssociationAccessMode

Enumerasi

Mode akses asosiasi sumber daya

Nilai	Deskripsi
Enforced	Mode akses yang diberlakukan - lalu lintas ke sumber daya yang gagal pemeriksaan akses diblokir
Learning	Mode akses pembelajaran - lalu lintas ke sumber daya diaktifkan untuk analisis tetapi tidak diblokir
Audit	Mode akses audit - lalu lintas ke sumber daya yang gagal pemeriksaan akses dicatat tetapi tidak diblokir

Severity

Enumerasi

Tingkat keparahan masalah.

Nilai	Deskripsi
Warning
Error

Subscriptions

Objek

Langganan untuk aturan masuk

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya Azure yang sepenuhnya memenuhi syarat dari langganan misalnya ('/subscriptions/00000000-0000-0000-0000-0000-0000000000000000')

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.