Workspace Api - Update

서비스:: API Management

API 버전:: 2024-05-01

API Management 서비스 인스턴스에서 작업 영역의 지정된 API를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}?api-version=2024-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match	True	string	엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

요청 본문

Name	형식	Description
properties.apiRevision	string minLength: 1 maxLength: 100	API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.
properties.apiRevisionDescription	string maxLength: 256	API 수정 버전에 대한 설명입니다.
properties.apiVersion	string maxLength: 100	API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.
properties.apiVersionDescription	string maxLength: 256	API 버전에 대한 설명입니다.
properties.apiVersionSetId	string	관련 ApiVersionSet에 대한 리소스 식별자입니다.
properties.authenticationSettings	AuthenticationSettingsContract	이 API에 포함된 인증 설정의 컬렉션입니다.
properties.contact	ApiContactInformation	API에 대한 연락처 정보입니다.
properties.description	string	API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
properties.displayName	string minLength: 1 maxLength: 300	API 이름입니다.
properties.isCurrent	boolean	API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.
properties.license	ApiLicenseInformation	API에 대한 라이선스 정보입니다.
properties.path	string minLength: 0 maxLength: 400	이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다.
properties.protocols	Protocol[]	이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.
properties.serviceUrl	string minLength: 1 maxLength: 2000	이 API를 구현하는 백 엔드 서비스의 절대 URL입니다.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API를 사용할 수 있는 프로토콜입니다.
properties.subscriptionRequired	boolean	API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.
properties.termsOfServiceUrl	string	API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.
properties.type	ApiType	API의 유형입니다.

응답

Name	형식	Description
200 OK	ApiContract	API가 성공적으로 업데이트되었습니다. 헤더 ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

ApiContract

API가 성공적으로 업데이트되었습니다.

헤더

ETag: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementUpdateWorkspaceApi

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api?api-version=2024-05-01


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

정의

Name	Description
ApiContactInformation	API 연락처 정보
ApiContract	API 세부 정보입니다.
ApiLicenseInformation	API 라이선스 정보
ApiType	API의 유형입니다.
ApiUpdateContract	API 업데이트 계약 세부 정보입니다.
ApiVersionSetContractDetails	API 버전 집합에는 관련된 API 버전 집합에 대한 공통 구성이 포함되어 있습니다.
AuthenticationSettingsContract	API 인증 설정.
bearerTokenSendingMethods	서버에 토큰을 보내는 방법입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
OAuth2AuthenticationSettingsContract	API OAuth2 인증 설정 세부 정보입니다.
OpenIdAuthenticationSettingsContract	API OAuth2 인증 설정 세부 정보입니다.
Protocol	이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.
SubscriptionKeyParameterNamesContract	구독 키 매개 변수 이름 세부 정보입니다.
versioningScheme	HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다.

ApiContactInformation

Object

API 연락처 정보

Name	형식	Description
email	string	연락처/조직의 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다.
name	string	연락처/조직의 식별 이름
url	string	연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다.

ApiContract

Object

API 세부 정보입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.apiRevision	string minLength: 1 maxLength: 100	API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.
properties.apiRevisionDescription	string maxLength: 256	API 수정 버전에 대한 설명입니다.
properties.apiVersion	string maxLength: 100	API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.
properties.apiVersionDescription	string maxLength: 256	API 버전에 대한 설명입니다.
properties.apiVersionSet	ApiVersionSetContractDetails	버전 집합 세부 정보
properties.apiVersionSetId	string	관련 ApiVersionSet에 대한 리소스 식별자입니다.
properties.authenticationSettings	AuthenticationSettingsContract	이 API에 포함된 인증 설정의 컬렉션입니다.
properties.contact	ApiContactInformation	API에 대한 연락처 정보입니다.
properties.description	string	API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
properties.displayName	string minLength: 1 maxLength: 300	API 이름입니다. 길이는 1~300자여야 합니다.
properties.isCurrent	boolean	API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.
properties.isOnline	boolean	게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다.
properties.license	ApiLicenseInformation	API에 대한 라이선스 정보입니다.
properties.path	string minLength: 0 maxLength: 400	이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다.
properties.protocols	Protocol[]	이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.
properties.provisioningState	string	프로비저닝 상태
properties.serviceUrl	string minLength: 0 maxLength: 2000	이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다.
properties.sourceApiId	string	원본 API의 API 식별자입니다.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API를 사용할 수 있는 프로토콜입니다.
properties.subscriptionRequired	boolean	API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.
properties.termsOfServiceUrl	string	API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.
properties.type	ApiType	API의 유형입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

