Tag interface
태그를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
assignToApi(string, string, string, string, TagAssignToApiOptionalParams)
API에 태그를 할당합니다.
function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagAssignToApiOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagAssignToApiResponse>
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)
작업에 태그를 할당합니다.
function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- operationId
-
string
API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<TagContract>
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)
제품에 태그를 할당합니다.
function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagAssignToProductOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagContract>
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)
태그를 만듭니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- parameters
- TagCreateUpdateParameters
매개 변수를 만듭니다.
- options
- TagCreateOrUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagCreateOrUpdateResponse>
delete(string, string, string, string, TagDeleteOptionalParams)
API Management 서비스 인스턴스의 특정 태그를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- TagDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)
API에서 태그를 분리합니다.
function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagDetachFromApiOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)
작업에서 태그를 분리합니다.
function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- operationId
-
string
API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)
제품에서 태그를 분리합니다.
function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, TagGetOptionalParams)
식별자가 지정한 태그의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagGetResponse>
getByApi(string, string, string, string, TagGetByApiOptionalParams)
API와 연결된 태그를 가져옵니다.
function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagGetByApiOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagGetByApiResponse>
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)
작업과 연결된 태그를 가져옵니다.
function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- operationId
-
string
API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagGetByOperationOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagGetByOperationResponse>
getByProduct(string, string, string, string, TagGetByProductOptionalParams)
Product와 연결된 태그를 가져옵니다.
function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagGetByProductOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagGetByProductResponse>
getEntityState(string, string, string, TagGetEntityStateOptionalParams)
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagGetEntityStateOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagGetEntityStateHeaders>
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<TagGetEntityStateByApiHeaders>
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- operationId
-
string
API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<TagGetEntityStateByOperationHeaders>
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<TagGetEntityStateByProductHeaders>
listByApi(string, string, string, TagListByApiOptionalParams)
API와 연결된 모든 태그를 나열합니다.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- options
- TagListByApiOptionalParams
옵션 매개 변수입니다.
반환
listByOperation(string, string, string, string, TagListByOperationOptionalParams)
작업과 연결된 모든 태그를 나열합니다.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- operationId
-
string
API 내의 작업 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagListByOperationOptionalParams
옵션 매개 변수입니다.
반환
listByProduct(string, string, string, TagListByProductOptionalParams)
제품과 연결된 모든 태그를 나열합니다.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- TagListByProductOptionalParams
옵션 매개 변수입니다.
반환
listByService(string, string, TagListByServiceOptionalParams)
서비스 인스턴스 내에 정의된 태그 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- options
- TagListByServiceOptionalParams
옵션 매개 변수입니다.
반환
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)
식별자가 지정한 태그의 세부 정보를 업데이트.
function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- tagId
-
string
태그 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- TagCreateUpdateParameters
매개 변수를 업데이트합니다.
- options
- TagUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<TagUpdateResponse>