기존 API Management 서비스를 업데이트.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2022-08-01
URI 매개 변수
| Name |
In(다음 안에) |
필수 |
형식 |
Description |
|
resourceGroupName
|
path |
True
|
string
|
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
|
|
serviceName
|
path |
True
|
string
|
API Management 서비스의 이름입니다.
regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
대상 구독의 ID입니다.
|
|
api-version
|
query |
True
|
string
|
이 작업에 사용할 API 버전입니다.
|
요청 본문
| Name |
형식 |
Description |
|
identity
|
ApiManagementServiceIdentity
|
Api Management 서비스의 관리 서비스 ID입니다.
|
|
properties.additionalLocations
|
AdditionalLocation[]
|
API Management 서비스의 추가 데이터 센터 위치입니다.
|
|
properties.apiVersionConstraint
|
ApiVersionConstraint
|
API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
|
|
properties.certificates
|
CertificateConfiguration[]
|
API Management 서비스에 설치해야 하는 인증서 목록입니다. 설치할 수 있는 지원되는 최대 인증서는 10개입니다.
|
|
properties.customProperties
|
object
|
API Management 서비스의 사용자 지정 속성입니다.
를 설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 하면 모든 TLS(1.0, 1.1 및 1.2)에 대한 암호 TLS_RSA_WITH_3DES_EDE_CBC_SHA 비활성화됩니다.
TLS 1.1만 사용하지 않도록 설정하는 데 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 사용할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 사용하여 API Management 서비스에서 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 사용하여 백 엔드와의 통신에 TLS 1.1만 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 사용하여 백 엔드와의 통신에 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 사용하여 API Management 서비스에서 HTTP2 프로토콜을 사용하도록 설정할 수 있습니다.
PATCH 작업에서 이러한 속성을 지정하지 않으면 생략된 속성의 값이 기본값으로 다시 설정됩니다. Http2를 제외한 모든 설정의 기본값은 서비스가 2018년 4월 1일 또는 그 이전에 만들어진 경우이고 False 그렇지 않으면 입니다True. Http2 설정의 기본값은 입니다 False.
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]사용하여 다음 암호화를 사용하지 않도록 설정할 수 있습니다. TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. 예: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 기본값은 해당 값입니다 true .
참고: 내부 플랫폼 구성 요소에 필요하므로 다음 암호화를 사용하지 않도록 설정할 수 없습니다. TLS_AES_256_GCM_SHA384, TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
|
|
properties.disableGateway
|
boolean
|
속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. master 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.
|
|
properties.enableClientCertificate
|
boolean
|
속성은 소비 SKU 서비스에만 사용됩니다. 이렇게 하면 게이트웨이에 대한 각 요청에 표시되는 클라이언트 인증서가 적용됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증할 수도 있습니다.
|
|
properties.hostnameConfigurations
|
HostnameConfiguration[]
|
API Management 서비스의 사용자 지정 호스트 이름 구성입니다.
|
|
properties.natGatewayState
|
NatGatewayState
|
속성을 사용하여 이 API Management 서비스에 NAT Gateway를 사용하도록 설정할 수 있습니다.
|
|
properties.notificationSenderEmail
|
string
|
알림을 보낼 Email 주소입니다.
|
|
properties.privateEndpointConnections
|
RemotePrivateEndpointConnectionWrapper[]
|
이 서비스의 프라이빗 엔드포인트 연결 목록입니다.
|
|
properties.publicIpAddressId
|
string
|
지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 프리미엄 SKU에 대해서만 지원됩니다.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
이 API Management 서비스에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달되는 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
|
|
properties.publisherEmail
|
string
|
게시자 전자 메일.
|
|
properties.publisherName
|
string
|
게시자 이름입니다.
|
|
properties.restore
|
boolean
|
이전에 일시 삭제된 경우 Api Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성은 무시됩니다.
|
|
properties.virtualNetworkConfiguration
|
VirtualNetworkConfiguration
|
API Management 서비스의 가상 네트워크 구성입니다.
|
|
properties.virtualNetworkType
|
VirtualNetworkType
|
API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 포함되지 않음을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 설정됩니다.
|
|
sku
|
ApiManagementServiceSkuProperties
|
API Management 서비스의 SKU 속성입니다.
|
|
tags
|
object
|
리소스 태그.
|
|
zones
|
string[]
|
리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.
|
응답
보안
azure_auth
Azure Active Directory OAuth2 Flow.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name |
Description |
|
user_impersonation
|
사용자 계정 가장
|
예제
ApiManagementUpdateServiceDisableTls10
샘플 요청
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01
{
"properties": {
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
}
}
}
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import java.util.HashMap;
import java.util.Map;
/** Samples for ApiManagementService Update. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
*/
/**
* Sample code: ApiManagementUpdateServiceDisableTls10.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementUpdateServiceDisableTls10(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
ApiManagementServiceResource resource =
manager
.apiManagementServices()
.getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
.getValue();
resource
.update()
.withCustomProperties(
mapOf("Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10", "false"))
.apply();
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_update_service_disable_tls10.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.api_management_service.begin_update(
resource_group_name="rg1",
service_name="apimService1",
parameters={
"properties": {
"customProperties": {"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"}
}
},
).result()
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceDisableTls10() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
Properties: &armapimanagement.ServiceUpdateProperties{
CustomProperties: map[string]*string{
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
},
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ServiceResource = armapimanagement.ServiceResource{
// Name: to.Ptr("apimService1"),
// Type: to.Ptr("Microsoft.ApiManagement/service"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
// Tags: map[string]*string{
// "Owner": to.Ptr("sasolank"),
// "Pool": to.Ptr("Manual"),
// "Reserved": to.Ptr(""),
// "TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
// "TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
// "UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
// },
// Etag: to.Ptr("AAAAAAAYRPs="),
// Location: to.Ptr("West US"),
// Properties: &armapimanagement.ServiceProperties{
// CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
// CustomProperties: map[string]*string{
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
// },
// GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
// HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
// },
// ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
// NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
// PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
// ProvisioningState: to.Ptr("Succeeded"),
// PublicIPAddresses: []*string{
// to.Ptr("40.86.176.232")},
// ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
// TargetProvisioningState: to.Ptr(""),
// VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
// PublisherEmail: to.Ptr("admin@live.com"),
// PublisherName: to.Ptr("Contoso"),
// },
// SKU: &armapimanagement.ServiceSKUProperties{
// Name: to.Ptr(armapimanagement.SKUTypeStandard),
// Capacity: to.Ptr[int32](1),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing API Management service.
*
* @summary Updates an existing API Management service.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
*/
async function apiManagementUpdateServiceDisableTls10() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const parameters = {
customProperties: {
microsoftWindowsAzureApiManagementGatewaySecurityProtocolsTls10: "false",
},
};
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.apiManagementService.beginUpdateAndWait(
resourceGroupName,
serviceName,
parameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;
// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceDisableTls10.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);
// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
CustomProperties =
{
["Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"] = "false",
},
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
샘플 응답
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "sasolank",
"UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
"Reserved": "",
"TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
"Pool": "Manual",
"TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
},
"location": "West US",
"etag": "AAAAAAAYRPs=",
"properties": {
"publisherEmail": "admin@live.com",
"publisherName": "Contoso",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2017-06-29T17:50:42.3191122Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"portalUrl": "https://apimService1.portal.azure-api.net",
"managementApiUrl": "https://apimService1.management.azure-api.net",
"scmUrl": "https://apimService1.scm.azure-api.net",
"hostnameConfigurations": [],
"publicIPAddresses": [
"40.86.176.232"
],
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
},
"virtualNetworkType": "None"
},
"sku": {
"name": "Standard",
"capacity": 1
}
}
ApiManagementUpdateServicePublisherDetails
샘플 요청
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01
{
"properties": {
"publisherEmail": "foobar@live.com",
"publisherName": "Contoso Vnext"
}
}
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import java.util.HashMap;
import java.util.Map;
/** Samples for ApiManagementService Update. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
*/
/**
* Sample code: ApiManagementUpdateServicePublisherDetails.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementUpdateServicePublisherDetails(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
ApiManagementServiceResource resource =
manager
.apiManagementServices()
.getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
.getValue();
resource.update().withPublisherEmail("foobar@live.com").withPublisherName("Contoso Vnext").apply();
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_update_service_publisher_details.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.api_management_service.begin_update(
resource_group_name="rg1",
service_name="apimService1",
parameters={"properties": {"publisherEmail": "foobar@live.com", "publisherName": "Contoso Vnext"}},
).result()
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServicePublisherDetails() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
Properties: &armapimanagement.ServiceUpdateProperties{
PublisherEmail: to.Ptr("foobar@live.com"),
PublisherName: to.Ptr("Contoso Vnext"),
},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ServiceResource = armapimanagement.ServiceResource{
// Name: to.Ptr("apimService1"),
// Type: to.Ptr("Microsoft.ApiManagement/service"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
// Tags: map[string]*string{
// "Owner": to.Ptr("sasolank"),
// "Pool": to.Ptr("Manual"),
// "Reserved": to.Ptr(""),
// "TestExpiration": to.Ptr("Thu, 29 Jun 2017 18:50:40 GMT"),
// "TestSuiteExpiration": to.Ptr("Thu, 29 Jun 2017 18:51:46 GMT"),
// "UID": to.Ptr("4f5025fe-0669-4e2e-8320-5199466e5eb3"),
// },
// Etag: to.Ptr("AAAAAAAYRPs="),
// Location: to.Ptr("West US"),
// Properties: &armapimanagement.ServiceProperties{
// CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-29T17:50:42.319Z"); return t}()),
// CustomProperties: map[string]*string{
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("False"),
// },
// GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
// HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
// },
// ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
// NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
// PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
// ProvisioningState: to.Ptr("Succeeded"),
// PublicIPAddresses: []*string{
// to.Ptr("40.86.176.232")},
// ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
// TargetProvisioningState: to.Ptr(""),
// VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
// PublisherEmail: to.Ptr("foobar@live.com"),
// PublisherName: to.Ptr("Contoso Vnext"),
// },
// SKU: &armapimanagement.ServiceSKUProperties{
// Name: to.Ptr(armapimanagement.SKUTypeStandard),
// Capacity: to.Ptr[int32](1),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing API Management service.
*
* @summary Updates an existing API Management service.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
*/
async function apiManagementUpdateServicePublisherDetails() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const parameters = {
publisherEmail: "foobar@live.com",
publisherName: "Contoso Vnext",
};
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.apiManagementService.beginUpdateAndWait(
resourceGroupName,
serviceName,
parameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;
// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServicePublisherDetails.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);
// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
PublisherEmail = "foobar@live.com",
PublisherName = "Contoso Vnext",
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
샘플 응답
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {
"Owner": "sasolank",
"UID": "4f5025fe-0669-4e2e-8320-5199466e5eb3",
"Reserved": "",
"TestExpiration": "Thu, 29 Jun 2017 18:50:40 GMT",
"Pool": "Manual",
"TestSuiteExpiration": "Thu, 29 Jun 2017 18:51:46 GMT"
},
"location": "West US",
"etag": "AAAAAAAYRPs=",
"properties": {
"publisherEmail": "foobar@live.com",
"publisherName": "Contoso Vnext",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2017-06-29T17:50:42.3191122Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"portalUrl": "https://apimService1.portal.azure-api.net",
"managementApiUrl": "https://apimService1.management.azure-api.net",
"scmUrl": "https://apimService1.scm.azure-api.net",
"hostnameConfigurations": [],
"publicIPAddresses": [
"40.86.176.232"
],
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False"
},
"virtualNetworkType": "None"
},
"sku": {
"name": "Standard",
"capacity": 1
}
}
ApiManagementUpdateServiceToNewVnetAndAvailabilityZones
샘플 요청
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2022-08-01
{
"properties": {
"additionalLocations": [
{
"location": "Australia East",
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
},
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
},
"virtualNetworkType": "External",
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"
},
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
]
}
import com.azure.resourcemanager.apimanagement.models.AdditionalLocation;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceResource;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceSkuProperties;
import com.azure.resourcemanager.apimanagement.models.SkuType;
import com.azure.resourcemanager.apimanagement.models.VirtualNetworkConfiguration;
import com.azure.resourcemanager.apimanagement.models.VirtualNetworkType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/** Samples for ApiManagementService Update. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
*/
/**
* Sample code: ApiManagementUpdateServiceToNewVnetAndAvailabilityZones.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementUpdateServiceToNewVnetAndAvailabilityZones(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
ApiManagementServiceResource resource =
manager
.apiManagementServices()
.getByResourceGroupWithResponse("rg1", "apimService1", com.azure.core.util.Context.NONE)
.getValue();
resource
.update()
.withSku(new ApiManagementServiceSkuProperties().withName(SkuType.PREMIUM).withCapacity(3))
.withZones(Arrays.asList("1", "2", "3"))
.withPublicIpAddressId(
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east")
.withVirtualNetworkConfiguration(
new VirtualNetworkConfiguration()
.withSubnetResourceId(
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"))
.withAdditionalLocations(
Arrays
.asList(
new AdditionalLocation()
.withLocation("Australia East")
.withSku(new ApiManagementServiceSkuProperties().withName(SkuType.PREMIUM).withCapacity(3))
.withZones(Arrays.asList("1", "2", "3"))
.withPublicIpAddressId(
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip")
.withVirtualNetworkConfiguration(
new VirtualNetworkConfiguration()
.withSubnetResourceId(
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"))))
.withVirtualNetworkType(VirtualNetworkType.EXTERNAL)
.apply();
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from typing import Any, IO, Union
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_update_service_to_new_vnet_and_azs.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.api_management_service.begin_update(
resource_group_name="rg1",
service_name="apimService1",
parameters={
"properties": {
"additionalLocations": [
{
"location": "Australia East",
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
"sku": {"capacity": 3, "name": "Premium"},
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
},
"zones": ["1", "2", "3"],
}
],
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
},
"virtualNetworkType": "External",
},
"sku": {"capacity": 3, "name": "Premium"},
"zones": ["1", "2", "3"],
},
).result()
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
func ExampleServiceClient_BeginUpdate_apiManagementUpdateServiceToNewVnetAndAvailabilityZones() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewServiceClient().BeginUpdate(ctx, "rg1", "apimService1", armapimanagement.ServiceUpdateParameters{
Properties: &armapimanagement.ServiceUpdateProperties{
AdditionalLocations: []*armapimanagement.AdditionalLocation{
{
Location: to.Ptr("Australia East"),
PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
SKU: &armapimanagement.ServiceSKUProperties{
Name: to.Ptr(armapimanagement.SKUTypePremium),
Capacity: to.Ptr[int32](3),
},
VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
},
Zones: []*string{
to.Ptr("1"),
to.Ptr("2"),
to.Ptr("3")},
}},
PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
},
VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
},
SKU: &armapimanagement.ServiceSKUProperties{
Name: to.Ptr(armapimanagement.SKUTypePremium),
Capacity: to.Ptr[int32](3),
},
Zones: []*string{
to.Ptr("1"),
to.Ptr("2"),
to.Ptr("3")},
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ServiceResource = armapimanagement.ServiceResource{
// Name: to.Ptr("apimService1"),
// Type: to.Ptr("Microsoft.ApiManagement/service"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
// Etag: to.Ptr("AAAAAAAWBIU="),
// Location: to.Ptr("Japan East"),
// Properties: &armapimanagement.ServiceProperties{
// AdditionalLocations: []*armapimanagement.AdditionalLocation{
// {
// DisableGateway: to.Ptr(false),
// GatewayRegionalURL: to.Ptr("https://apimService1-australiaeast-01.regional.azure-api.net"),
// Location: to.Ptr("Australia East"),
// PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
// PublicIPAddresses: []*string{
// to.Ptr("20.213.1.35")},
// PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
// SKU: &armapimanagement.ServiceSKUProperties{
// Name: to.Ptr(armapimanagement.SKUTypePremium),
// Capacity: to.Ptr[int32](3),
// },
// VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
// SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
// },
// Zones: []*string{
// to.Ptr("1"),
// to.Ptr("2"),
// to.Ptr("3")},
// }},
// CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-08T23:41:35.644Z"); return t}()),
// CustomProperties: map[string]*string{
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
// "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("false"),
// },
// DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
// DisableGateway: to.Ptr(false),
// GatewayRegionalURL: to.Ptr("https://apimService1-japaneast-01.regional.azure-api.net"),
// GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
// HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
// {
// Type: to.Ptr(armapimanagement.HostnameTypeProxy),
// CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
// DefaultSSLBinding: to.Ptr(false),
// HostName: to.Ptr("apimService1.azure-api.net"),
// NegotiateClientCertificate: to.Ptr(false),
// },
// {
// Type: to.Ptr(armapimanagement.HostnameTypeProxy),
// Certificate: &armapimanagement.CertificateInformation{
// Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-09T23:59:59.000Z"); return t}()),
// Subject: to.Ptr("CN=mycustomdomain.int-azure-api.net"),
// Thumbprint: to.Ptr("2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD"),
// },
// CertificateSource: to.Ptr(armapimanagement.CertificateSourceManaged),
// DefaultSSLBinding: to.Ptr(true),
// HostName: to.Ptr("mycustomdomain.int-azure-api.net"),
// NegotiateClientCertificate: to.Ptr(false),
// }},
// ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
// NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
// PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
// PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
// ProvisioningState: to.Ptr("Succeeded"),
// PublicIPAddresses: []*string{
// to.Ptr("20.78.248.217")},
// PublicIPAddressID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
// PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
// ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
// TargetProvisioningState: to.Ptr(""),
// VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
// SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
// },
// VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeInternal),
// PublisherEmail: to.Ptr("contoso@microsoft.com"),
// PublisherName: to.Ptr("apimPublisher"),
// },
// SKU: &armapimanagement.ServiceSKUProperties{
// Name: to.Ptr(armapimanagement.SKUTypePremium),
// Capacity: to.Ptr[int32](3),
// },
// SystemData: &armapimanagement.SystemData{
// LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-21T20:04:21.610Z"); return t}()),
// LastModifiedBy: to.Ptr("contoso@microsoft.com"),
// LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
// },
// Zones: []*string{
// to.Ptr("1"),
// to.Ptr("2"),
// to.Ptr("3")},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing API Management service.
*
* @summary Updates an existing API Management service.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
*/
async function apiManagementUpdateServiceToNewVnetAndAvailabilityZones() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const parameters = {
additionalLocations: [
{
location: "Australia East",
publicIpAddressId:
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
sku: { name: "Premium", capacity: 3 },
virtualNetworkConfiguration: {
subnetResourceId:
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default",
},
zones: ["1", "2", "3"],
},
],
publicIpAddressId:
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
sku: { name: "Premium", capacity: 3 },
virtualNetworkConfiguration: {
subnetResourceId:
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2",
},
virtualNetworkType: "External",
zones: ["1", "2", "3"],
};
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.apiManagementService.beginUpdateAndWait(
resourceGroupName,
serviceName,
parameters
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ApiManagement;
// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateServiceToNewVnetAndAZs.json
// this example is just showing the usage of "ApiManagementService_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);
// invoke the operation
ApiManagementServicePatch patch = new ApiManagementServicePatch()
{
Sku = new ApiManagementServiceSkuProperties(ApiManagementServiceSkuType.Premium, 3),
Zones =
{
"1","2","3"
},
PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east"),
VirtualNetworkConfiguration = new VirtualNetworkConfiguration()
{
SubnetResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"),
},
AdditionalLocations =
{
new AdditionalLocation(new AzureLocation("Australia East"),new ApiManagementServiceSkuProperties(ApiManagementServiceSkuType.Premium,3))
{
Zones =
{
"1","2","3"
},
PublicIPAddressId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip"),
VirtualNetworkConfiguration = new VirtualNetworkConfiguration()
{
SubnetResourceId = new ResourceIdentifier("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"),
},
}
},
VirtualNetworkType = VirtualNetworkType.External,
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.UpdateAsync(WaitUntil.Completed, patch);
ApiManagementServiceResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
샘플 응답
Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2022-08-01&asyncResponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"location": "Japan East",
"etag": "AAAAAAAWBIU=",
"properties": {
"publisherEmail": "contoso@microsoft.com",
"publisherName": "apimPublisher",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2021-04-08T23:41:35.6447381Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-japaneast-01.regional.azure-api.net",
"portalUrl": "https://apimService1.portal.azure-api.net",
"developerPortalUrl": "https://apimService1.developer.azure-api.net",
"managementApiUrl": "https://apimService1.management.azure-api.net",
"scmUrl": "https://apimService1.scm.azure-api.net",
"hostnameConfigurations": [
{
"type": "Proxy",
"hostName": "apimService1.azure-api.net",
"negotiateClientCertificate": false,
"defaultSslBinding": false,
"certificateSource": "BuiltIn"
},
{
"type": "Proxy",
"hostName": "mycustomdomain.int-azure-api.net",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2022-06-09T23:59:59+00:00",
"thumbprint": "2994B5FFB8F76B3C687D324A8DEE0432C1ED18CD",
"subject": "CN=mycustomdomain.int-azure-api.net"
},
"defaultSslBinding": true,
"certificateSource": "Managed"
}
],
"publicIPAddresses": [
"20.78.248.217"
],
"additionalLocations": [
{
"location": "Australia East",
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
],
"publicIPAddresses": [
"20.213.1.35"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimaeavnet/subnets/default"
},
"gatewayRegionalUrl": "https://apimService1-australiaeast-01.regional.azure-api.net",
"disableGateway": false,
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/apim-australia-east-publicip",
"platformVersion": "stv2"
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet-apim-japaneast/subnets/apim2"
},
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
},
"virtualNetworkType": "Internal",
"disableGateway": false,
"publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicip-apim-japan-east",
"publicNetworkAccess": "Enabled",
"platformVersion": "stv2"
},
"sku": {
"name": "Premium",
"capacity": 3
},
"zones": [
"1",
"2",
"3"
],
"systemData": {
"lastModifiedBy": "contoso@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2022-01-21T20:04:21.6108974Z"
}
}
정의
AdditionalLocation
추가 API Management 리소스 위치에 대한 설명입니다.
| Name |
형식 |
Default value |
Description |
|
disableGateway
|
boolean
|
False
|
속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 이 추가 위치에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.
|
|
gatewayRegionalUrl
|
string
|
|
지역에서 API Management 서비스의 게이트웨이 URL입니다.
|
|
location
|
string
|
|
Azure 데이터 센터 지역 중 추가 지역의 위치 이름입니다.
|
|
natGatewayState
|
NatGatewayState
|
Disabled
|
속성을 사용하여 이 API Management 서비스에 NAT Gateway를 사용하도록 설정할 수 있습니다.
|
|
outboundPublicIPAddresses
|
string[]
|
|
NAT Gateway 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다.
|
|
platformVersion
|
PlatformVersion
|
|
서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
|
|
privateIPAddresses
|
string[]
|
|
특정 추가 위치의 내부 Virtual Network 배포되는 API Management 서비스의 프라이빗 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
publicIPAddresses
|
string[]
|
|
추가 위치에 있는 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
publicIpAddressId
|
string
|
|
위치에 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 프리미엄 SKU에 대해서만 지원됩니다.
|
|
sku
|
ApiManagementServiceSkuProperties
|
|
API Management 서비스의 SKU 속성입니다.
|
|
virtualNetworkConfiguration
|
VirtualNetworkConfiguration
|
|
위치에 대한 가상 네트워크 구성입니다.
|
|
zones
|
string[]
|
|
리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.
|
ApiManagementServiceIdentity
Api Management 서비스 리소스의 ID 속성입니다.
| Name |
형식 |
Description |
|
principalId
|
string
|
ID의 보안 주체 ID입니다.
|
|
tenantId
|
string
|
ID의 클라이언트 테넌트 ID입니다.
|
|
type
|
ApimIdentityType
|
리소스에 사용되는 ID 유형입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.
|
|
userAssignedIdentities
|
<string,
UserIdentityProperties>
|
리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.
|
ApiManagementServiceResource
응답 나열 또는 가져오기의 단일 API Management 서비스 리소스입니다.
| Name |
형식 |
Default value |
Description |
|
etag
|
string
|
|
리소스의 ETag입니다.
|
|
id
|
string
|
|
리소스 ID입니다.
|
|
identity
|
ApiManagementServiceIdentity
|
|
Api Management 서비스의 관리 서비스 ID입니다.
|
|
location
|
string
|
|
리소스 위치.
|
|
name
|
string
|
|
리소스 이름입니다.
|
|
properties.additionalLocations
|
AdditionalLocation[]
|
|
API Management 서비스의 추가 데이터 센터 위치입니다.
|
|
properties.apiVersionConstraint
|
ApiVersionConstraint
|
|
API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
|
|
properties.certificates
|
CertificateConfiguration[]
|
|
API Management 서비스에 설치해야 하는 인증서 목록입니다. 설치할 수 있는 지원되는 최대 인증서는 10개입니다.
|
|
properties.createdAtUtc
|
string
|
|
API Management 서비스의 생성 UTC 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
|
|
properties.customProperties
|
object
|
|
API Management 서비스의 사용자 지정 속성입니다.
를 설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 하면 모든 TLS(1.0, 1.1 및 1.2)에 대한 암호 TLS_RSA_WITH_3DES_EDE_CBC_SHA 비활성화됩니다.
TLS 1.1만 사용하지 않도록 설정하는 데 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 사용할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 사용하여 API Management 서비스에서 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 사용하여 백 엔드와의 통신에 TLS 1.1만 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 사용하여 백 엔드와의 통신에 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 사용하여 API Management 서비스에서 HTTP2 프로토콜을 사용하도록 설정할 수 있습니다.
PATCH 작업에서 이러한 속성을 지정하지 않으면 생략된 속성의 값이 기본값으로 다시 설정됩니다. Http2를 제외한 모든 설정의 기본값은 서비스가 2018년 4월 1일 또는 그 이전에 만들어진 경우이고 False 그렇지 않으면 입니다True. Http2 설정의 기본값은 입니다 False.
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]사용하여 다음 암호화를 사용하지 않도록 설정할 수 있습니다. TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. 예: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 기본값은 해당 값입니다 true .
참고: 내부 플랫폼 구성 요소에 필요하므로 다음 암호화를 사용하지 않도록 설정할 수 없습니다. TLS_AES_256_GCM_SHA384, TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
|
|
properties.developerPortalUrl
|
string
|
|
API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다.
|
|
properties.disableGateway
|
boolean
|
False
|
속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. master 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.
|
|
properties.enableClientCertificate
|
boolean
|
False
|
속성은 소비 SKU 서비스에만 사용됩니다. 이렇게 하면 게이트웨이에 대한 각 요청에 표시되는 클라이언트 인증서가 적용됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증할 수도 있습니다.
|
|
properties.gatewayRegionalUrl
|
string
|
|
기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다.
|
|
properties.gatewayUrl
|
string
|
|
API Management 서비스의 게이트웨이 URL입니다.
|
|
properties.hostnameConfigurations
|
HostnameConfiguration[]
|
|
API Management 서비스의 사용자 지정 호스트 이름 구성입니다.
|
|
properties.managementApiUrl
|
string
|
|
API Management 서비스의 관리 API 엔드포인트 URL입니다.
|
|
properties.natGatewayState
|
NatGatewayState
|
Disabled
|
속성을 사용하여 이 API Management 서비스에 NAT Gateway를 사용하도록 설정할 수 있습니다.
|
|
properties.notificationSenderEmail
|
string
|
|
알림을 보낼 Email 주소입니다.
|
|
properties.outboundPublicIPAddresses
|
string[]
|
|
NAT Gateway 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다.
|
|
properties.platformVersion
|
PlatformVersion
|
|
이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
|
|
properties.portalUrl
|
string
|
|
API Management 서비스의 게시자 포털 엔드포인트 URL입니다.
|
|
properties.privateEndpointConnections
|
RemotePrivateEndpointConnectionWrapper[]
|
|
이 서비스의 프라이빗 엔드포인트 연결 목록입니다.
|
|
properties.privateIPAddresses
|
string[]
|
|
내부 Virtual Network 배포되는 주 지역의 API Management 서비스의 프라이빗 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
properties.provisioningState
|
string
|
|
생성/활성화/성공/업데이트/실패/중지/종료/Terminating/TerminatFailed/Deleted 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다.
|
|
properties.publicIPAddresses
|
string[]
|
|
주 지역의 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
properties.publicIpAddressId
|
string
|
|
지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 프리미엄 SKU에 대해서만 지원됩니다.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
|
이 API Management 서비스에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달되는 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
|
|
properties.publisherEmail
|
string
|
|
게시자 전자 메일.
|
|
properties.publisherName
|
string
|
|
게시자 이름입니다.
|
|
properties.restore
|
boolean
|
False
|
이전에 일시 삭제된 경우 Api Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성은 무시됩니다.
|
|
properties.scmUrl
|
string
|
|
API Management 서비스의 SCM 엔드포인트 URL입니다.
|
|
properties.targetProvisioningState
|
string
|
|
서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비저닝 상태입니다.
|
|
properties.virtualNetworkConfiguration
|
VirtualNetworkConfiguration
|
|
API Management 서비스의 가상 네트워크 구성입니다.
|
|
properties.virtualNetworkType
|
VirtualNetworkType
|
None
|
API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 포함되지 않음을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 설정됩니다.
|
|
sku
|
ApiManagementServiceSkuProperties
|
|
API Management 서비스의 SKU 속성입니다.
|
|
systemData
|
systemData
|
|
리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
|
|
tags
|
object
|
|
리소스 태그.
|
|
type
|
string
|
|
API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다.
|
|
zones
|
string[]
|
|
리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.
|
ApiManagementServiceSkuProperties
서비스 리소스 SKU 속성을 API Management.
| Name |
형식 |
Description |
|
capacity
|
integer
|
SKU의 용량(SKU의 배포된 단위 수). 소비 SKU 용량의 경우 0으로 지정해야 합니다.
|
|
name
|
SkuType
|
Sku의 이름입니다.
|
ApiManagementServiceUpdateParameters
업데이트 Api Management 서비스에 제공된 매개 변수입니다.
| Name |
형식 |
Default value |
Description |
|
etag
|
string
|
|
리소스의 ETag입니다.
|
|
id
|
string
|
|
리소스 ID입니다.
|
|
identity
|
ApiManagementServiceIdentity
|
|
Api Management 서비스의 관리 서비스 ID입니다.
|
|
name
|
string
|
|
리소스 이름입니다.
|
|
properties.additionalLocations
|
AdditionalLocation[]
|
|
API Management 서비스의 추가 데이터 센터 위치입니다.
|
|
properties.apiVersionConstraint
|
ApiVersionConstraint
|
|
API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
|
|
properties.certificates
|
CertificateConfiguration[]
|
|
API Management 서비스에 설치해야 하는 인증서 목록입니다. 설치할 수 있는 지원되는 최대 인증서는 10개입니다.
|
|
properties.createdAtUtc
|
string
|
|
API Management 서비스의 생성 UTC 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
|
|
properties.customProperties
|
object
|
|
API Management 서비스의 사용자 지정 속성입니다.
를 설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 하면 모든 TLS(1.0, 1.1 및 1.2)에 대한 암호 TLS_RSA_WITH_3DES_EDE_CBC_SHA 비활성화됩니다.
TLS 1.1만 사용하지 않도록 설정하는 데 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 사용할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 사용하여 API Management 서비스에서 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 사용하여 백 엔드와의 통신에 TLS 1.1만 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 사용하여 백 엔드와의 통신에 TLS 1.0을 사용하지 않도록 설정할 수 있습니다.
설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 사용하여 API Management 서비스에서 HTTP2 프로토콜을 사용하도록 설정할 수 있습니다.
PATCH 작업에서 이러한 속성을 지정하지 않으면 생략된 속성의 값이 기본값으로 다시 설정됩니다. Http2를 제외한 모든 설정의 기본값은 서비스가 2018년 4월 1일 또는 그 이전에 만들어진 경우이고 False 그렇지 않으면 입니다True. Http2 설정의 기본값은 입니다 False.
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256 설정을 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]사용하여 다음 암호화를 사용하지 않도록 설정할 수 있습니다. TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. 예: Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. 기본값은 해당 값입니다 true .
참고: 내부 플랫폼 구성 요소에 필요하므로 다음 암호화를 사용하지 않도록 설정할 수 없습니다. TLS_AES_256_GCM_SHA384, TLS_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
|
|
properties.developerPortalUrl
|
string
|
|
API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다.
|
|
properties.disableGateway
|
boolean
|
False
|
속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. master 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.
|
|
properties.enableClientCertificate
|
boolean
|
False
|
속성은 소비 SKU 서비스에만 사용됩니다. 이렇게 하면 게이트웨이에 대한 각 요청에 표시되는 클라이언트 인증서가 적용됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증할 수도 있습니다.
|
|
properties.gatewayRegionalUrl
|
string
|
|
기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다.
|
|
properties.gatewayUrl
|
string
|
|
API Management 서비스의 게이트웨이 URL입니다.
|
|
properties.hostnameConfigurations
|
HostnameConfiguration[]
|
|
API Management 서비스의 사용자 지정 호스트 이름 구성입니다.
|
|
properties.managementApiUrl
|
string
|
|
API Management 서비스의 관리 API 엔드포인트 URL입니다.
|
|
properties.natGatewayState
|
NatGatewayState
|
Disabled
|
속성을 사용하여 이 API Management 서비스에 NAT Gateway를 사용하도록 설정할 수 있습니다.
|
|
properties.notificationSenderEmail
|
string
|
|
알림을 보낼 Email 주소입니다.
|
|
properties.outboundPublicIPAddresses
|
string[]
|
|
NAT Gateway 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다.
|
|
properties.platformVersion
|
PlatformVersion
|
|
이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
|
|
properties.portalUrl
|
string
|
|
API Management 서비스의 게시자 포털 엔드포인트 URL입니다.
|
|
properties.privateEndpointConnections
|
RemotePrivateEndpointConnectionWrapper[]
|
|
이 서비스의 프라이빗 엔드포인트 연결 목록입니다.
|
|
properties.privateIPAddresses
|
string[]
|
|
내부 Virtual Network 배포되는 주 지역의 API Management 서비스의 프라이빗 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
properties.provisioningState
|
string
|
|
생성/활성화/성공/업데이트/실패/중지/종료/Terminating/TerminatFailed/Deleted 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다.
|
|
properties.publicIPAddresses
|
string[]
|
|
주 지역의 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
|
|
properties.publicIpAddressId
|
string
|
|
지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 프리미엄 SKU에 대해서만 지원됩니다.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
|
이 API Management 서비스에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달되는 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
|
|
properties.publisherEmail
|
string
|
|
게시자 전자 메일.
|
|
properties.publisherName
|
string
|
|
게시자 이름입니다.
|
|
properties.restore
|
boolean
|
False
|
이전에 일시 삭제된 경우 Api Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성은 무시됩니다.
|
|
properties.scmUrl
|
string
|
|
API Management 서비스의 SCM 엔드포인트 URL입니다.
|
|
properties.targetProvisioningState
|
string
|
|
서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비저닝 상태입니다.
|
|
properties.virtualNetworkConfiguration
|
VirtualNetworkConfiguration
|
|
API Management 서비스의 가상 네트워크 구성입니다.
|
|
properties.virtualNetworkType
|
VirtualNetworkType
|
None
|
API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 포함되지 않음을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 설정됩니다.
|
|
sku
|
ApiManagementServiceSkuProperties
|
|
API Management 서비스의 SKU 속성입니다.
|
|
tags
|
object
|
|
리소스 태그.
|
|
type
|
string
|
|
API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다.
|
|
zones
|
string[]
|
|
리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.
|
ApimIdentityType
리소스에 사용되는 ID 유형입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.
| Name |
형식 |
Description |
|
None
|
string
|
|
|
SystemAssigned
|
string
|
|
|
SystemAssigned, UserAssigned
|
string
|
|
|
UserAssigned
|
string
|
|
ApiVersionConstraint
API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
| Name |
형식 |
Description |
|
minApiVersion
|
string
|
컨트롤 플레인 API 호출을 이 값보다 같거나 최신 버전인 API Management 서비스로 제한합니다.
|
ArmIdWrapper
ARM 리소스 ID에 대한 래퍼
| Name |
형식 |
Description |
|
id
|
string
|
|
CertificateConfiguration
신뢰할 수 없는 중간 및 루트 인증서로 구성된 인증서 구성입니다.
| Name |
형식 |
Description |
|
certificate
|
CertificateInformation
|
인증서 정보입니다.
|
|
certificatePassword
|
string
|
인증서 암호입니다.
|
|
encodedCertificate
|
string
|
Base64 인코딩된 인증서입니다.
|
|
storeName
|
enum:
-
CertificateAuthority
-
Root
|
System.Security.Cryptography.x509certificates.StoreName 인증서 저장소 위치입니다. 루트 및 CertificateAuthority만 유효한 위치입니다.
|
SSL 인증서 정보입니다.
| Name |
형식 |
Description |
|
expiry
|
string
|
인증서의 만료 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
|
|
subject
|
string
|
인증서의 주체입니다.
|
|
thumbprint
|
string
|
인증서의 지문입니다.
|
CertificateSource
인증서 원본입니다.
| Name |
형식 |
Description |
|
BuiltIn
|
string
|
|
|
Custom
|
string
|
|
|
KeyVault
|
string
|
|
|
Managed
|
string
|
|
CertificateStatus
인증서 상태.
| Name |
형식 |
Description |
|
Completed
|
string
|
|
|
Failed
|
string
|
|
|
InProgress
|
string
|
|
createdByType
리소스를 만든 ID의 형식입니다.
| Name |
형식 |
Description |
|
Application
|
string
|
|
|
Key
|
string
|
|
|
ManagedIdentity
|
string
|
|
|
User
|
string
|
|
ErrorFieldContract
오류 필드 계약.
| Name |
형식 |
Description |
|
code
|
string
|
속성 수준 오류 코드입니다.
|
|
message
|
string
|
사람이 읽을 수 있는 속성 수준 오류 표현입니다.
|
|
target
|
string
|
속성 이름입니다.
|
ErrorResponse
오류 응답.
| Name |
형식 |
Description |
|
error.code
|
string
|
서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
|
|
error.details
|
ErrorFieldContract[]
|
유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
|
|
error.message
|
string
|
사람이 읽을 수 있는 오류 표현입니다.
|
HostnameConfiguration
사용자 지정 호스트 이름 구성.
| Name |
형식 |
Default value |
Description |
|
certificate
|
CertificateInformation
|
|
인증서 정보입니다.
|
|
certificatePassword
|
string
|
|
인증서 암호입니다.
|
|
certificateSource
|
CertificateSource
|
|
인증서 원본입니다.
|
|
certificateStatus
|
CertificateStatus
|
|
인증서 상태.
|
|
defaultSslBinding
|
boolean
|
False
|
true를 지정하여 이 호스트 이름과 연결된 인증서를 기본 SSL 인증서로 설정합니다. 클라이언트가 SNI 헤더를 보내지 않는 경우 이 문제는 인증서가 됩니다. 속성은 서비스에서 여러 사용자 지정 호스트 이름을 사용하도록 설정하고 기본 ssl 인증서를 결정해야 하는 경우에 유용합니다. 설정은 게이트웨이 호스트 이름 유형에만 적용됩니다.
|
|
encodedCertificate
|
string
|
|
Base64 인코딩된 인증서입니다.
|
|
hostName
|
string
|
|
Api Management 서비스에서 구성할 호스트 이름입니다.
|
|
identityClientId
|
string
|
|
SSL 인증서가 포함된 keyVault에 대한 GET 액세스 권한이 있는 Azure AD 생성된 시스템 또는 사용자 할당 관리 ID clientId입니다.
|
|
keyVaultId
|
string
|
|
Ssl 인증서를 포함하는 KeyVault 비밀에 대한 URL입니다. 버전이 포함된 절대 URL이 제공되면 ssl 인증서의 자동 업데이트가 작동하지 않습니다. 이를 위해서는 aka.ms/apimmsi Api Management 서비스를 구성해야 합니다. 비밀은 application/x-pkcs12 형식이어야 합니다.
|
|
negotiateClientCertificate
|
boolean
|
False
|
호스트 이름에 항상 클라이언트 인증서를 협상하려면 true를 지정합니다. 기본값은 false입니다.
|
|
type
|
HostnameType
|
|
호스트 이름 형식입니다.
|
HostnameType
호스트 이름 형식입니다.
| Name |
형식 |
Description |
|
DeveloperPortal
|
string
|
|
|
Management
|
string
|
|
|
Portal
|
string
|
|
|
Proxy
|
string
|
|
|
Scm
|
string
|
|
NatGatewayState
속성을 사용하여 이 API Management 서비스에 NAT Gateway를 사용하도록 설정할 수 있습니다.
| Name |
형식 |
Description |
|
Disabled
|
string
|
서비스에 대해 Nat Gateway를 사용할 수 없습니다.
|
|
Enabled
|
string
|
Nat Gateway는 서비스에 대해 사용하도록 설정됩니다.
|
서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
| Name |
형식 |
Description |
|
mtv1
|
string
|
다중 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.
|
|
stv1
|
string
|
단일 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.
|
|
stv2
|
string
|
단일 테넌트 V2 플랫폼에서 서비스를 실행하는 플랫폼입니다.
|
|
undetermined
|
string
|
컴퓨팅 플랫폼이 배포되지 않으므로 플랫폼 버전을 확인할 수 없습니다.
|
PrivateEndpointServiceConnectionStatus
프라이빗 엔드포인트 연결 상태.
| Name |
형식 |
Description |
|
Approved
|
string
|
|
|
Pending
|
string
|
|
|
Rejected
|
string
|
|
PrivateLinkServiceConnectionState
서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.
| Name |
형식 |
Description |
|
actionsRequired
|
string
|
서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
|
|
description
|
string
|
연결의 승인/거부 이유입니다.
|
|
status
|
PrivateEndpointServiceConnectionStatus
|
서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.
|
PublicNetworkAccess
이 API Management 서비스에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달되는 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
| Name |
형식 |
Description |
|
Disabled
|
string
|
|
|
Enabled
|
string
|
|
RemotePrivateEndpointConnectionWrapper
원격 프라이빗 엔드포인트 연결 리소스.
| Name |
형식 |
Description |
|
id
|
string
|
프라이빗 엔드포인트 연결 리소스 ID
|
|
name
|
string
|
프라이빗 엔드포인트 연결 이름
|
|
properties.groupIds
|
string[]
|
모든 그룹 ID입니다.
|
|
properties.privateEndpoint
|
ArmIdWrapper
|
프라이빗 엔드포인트의 리소스입니다.
|
|
properties.privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.
|
|
properties.provisioningState
|
string
|
프라이빗 엔드포인트 연결 리소스의 프로비저닝 상태입니다.
|
|
type
|
string
|
프라이빗 엔드포인트 연결 리소스 종류
|
SkuType
Sku의 이름입니다.
| Name |
형식 |
Description |
|
Basic
|
string
|
Api Management의 기본 SKU입니다.
|
|
Consumption
|
string
|
Api Management의 소비 SKU입니다.
|
|
Developer
|
string
|
Api Management의 개발자 SKU입니다.
|
|
Isolated
|
string
|
Api Management의 격리된 SKU입니다.
|
|
Premium
|
string
|
Api Management의 프리미엄 SKU입니다.
|
|
Standard
|
string
|
Api Management의 표준 SKU입니다.
|
systemData
리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
| Name |
형식 |
Description |
|
createdAt
|
string
|
UTC(리소스 만들기)의 타임스탬프입니다.
|
|
createdBy
|
string
|
리소스를 만든 ID입니다.
|
|
createdByType
|
createdByType
|
리소스를 만든 ID의 형식입니다.
|
|
lastModifiedAt
|
string
|
리소스 마지막 수정의 타임스탬프(UTC)
|
|
lastModifiedBy
|
string
|
리소스를 마지막으로 수정한 ID입니다.
|
|
lastModifiedByType
|
createdByType
|
리소스를 마지막으로 수정한 ID 유형입니다.
|
UserIdentityProperties
| Name |
형식 |
Description |
|
clientId
|
string
|
사용자 할당 ID의 클라이언트 ID입니다.
|
|
principalId
|
string
|
사용자 할당 ID의 보안 주체 ID입니다.
|
VirtualNetworkConfiguration
API Management 서비스가 배포되는 가상 네트워크의 구성입니다.
| Name |
형식 |
Description |
|
subnetResourceId
|
string
|
API Management 서비스를 배포할 가상 네트워크에 있는 서브넷의 전체 리소스 ID입니다.
|
|
subnetname
|
string
|
서브넷의 이름입니다.
|
|
vnetid
|
string
|
가상 네트워크 ID입니다. 일반적으로 GUID입니다. 기본적으로 null GUID를 예상합니다.
|
VirtualNetworkType
API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 포함되지 않음을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 설정됩니다.
| Name |
형식 |
Description |
|
External
|
string
|
이 서비스는 Virtual Network 일부이며 인터넷에서 액세스할 수 있습니다.
|
|
Internal
|
string
|
이 서비스는 Virtual Network 일부이며 가상 네트워크 내에서만 액세스할 수 있습니다.
|
|
None
|
string
|
서비스는 Virtual Network 일부가 아닙니다.
|