Aracılığıyla paylaş

Set-AzApiManagementPolicy

  • Başvuru
Modül:
Az.ApiManagement

API Management için belirtilen kapsam ilkesini ayarlar.

Sözdizimi

Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ProductId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Set-AzApiManagementPolicy cmdlet'i API Management için belirtilen kapsam ilkesini ayarlar.

Örnekler

Örnek 1: Kiracı düzeyi ilkesini ayarlama

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml"

Bu komut, tenantpolicy.xml adlı bir dosyadan kiracı düzeyi ilkesini ayarlar.

Örnek 2: Ürün kapsamı ilkesi ayarlama

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyString

Bu komut API Management için ürün kapsamı ilkesini ayarlar.

Örnek 3: API kapsamı ilkesini ayarlama

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString

Bu komut API Management için API kapsamı ilkesini ayarlar.

Örnek 4: İşlem kapsamı ilkesini ayarlama

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString

Bu komut API Management için işlem kapsamı ilkesini ayarlar.

Parametreler

-ApiId

Mevcut API'nin tanımlayıcısını belirtir. Bu parametreyi belirtirseniz, cmdlet API kapsamı ilkesini ayarlar.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ApiRevision

API Düzeltme tanımlayıcısı. Bu parametre isteğe bağlıdır. Belirtilmezse, ilke şu anda etkin olan API düzeltmesinde güncelleştirilir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Context

PsApiManagementContext örneğini belirtir.

Tür:PsApiManagementContext
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-Format

İlkenin biçimini belirtir. kullanılırken application/vnd.ms-azure-apim.policy+xml, ilkenin içinde yer alan ifadelerin XML kaçışı olmalıdır. application/vnd.ms-azure-apim.policy.raw+xml Kullanırken, ilkenin XML kaçışı olması gerekli değildir. Varsayılan değer şudur: application/vnd.ms-azure-apim.policy+xml. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-OperationId

Var olan işlemin tanımlayıcısını belirtir. ApiId ile belirtilirse işlem kapsamı ilkesi ayarlanır. Bu parametreler gereklidir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PassThru

geçiş

Tür:SwitchParameter
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Policy

İlke belgesini dize olarak belirtir. -PolicyFilePath belirtilmezse bu parametre gereklidir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PolicyFilePath

İlke belgesi dosya yolunu belirtir. İlke parametresi belirtilmezse bu parametre gereklidir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-PolicyUrl

İlke belgesinin barındırıldığı Url. -Policy veya -PolicyFilePath belirtilmezse bu parametre gereklidir.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ProductId

Mevcut ürünün tanımlayıcısını belirtir. Bu parametre belirtilirse, cmdlet ürün kapsamı ilkesini ayarlar.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

Girişler

PsApiManagementContext

String

SwitchParameter

Çıkışlar

Boolean