Subscription interface
구독을 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
지정된 제품에 대해 지정된 사용자의 구독을 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
- parameters
- SubscriptionCreateParameters
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
지정된 구독을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- SubscriptionDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
지정된 구독 엔터티를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
- options
- SubscriptionGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
식별자가 지정한 apimanagement 구독의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
옵션 매개 변수입니다.
반환
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
API Management 서비스 인스턴스의 모든 구독을 나열합니다.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- options
- SubscriptionListOptionalParams
옵션 매개 변수입니다.
반환
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
지정된 구독 키를 가져옵니다.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
옵션 매개 변수입니다.
반환
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
API Management 서비스 인스턴스의 기존 구독에서 기본 키를 다시 생성합니다.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
옵션 매개 변수입니다.
반환
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
API Management 서비스 인스턴스에서 기존 구독의 보조 키를 다시 생성합니다.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
옵션 매개 변수입니다.
반환
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
식별자가 지정한 구독의 세부 정보를 업데이트.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- sid
-
string
구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- SubscriptionUpdateParameters
매개 변수를 업데이트합니다.
- options
- SubscriptionUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<SubscriptionUpdateResponse>