Network Security Perimeter Configurations - Get

Referensi

Layanan:: Cosmos DB Resource Provider

Versi API:: 2025-05-01-preview

Mendapatkan Konfigurasi Perimeter Keamanan Jaringan yang efektif untuk asosiasi

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}?api-version=2025-05-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nama akun database Cosmos DB.
networkSecurityPerimeterConfigurationName	path	True	string pattern: ^.*$	Nama untuk 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.
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	Konfigurasi Perimeter Keamanan Jaringan
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

NamspaceNetworkSecurityPerimeterConfigurationList

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1?api-version=2025-05-01-preview

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/res4410/providers/Microsoft.DocumentDB/databaseAccounts/cosmosTest/networkSecurityPerimeterConfigurations/dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "name": "dbedb4e0-40e6-4145-81f3-f1314c150774.resourceAssociation1",
  "type": "Microsoft.DocumentDB/databaseAccounts/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Succeeded",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/res4794/providers/Microsoft.Network/networkSecurityPerimeters/nsp1",
      "perimeterGuid": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5",
      "location": "East US"
    },
    "resourceAssociation": {
      "name": "resourceAssociation1",
      "accessMode": "Enforced"
    },
    "profile": {
      "name": "profile1",
      "accessRulesVersion": 10,
      "accessRules": [
        {
          "name": "allowedSubscriptions",
          "properties": {
            "direction": "Inbound",
            "subscriptions": [
              {
                "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774"
              }
            ]
          }
        }
      ],
      "diagnosticSettingsVersion": 5,
      "enabledLogCategories": [
        "NspPublicInboundPerimeterRulesAllowed",
        "NspPublicInboundPerimeterRulesDenied"
      ]
    }
  }
}

Definisi

Nama	Deskripsi
AccessRule	Aturan akses dalam profil konfigurasi perimeter keamanan jaringan
AccessRuleDirection	Arah Aturan Akses
AccessRuleProperties	Properti Aturan Akses
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
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

Enumeration

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

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IssueType

Enumeration

Jenis masalah

Nilai	Deskripsi
ConfigurationPropagationFailure	Terjadi kesalahan saat menerapkan konfigurasi perimeter keamanan jaringan (NSP).
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.
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.
Unknown	Jenis masalah yang tidak diketahui

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

Enumeration

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

Nilai	Deskripsi
Accepted
Canceled
Creating
Deleting
Failed
Succeeded
Updating

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

Enumeration

Mode akses asosiasi sumber daya

Nilai	Deskripsi
Audit	Mode akses audit - lalu lintas ke sumber daya yang gagal pemeriksaan akses dicatat tetapi tidak diblokir
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

Severity

Enumeration

Tingkat keparahan masalah.

Nilai	Deskripsi
Error
Warning

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.

Bagikan melalui

Network Security Perimeter Configurations - Get

Parameter URI

Respons

Contoh

NamspaceNetworkSecurityPerimeterConfigurationList

Permintaan sampel

Respon sampel

Definisi

AccessRule

AccessRuleDirection

AccessRuleProperties

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IssueType

NetworkSecurityPerimeter

NetworkSecurityPerimeterConfiguration

NetworkSecurityPerimeterConfigurationProperties

NetworkSecurityPerimeterConfigurationProvisioningState

NetworkSecurityProfile

ProvisioningIssue

ProvisioningIssueProperties

ResourceAssociation

ResourceAssociationAccessMode

Severity

Subscriptions

systemData