API 라이선스 정보

Name	형식	Description
name	string	API에 사용되는 라이선스 이름
url	string	API에 사용되는 라이선스의 URL입니다. URL 형식이어야 합니다.

ApiType

열거형

API의 유형입니다.

값	Description
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Object

API 업데이트 계약 세부 정보입니다.

Name	형식	Description
properties.apiRevision	string minLength: 1 maxLength: 100	API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.
properties.apiRevisionDescription	string maxLength: 256	API 수정 버전에 대한 설명입니다.
properties.apiVersion	string maxLength: 100	API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.
properties.apiVersionDescription	string maxLength: 256	API 버전에 대한 설명입니다.
properties.apiVersionSetId	string	관련 ApiVersionSet에 대한 리소스 식별자입니다.
properties.authenticationSettings	AuthenticationSettingsContract	이 API에 포함된 인증 설정의 컬렉션입니다.
properties.contact	ApiContactInformation	API에 대한 연락처 정보입니다.
properties.description	string	API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
properties.displayName	string minLength: 1 maxLength: 300	API 이름입니다.
properties.isCurrent	boolean	API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.
properties.isOnline	boolean	게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다.
properties.license	ApiLicenseInformation	API에 대한 라이선스 정보입니다.
properties.path	string minLength: 0 maxLength: 400	이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다.
properties.protocols	Protocol[]	이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.
properties.serviceUrl	string minLength: 1 maxLength: 2000	이 API를 구현하는 백 엔드 서비스의 절대 URL입니다.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API를 사용할 수 있는 프로토콜입니다.
properties.subscriptionRequired	boolean	API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.
properties.termsOfServiceUrl	string	API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.
properties.type	ApiType	API의 유형입니다.

ApiVersionSetContractDetails

Object

API 버전 집합에는 관련된 API 버전 집합에 대한 공통 구성이 포함되어 있습니다.

Name	형식	Description
description	string	API 버전 집합에 대한 설명입니다.
id	string	기존 API 버전 집합의 식별자입니다. 새 버전 집합을 만들려면 이 값을 생략합니다.
name	string	API 버전 집합의 표시 이름입니다.
versionHeaderName	string	versioningScheme이 `header`설정된 경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다.
versionQueryName	string	versioningScheme이 `query`설정된 경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다.
versioningScheme	versioningScheme	HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다.

AuthenticationSettingsContract

Object

API 인증 설정.

Name	형식	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 인증 설정
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	이 API에 포함된 OAuth2 인증 설정의 컬렉션입니다.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect 인증 설정
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	이 API에 포함된 Open ID Connect 인증 설정의 컬렉션입니다.

bearerTokenSendingMethods

열거형

서버에 토큰을 보내는 방법입니다.

값	Description
authorizationHeader	전달자 스키마를 사용하여 권한 부여 헤더에 액세스 토큰이 전송됩니다.
query	액세스 토큰은 쿼리 매개 변수로 전송됩니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

OAuth2AuthenticationSettingsContract

Object

API OAuth2 인증 설정 세부 정보입니다.

Name	형식	Description
authorizationServerId	string	OAuth 권한 부여 서버 식별자입니다.
scope	string	작업 범위입니다.

OpenIdAuthenticationSettingsContract

Object

API OAuth2 인증 설정 세부 정보입니다.

Name	형식	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	서버에 토큰을 보내는 방법입니다.
openidProviderId	string	OAuth 권한 부여 서버 식별자입니다.

Protocol

열거형

이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.

값	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

구독 키 매개 변수 이름 세부 정보입니다.

Name	형식	Description
header	string	구독 키 헤더 이름입니다.
query	string	구독 키 쿼리 문자열 매개 변수 이름입니다.

versioningScheme

열거형

HTTP 요청에 API 버전 식별자를 배치할 위치를 결정하는 값입니다.

값	Description
Segment	API 버전은 경로 세그먼트에 전달됩니다.
Query	API 버전은 쿼리 매개 변수에 전달됩니다.
Header	API 버전은 HTTP 헤더에 전달됩니다.

다음을 통해 공유

Workspace Api - Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementUpdateWorkspaceApi

샘플 요청

샘플 응답

정의

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme