ApiTagDescription interface
ApiTagDescription을 나타내는 인터페이스입니다.
메서드
| create |
API의 범위에서 태그 설명을 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, Api |
API에 대한 태그 설명을 삭제합니다. |
| get(string, string, string, string, Api |
API scope 태그 설명 가져오기 |
| get |
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다. |
| list |
API의 범위에서 모든 태그 설명을 나열합니다. swagger와 유사한 모델 - tagDescription은 API 수준에서 정의되지만 태그는 작업에 할당될 수 있습니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
API의 범위에서 태그 설명을 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagDescriptionId
-
string
태그 설명 식별자입니다. API/태그 연결에 대한 tagDescription을 만들 때 사용됩니다. API 및 태그 이름을 기반으로 합니다.
- parameters
- TagDescriptionCreateParameters
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
API에 대한 태그 설명을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagDescriptionId
-
string
태그 설명 식별자입니다. API/태그 연결에 대한 tagDescription을 만들 때 사용됩니다. API 및 태그 이름을 기반으로 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
API scope 태그 설명 가져오기
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagDescriptionId
-
string
태그 설명 식별자입니다. API/태그 연결에 대한 tagDescription을 만들 때 사용됩니다. API 및 태그 이름을 기반으로 합니다.
옵션 매개 변수입니다.
반환
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- tagDescriptionId
-
string
태그 설명 식별자입니다. API/태그 연결에 대한 tagDescription을 만들 때 사용됩니다. API 및 태그 이름을 기반으로 합니다.
옵션 매개 변수입니다.
반환
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
API의 범위에서 모든 태그 설명을 나열합니다. swagger와 유사한 모델 - tagDescription은 API 수준에서 정의되지만 태그는 작업에 할당될 수 있습니다.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
옵션 매개 변수입니다.