New-AzApiManagementSubscription
구독을 만듭니다.
구문
New-AzApiManagementSubscription
-Context <PsApiManagementContext>
[-SubscriptionId <String>]
-Name <String>
-UserId <String>
-ProductId <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-AllowTracing]
[-State <PsApiManagementSubscriptionState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] New-AzApiManagementSubscription
-Context <PsApiManagementContext>
[-SubscriptionId <String>]
-Name <String>
[-UserId <String>]
-Scope <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-AllowTracing]
[-State <PsApiManagementSubscriptionState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
New-AzApiManagementSubscription cmdlet은 구독을 만듭니다.
예제
예제 1: 제품 사용자 구독
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"이 명령은 기존 사용자를 제품에 구독합니다.
예제 2: 모든 API 범위에 대한 구독 만들기
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"예제 3: 제품 범위에 대한 구독 만들기
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"매개 변수
-AllowTracing
구독 수준에서 추적을 사용할 수 있는지 여부를 결정하는 플래그입니다. 선택적 매개 변수이며 기본값은 $null.
| 형식: | SwitchParameter |
| 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 |
-Name
구독 이름을 지정합니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | True |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-PrimaryKey
구독 기본 키를 지정합니다. 이 매개 변수를 지정하지 않으면 키가 자동으로 생성됩니다. 이 매개 변수의 길이는 1~256자여야 합니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | False |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-ProductId
구독할 제품의 ID를 지정합니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | True |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-Scope
Api Scope /api/{apiId} 또는 Product Scope /products/{productId} 또는 Global API Scope /api 또는 Global scope /이든 구독의 범위입니다. 이 매개 변수는 필수입니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | True |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-SecondaryKey
구독 보조 키를 지정합니다. 이 매개 변수는 지정되지 않은 경우 자동으로 생성됩니다. 이 매개 변수의 길이는 1~256자여야 합니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | False |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-State
구독 상태를 지정합니다. 기본값은 $Null.
| 형식: | Nullable<T>[PsApiManagementSubscriptionState] |
| 허용되는 값: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Position: | Named |
| Default value: | None |
| 필수: | False |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-SubscriptionId
구독 ID를 지정합니다. 지정하지 않으면 이 매개 변수가 생성됩니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | False |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
-UserId
구독자 ID를 지정합니다.
| 형식: | String |
| Position: | Named |
| Default value: | None |
| 필수: | True |
| 파이프라인 입력 허용: | True |
| 와일드카드 문자 허용: | False |
입력
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]