GatewayApi interface
GatewayApi를 나타내는 인터페이스입니다.
메서드
| create |
지정된 게이트웨이에 API를 추가합니다. |
| delete(string, string, string, string, Gateway |
지정된 게이트웨이에서 지정된 API를 삭제합니다. |
| get |
식별자가 지정한 API 엔터티가 게이트웨이 엔터티와 연결되어 있는지 확인합니다. |
| list |
게이트웨이와 연결된 API의 컬렉션을 나열합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
지정된 게이트웨이에 API를 추가합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
지정된 게이트웨이에서 지정된 API를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- GatewayApiDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
식별자가 지정한 API 엔터티가 게이트웨이 엔터티와 연결되어 있는지 확인합니다.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- apiId
-
string
API ID입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
게이트웨이와 연결된 API의 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
옵션 매개 변수입니다.