Set-AzApiManagementPolicy

모듈:

Az.ApiManagement

API Management에 대해 지정된 범위 정책을 설정합니다.

구문

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은 API Management에 대해 지정된 범위 정책을 설정합니다.

예제

예제 1: 테넌트 수준 정책 설정

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

이 명령은 tenantpolicy.xml 파일에서 테넌트 수준 정책을 설정합니다.

예제 2: 제품 범위 정책 설정

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

이 명령은 API Management에 대한 제품 범위 정책을 설정합니다.

예제 3: API 범위 정책 설정

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

이 명령은 API Management에 대한 API 범위 정책을 설정합니다.

예제 4: 작업 범위 정책 설정

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

이 명령은 API Management에 대한 작업 범위 정책을 설정합니다.

매개 변수

-ApiId

기존 API의 식별자를 지정합니다. 이 매개 변수를 지정하는 경우 cmdlet은 API 범위 정책을 설정합니다.

형식:	String
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-ApiRevision

API 수정 버전의 식별자입니다. 이 매개 변수는 선택 사항입니다. 지정하지 않으면 정책이 현재 활성 API 수정 버전에서 업데이트됩니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-Context

PsApiManagementContext의 인스턴스를 지정합니다.

형식:	PsApiManagementContext
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-DefaultProfile

Azure와의 통신에 사용되는 자격 증명, 계정, 테넌트 및 구독입니다.

형식:	IAzureContextContainer
별칭:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	False
와일드카드 문자 허용:	False

-Format

정책의 형식을 지정합니다. 사용하는 application/vnd.ms-azure-apim.policy+xml경우 정책 내에 포함된 식은 XML 이스케이프되어야 합니다. 사용하는 application/vnd.ms-azure-apim.policy.raw+xml 경우 정책이 XML 이스케이프될 필요가 없습니다 . 기본값은 application/vnd.ms-azure-apim.policy+xml입니다. 이 매개 변수는 선택 사항입니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-OperationId

기존 작업의 식별자를 지정합니다. ApiId로 지정하면 작업 범위 정책이 설정됩니다. 이 매개 변수는 필수입니다.

형식:	String
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-PassThru

passthru

형식:	SwitchParameter
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-Policy

정책 문서를 문자열로 지정합니다. -PolicyFilePath 를 지정하지 않은 경우 이 매개 변수가 필요합니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-PolicyFilePath

정책 문서 파일 경로를 지정합니다. Policy 매개 변수를 지정하지 않은 경우 이 매개 변수가 필요합니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-PolicyUrl

정책 문서가 호스트되는 URL입니다. -Policy 또는 -PolicyFilePath를 지정하지 않은 경우 이 매개 변수가 필요합니다.

형식:	String
Position:	Named
Default value:	None
필수:	False
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

-ProductId

기존 제품의 식별자를 지정합니다. 이 매개 변수를 지정하면 cmdlet은 제품 범위 정책을 설정합니다.

형식:	String
Position:	Named
Default value:	None
필수:	True
파이프라인 입력 허용:	True
와일드카드 문자 허용:	False

입력

PsApiManagementContext

String

SwitchParameter

출력

Boolean

관련 링크

• Get-AzApiManagementPolicy
• Remove-AzApiManagementPolicy