Invoke-AzRestMethod ile Azure kaynaklarını yönetme

Invoke-AzRestMethod Az PowerShell modülü sürüm 4.4.0'da kullanıma sunulan Azure PowerShell bir cmdlet'tir. Az bağlamını kullanarak Azure Resource Manager (ARM) uç noktasına özel HTTP istekleri göndermenizi sağlar.

Bu cmdlet, henüz Az PowerShell modülünde bulunmayan özellikler için Azure hizmetlerini yönetmek istediğinizde kullanışlıdır.

Invoke-AzRestMethod Nasıl Kullanılır

Örneğin, yalnızca belirli ağlar için Azure Container Registry (ACR) erişimine izin verebilir veya genel erişimi reddedebilirsiniz. Az PowerShell modülü 4.5.0 sürümünden itibaren bu özellik henüz Az.ContainerRegistry PowerShell modülünde sağlanmamıştır. Ancak, bu süre zarfında Invoke-AzRestMethod ile yönetilebilir.

GET işlemleriyle Invoke-AzRestMethod kullanma

Aşağıdaki örnekte, cmdlet'in Invoke-AzRestMethod get işlemiyle nasıl kullanılacağı gösterilmektedir:

$getParams = @{
  ResourceGroupName = 'myresourcegroup'
  ResourceProviderName = 'Microsoft.ContainerRegistry'
  ResourceType = 'registries'
  Name = 'myacr'
  ApiVersion = '2019-12-01-preview'
  Method = 'GET'
}
Invoke-AzRestMethod @getParams

Maksimum esnekliğe izin vermek için Invoke-AzRestMethod parametrelerinin çoğu isteğe bağlıdır. Ancak, bir kaynak grubu içindeki kaynakları yönetirken, kaynağa tam kimliği veya kaynak grubu, kaynak sağlayıcısı ve kaynak türü gibi parametreleri sağlamanız gerekir.

ResourceType ve Name parametreleri, birden fazla ad gerektiren kaynakları hedeflerken birden çok değer alabilir. Örneğin, Log Analytics çalışma alanında kaydedilmiş bir aramayı işlemek için parametreler aşağıdaki örneğe benzer: -ResourceType @('workspaces', 'savedsearches') -Name @('my-la', 'my-search').

Dizideki konumu temel alan bir eşleme kullanarak cmdlet şu kaynağı oluşturur: Id:'/workspaces/my-la/savedsearches/my-search'.

parametresi, APIVersion önizleme sürümü de dahil olmak üzere belirli bir API sürümünü kullanmanıza olanak tanır. Azure Kaynak sağlayıcıları için desteklenen API sürümleri azure-rest-api-specs GitHub deposunda bulunabilir.

2019-12-01-preview ACR API sürümünün tanımını şu konumda bulabilirsiniz: azure-rest-api-specs/specification/containerregistry/resource-manager/Microsoft. ContainerRegistry/önizleme/.

PATCH işlemleriyle Invoke-AzRestMethod'u kullanma

myacr kaynak grubundaki myresourcegroup adlı mevcut ACR'ye genel erişimi Invoke-AzRestMethod cmdlet'ini kullanarak devre dışı bırakabilirsiniz.

Genel ağ erişimini devre dışı bırakmak için, aşağıdaki örnekte gösterildiği gibi parametrenin değerini değiştiren API'ye bir publicNetwokAccess çağrısı yapmanız gerekir:

$patchParams = @{
  ResourceGroupName = 'myresourcegroup'
  Name = 'myacr'
  ResourceProviderName = 'Microsoft.ContainerRegistry'
  ResourceType = 'registries'
  ApiVersion = '2019-12-01-preview'
  Payload = '{ "properties": {
     "publicNetworkAccess": "Disabled"
     } }'
  Method = 'PATCH'
}
Invoke-AzRestMethod @patchParams

Payload özelliği, değiştirilecek özelliğin yolunu gösteren bir JSON dizesidir.

Bu API'nin tüm parametreleri bu API ile ilişkili rest-api-spec dosyasında açıklanmıştır. publicNetworkAccess parametresinin özel tanımı, API sürümü için 2019-12-01-preview bulunabilir.

Kayıt defterine yalnızca belirli bir IP adresinden erişime izin vermek için yükün aşağıdaki örnekte gösterildiği gibi değiştirilmesi gerekir:

$specificIpParams = @{
  ResourceGroupName = 'myresourcegroup'
  Name = 'myacr'
  ResourceProviderName = 'Microsoft.ContainerRegistry'
  ResourceType = 'registries'
  ApiVersion = '2019-12-01-preview'
  Payload = '{ "properties": {
      "networkRuleSet": {
      "defaultAction": "Deny",
      "ipRules": [ {
         "action": "Allow",
         "value": "24.22.123.123"
         } ]
      }
  } }'
  Method = 'PATCH'
}
Invoke-AzRestMethod @specificIpParams

Get-AzResource, New-AzResource ve Remove-AzResource karşılaştırması

*-AzResource cmdlet'leri kaynak türünü, API sürümünü ve güncelleştirilecek özellikleri belirterek REST API çağrısını Azure özelleştirmenize olanak sağlar. Ancak, özelliklerin önce PSObject olarak oluşturulması gerekir. Bu işlem ek bir karmaşıklık düzeyi ekler ve karmaşık hale gelebilir.

Invoke-AzRestMethod, Azure kaynaklarını yönetmek için bir yol sunar. Önceki örnekte gösterildiği gibi, bir JSON dizesi derleyebilir ve herhangi PSObjectsbir önceden oluşturmak zorunda kalmadan REST API çağrısını özelleştirmek için kullanabilirsiniz.

Cmdlet'leri zaten biliyorsanız *-AzResource , bunları kullanmaya devam edebilirsiniz. Onları desteklemeyi durdurmayı planlamıyoruz. ile Invoke-AzRestMethodaraç setinize yeni bir cmdlet ekledik.

Ayrıca Bkz

  • Last updated on