Remove-AzApiManagementApiFromGateway
게이트웨이에 API를 연결합니다.
Syntax
Remove-AzApiManagementApiFromGateway
-Context <PsApiManagementContext>
-GatewayId <String>
-ApiId <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Remove-AzApiManagementApiFromGateway cmdlet은 API를 게이트웨이에 연결합니다.
예제
예제 1: 게이트웨이에서 API 제거
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001" -PassThru
이 명령은 게이트웨이에서 지정된 API를 제거합니다.
예제 2: 관리되는 게이트웨이에서 API 제거
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "managed" -ApiId "0001" -PassThru
이 명령은 관리되는 게이트웨이에서 지정된 API를 제거합니다.
매개 변수
-ApiId
게이트웨이에서 제거할 기존 API의 식별자입니다. 이 매개 변수는 필수입니다.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
PsApiManagementContext의 인스턴스입니다. 이 매개 변수는 필수입니다.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Azure와의 통신에 사용되는 자격 증명, 계정, 테넌트 및 구독입니다.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GatewayId
API를 제거할 기존 게이트웨이의 식별자입니다. 이 매개 변수는 필수입니다.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
지정한 경우 작업이 성공하는 경우 true를 작성합니다. 이 매개 변수는 선택 사항입니다. 기본값은 거짓입니다.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |