다음을 통해 공유

New-AzApiManagementApi

  • 참조
모듈:
Az.ApiManagement

API를 만듭니다.

Syntax

New-AzApiManagementApi
   -Context <PsApiManagementContext>
   [-ApiId <String>]
   -Name <String>
   [-Description <String>]
   -ServiceUrl <String>
   -Path <String>
   -Protocols <PsApiManagementSchema[]>
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-ProductIds <String[]>]
   [-SubscriptionRequired]
   [-ApiVersionDescription <String>]
   [-ApiVersionSetId <String>]
   [-ApiVersion <String>]
   [-SourceApiId <String>]
   [-SourceApiRevision <String>]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

New-AzApiManagementApi cmdlet은 Azure API Management API를 만듭니다.

예제

예제 1: API 만들기

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"

이 명령은 지정된 URL을 사용하여 EchoApi라는 API를 만듭니다.

예제 2: echo-api에서 ApiVersionSet으로 모든 작업, 태그, 제품 및 정책을 복사하여 API 만들기

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"

ApiId                         : 691b7d410125414a929c108541c60e06
Name                          : echoapiv4
Description                   : Create Echo Api V4
ServiceUrl                    : https://echoapi.cloudapp.net/v4
Path                          : echov3
ApiType                       : http
Protocols                     : {Http, Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v4
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          : True
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

이 명령은 ApiVersionSet xmsVersionSet 에서 API echoapiv3 를 만들고 원본 APIecho-api에서 모든 작업, 태그 및 정책을 복사합니다. SubscriptionRequired, ServiceUrl, Path, Protocols를 재정의합니다.

예 3

API를 만듭니다. (자동 생성됨)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

매개 변수

-ApiId

만들 API의 ID를 지정합니다. 이 매개 변수를 지정하지 않으면 이 cmdlet은 ID를 생성합니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApiType

만들 API 유형(http, soap, websocket, graphql)입니다. 이 매개 변수는 선택 사항입니다.

Type:Nullable<T>[PsApiManagementApiType]
Accepted values:Http, Soap, WebSocket, GraphQL
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApiVersion

만들 API의 API 버전입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApiVersionDescription

API 버전 설명입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApiVersionSetId

관련 Api 버전 집합에 대한 리소스 식별자입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationScope

OAuth 작업 범위를 지정합니다. 기본값은 $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationServerId

OAuth 권한 부여 서버 ID를 지정합니다. 기본값은 $Null. AuthorizationScope가 지정된 경우 이 매개 변수를 지정해야 합니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-BearerTokenSendingMethod

액세스 토큰이 API에 전달되는 OpenId 권한 부여 서버 메커니즘입니다. https://datatracker.ietf.org/doc/html/rfc6749#section-4을 참조하세요. 이 매개 변수는 선택 사항입니다. 기본값은 $null.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactEmail

연락처/조직의 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactName

연락처/조직의 식별 이름입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactUrl

연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-Description

웹 API에 대한 설명을 지정합니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LicenseName

API에 사용되는 라이선스 이름입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LicenseUrl

API에 대한 서비스 약관에 대한 URL입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

웹 API의 이름을 지정합니다. 개발자 및 관리 포털에 표시되는 API의 공용 이름입니다.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OpenIdProviderId

OpenId 권한 부여 서버 식별자입니다. 이 매개 변수는 선택 사항입니다. 기본값은 $null. BearerTokenSendingMethods가 지정된 경우 지정해야 합니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Path

API 공용 URL의 마지막 부분이며 관리 포털의 Web API URL 접미사 필드에 해당하는 웹 API 경로를 지정합니다. 이 URL은 API 소비자가 웹 서비스에 요청을 보내는 데 사용되며 길이는 1~400자여야 합니다. 기본값은 $Null.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProductIds

새 API를 추가할 제품 ID의 배열을 지정합니다.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Protocols

웹 API 프로토콜의 배열을 지정합니다. 유효한 값은 http, https입니다. API를 사용할 수 있게 되는 웹 프로토콜입니다. 기본값은 $Null.

Type:PsApiManagementSchema[]
Accepted values:Http, Https, Ws, Wss
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServiceUrl

API를 노출하는 웹 서비스의 URL을 지정합니다. 이 URL은 Azure API Management에서만 사용되며 공개되지 않습니다. URL 길이는 1~2000자여야 합니다.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SourceApiId

원본 API의 API 식별자입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SourceApiRevision

원본 API의 API 수정 버전입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyHeaderName

구독 키 헤더 이름을 지정합니다. 기본값은 $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyQueryParamName

구독 키 쿼리 문자열 매개 변수 이름을 지정합니다. 기본값은 $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

API에 대한 요청에 SubscriptionRequired를 적용하는 플래그입니다. 이 매개 변수는 선택 사항입니다.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TermsOfServiceUrl

API에 대한 서비스 약관에 대한 URL입니다. 이 매개 변수는 선택 사항입니다.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

입력

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

출력

PsApiManagementApi