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