다음을 통해 공유

Set-AzApiManagementSubscription

  • 참조
모듈:
Az.ApiManagement

기존 구독 세부 정보를 설정합니다.

Syntax

Set-AzApiManagementSubscription
   -InputObject <PsApiManagementSubscription>
   [-Scope <String>]
   [-UserId <String>]
   [-Name <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-State <PsApiManagementSubscriptionState>]
   [-ExpiresOn <DateTime>]
   [-StateComment <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementSubscription
   -Context <PsApiManagementContext>
   -SubscriptionId <String>
   [-Scope <String>]
   [-UserId <String>]
   [-Name <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-State <PsApiManagementSubscriptionState>]
   [-ExpiresOn <DateTime>]
   [-StateComment <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Set-AzApiManagementSubscription cmdlet은 기존 구독 세부 정보를 설정합니다.

예제

예제 1: 구독의 상태 및 기본 및 보조 키 설정

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"

이 명령은 구독에 대한 기본 및 보조 키를 설정하고 활성화합니다.

매개 변수

-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

-ExpiresOn

구독 만료 날짜를 지정합니다. 이 매개 변수의 기본값은 $Null.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

PsApiManagementSubscription의 인스턴스입니다. 이 매개 변수는 필수입니다.

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

-Name

구독 이름을 지정합니다.

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

-PassThru

Passthru

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

-PrimaryKey

구독 기본 키를 지정합니다. 이 매개 변수는 지정하지 않으면 자동으로 생성됩니다. 이 매개 변수의 길이는 1~300자여야 합니다.

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

-Scope

Api Scope /api/{apiId} 또는 Product Scope /products/{productId} 또는 Global API Scope /api 또는 Global scope /이든 구독의 범위입니다. 이 매개 변수는 필수입니다.

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

-SecondaryKey

구독 보조 키를 지정합니다. 이 매개 변수는 지정하지 않으면 자동으로 생성됩니다. 이 매개 변수의 길이는 1~300자여야 합니다.

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

-State

구독 상태를 지정합니다. 이 매개 변수의 기본값은 $Null.

Type:Nullable<T>[PsApiManagementSubscriptionState]
Accepted values:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StateComment

구독 상태 주석을 지정합니다. 이 매개 변수의 기본값은 $Null.

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

-SubscriptionId

구독 ID를 지정합니다.

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

-UserId

구독의 소유자입니다. 이 매개 변수는 선택 사항입니다.

Type:String
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

입력

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

SwitchParameter

출력

PsApiManagementSubscription