Product - Update
기존 제품 세부 정보를 업데이트합니다.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2021-08-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
product
|
path | True |
string |
제품 ID입니다. 현재 API Management 서비스 instance 고유해야 합니다. |
resource
|
path | True |
string |
리소스 그룹의 이름. |
service
|
path | True |
string |
API Management 서비스의 이름입니다. regex 패턴: |
subscription
|
path | True |
string |
Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다. |
api-version
|
query | True |
string |
클라이언트 요청과 함께 사용할 API의 버전입니다. |
요청 헤더
Name | 필수 | 형식 | Description |
---|---|---|---|
If-Match | True |
string |
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 조건부 업데이트의 경우 *여야 합니다. |
요청 본문
Name | 형식 | Description |
---|---|---|
properties.approvalRequired |
boolean |
구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.description |
string |
제품 설명. HTML 서식 지정 태그를 포함할 수 있습니다. |
properties.displayName |
string |
제품 이름입니다. |
properties.state |
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다. |
|
properties.subscriptionRequired |
boolean |
이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. |
properties.subscriptionsLimit |
integer |
사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.terms |
string |
제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
제품이 성공적으로 업데이트되었습니다. 헤더 ETag: string |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
ApiManagementUpdateProduct
샘플 요청
샘플 응답
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct",
"type": "Microsoft.ApiManagement/service/products",
"name": "testproduct",
"properties": {
"displayName": "Test Template ProductName 4",
"description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
"subscriptionRequired": true,
"approvalRequired": true,
"subscriptionsLimit": 1,
"state": "published"
}
}
정의
Name | Description |
---|---|
Error |
오류 필드 계약. |
Error |
오류 응답. |
Product |
제품 세부 정보. |
Product |
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다. |
Product |
제품 업데이트 매개 변수. |
ErrorFieldContract
오류 필드 계약.
Name | 형식 | Description |
---|---|---|
code |
string |
속성 수준 오류 코드입니다. |
message |
string |
사람이 읽을 수 있는 속성 수준 오류 표현입니다. |
target |
string |
속성 이름입니다. |
ErrorResponse
오류 응답.
Name | 형식 | Description |
---|---|---|
error.code |
string |
서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다. |
error.details |
유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다. |
|
error.message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
ProductContract
제품 세부 정보.
Name | 형식 | Description |
---|---|---|
id |
string |
리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
리소스의 이름입니다. |
properties.approvalRequired |
boolean |
구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.description |
string |
제품 설명. HTML 서식 지정 태그를 포함할 수 있습니다. |
properties.displayName |
string |
제품 이름입니다. |
properties.state |
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다. |
|
properties.subscriptionRequired |
boolean |
이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. |
properties.subscriptionsLimit |
integer |
사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.terms |
string |
제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. |
type |
string |
리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" |
ProductState
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다.
Name | 형식 | Description |
---|---|---|
notPublished |
string |
|
published |
string |
ProductUpdateParameters
제품 업데이트 매개 변수.
Name | 형식 | Description |
---|---|---|
properties.approvalRequired |
boolean |
구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.description |
string |
제품 설명. HTML 서식 지정 태그를 포함할 수 있습니다. |
properties.displayName |
string |
제품 이름입니다. |
properties.state |
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 게시되지 않습니다. |
|
properties.subscriptionRequired |
boolean |
이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다. true이면 제품을 "보호됨"이라고 하며 제품에 포함된 API에 대한 요청이 성공하려면 유효한 구독 키가 필요합니다. false이면 제품을 "열기"라고 하며 제품에 포함된 API에 대한 요청은 구독 키 없이 수행할 수 있습니다. 새 제품을 만들 때 속성을 생략하면 값이 true로 간주됩니다. |
properties.subscriptionsLimit |
integer |
사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다. |
properties.terms |
string |
제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다. |