Api Management Service - Update

기존 API Management 서비스를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2021-12-01-preview

URI 매개 변수

Name In Required Type Description
resourceGroupName
path True
  • string

리소스 그룹의 이름.

serviceName
path True
  • string

API Management 서비스의 이름입니다.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True
  • string

클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 본문

Name Type Description
identity

Api Management 서비스의 관리 서비스 ID입니다.

properties.additionalLocations

API Management 서비스의 추가 데이터 센터 위치입니다.

properties.apiVersionConstraint

API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.

properties.certificates

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 사용하지 않도록 설정합니다.
설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 은 TLS 1.1만 사용하지 않도록 설정하는 데 사용할 수 있습니다.
설정을 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 . 참고: 다음 암호는 Azure CloudService 내부 구성 요소(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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.disableGateway
  • boolean

속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 마스터 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.

properties.enableClientCertificate
  • boolean

소비 SKU 서비스에만 사용되는 속성입니다. 이렇게 하면 게이트웨이에 대한 각 요청에 대해 클라이언트 인증서가 표시됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용할 수 있습니다.

properties.hostnameConfigurations

API Management 서비스의 사용자 지정 호스트 이름 구성입니다.

properties.notificationSenderEmail
  • string

알림을 보낼 전자 메일 주소입니다.

properties.privateEndpointConnections

이 서비스의 프라이빗 엔드포인트 연결 목록입니다.

properties.publicIpAddressId
  • string

지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 Premium SKU에 대해서만 지원됩니다.

properties.publicNetworkAccess

이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 배타적 액세스 방법입니다. 기본값은 'Enabled'입니다.

properties.publisherEmail
  • string

전자 메일을 Publisher.

properties.publisherName
  • string

게시자 이름입니다.

properties.restore
  • boolean

이전에 일시 삭제된 경우 API Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성이 무시됩니다.

properties.virtualNetworkConfiguration

API Management 서비스의 가상 네트워크 구성입니다.

properties.virtualNetworkType

API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에 설정됩니다.

sku

API Management 서비스의 SKU 속성입니다.

tags
  • object

리소스 태그.

zones
  • string[]

리소스가 필요한 위치를 나타내는 가용성 영역 목록입니다.

응답

Name Type Description
200 OK

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

202 Accepted

서비스 업데이트 요청이 수락되었습니다.

Other Status Codes

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

보안

azure_auth

OAuth2 Flow Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementUpdateServiceDisableTls10
ApiManagementUpdateServicePublisherDetails
ApiManagementUpdateServiceToNewVnetAndAvailabilityZones

ApiManagementUpdateServiceDisableTls10

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "properties": {
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false"
    }
  }
}

Sample Response

{
  "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

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "properties": {
    "publisherEmail": "foobar@live.com",
    "publisherName": "Contoso Vnext"
  }
}

Sample Response

{
  "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

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2021-12-01-preview

{
  "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"
  ]
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/TGV2eTExMDZtMDJfVGVybV9jMmZlY2QwMA==?api-version=2021-12-01-preview
{
  "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 리소스 위치에 대한 설명입니다.

ApiManagementServiceIdentity

Api Management 서비스 리소스의 ID 속성입니다.

ApiManagementServiceResource

목록 또는 가져오기 응답의 단일 API Management 서비스 리소스입니다.

ApiManagementServiceSkuProperties

API Management 서비스 리소스 SKU 속성입니다.

ApiManagementServiceUpdateParameters

업데이트 API Management 서비스에 제공된 매개 변수입니다.

ApimIdentityType

리소스에 사용되는 ID의 형식입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.

ApiVersionConstraint

API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.

ArmIdWrapper

ARM 리소스 ID에 대한 래퍼

CertificateConfiguration

신뢰할 수 없는 중간 및 루트 인증서로 구성된 인증서 구성입니다.

CertificateInformation

SSL 인증서 정보입니다.

CertificateSource

인증서 원본입니다.

CertificateStatus

인증서 상태.

createdByType

리소스를 만든 ID의 형식입니다.

ErrorFieldContract

오류 필드 계약입니다.

ErrorResponse

오류 응답입니다.

HostnameConfiguration

사용자 지정 호스트 이름 구성입니다.

HostnameType

호스트 이름 형식입니다.

PlatformVersion

서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.

PrivateEndpointServiceConnectionStatus

프라이빗 엔드포인트 연결 상태입니다.

PrivateLinkServiceConnectionState

서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.

PublicNetworkAccess

이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 배타적 액세스 방법입니다. 기본값은 'Enabled'입니다.

RemotePrivateEndpointConnectionWrapper

원격 프라이빗 엔드포인트 연결 리소스입니다.

SkuType

SKU의 이름입니다.

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

UserIdentityProperties
VirtualNetworkConfiguration

API Management 서비스가 배포되는 가상 네트워크의 구성입니다.

VirtualNetworkType

API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에 설정됩니다.

AdditionalLocation

추가 API Management 리소스 위치에 대한 설명입니다.

Name Type Default Value Description
disableGateway
  • boolean
False

속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 이 추가 위치에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.

gatewayRegionalUrl
  • string

지역에 있는 API Management 서비스의 게이트웨이 URL입니다.

location
  • string

Azure 데이터 센터 지역 간의 추가 지역의 위치 이름입니다.

platformVersion

서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.

privateIPAddresses
  • string[]

특정 추가 위치의 내부 Virtual Network 배포되는 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

publicIPAddresses
  • string[]

추가 위치에 있는 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

publicIpAddressId
  • string

위치에 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 Premium SKU에 대해서만 지원됩니다.

sku

API Management 서비스의 SKU 속성입니다.

virtualNetworkConfiguration

위치에 대한 가상 네트워크 구성입니다.

zones
  • string[]

리소스가 필요한 위치를 나타내는 가용성 영역 목록입니다.

ApiManagementServiceIdentity

Api Management 서비스 리소스의 ID 속성입니다.

Name Type Description
principalId
  • string

ID의 보안 주체 ID입니다.

tenantId
  • string

ID의 클라이언트 테넌트 ID입니다.

type

리소스에 사용되는 ID의 형식입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.

userAssignedIdentities

리소스와 연결된 사용자 ID 목록입니다. 사용자 ID 사전 키 참조는 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' 형식의 ARM 리소스 ID입니다.

ApiManagementServiceResource

목록 또는 가져오기 응답의 단일 API Management 서비스 리소스입니다.

Name Type Default Value Description
etag
  • string

리소스의 ETag입니다.

id
  • string

리소스 ID입니다.

identity

Api Management 서비스의 관리 서비스 ID입니다.

location
  • string

리소스 위치.

name
  • string

리소스 이름입니다.

properties.additionalLocations

API Management 서비스의 추가 데이터 센터 위치입니다.

properties.apiVersionConstraint

API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.

properties.certificates

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 사용하지 않도록 설정합니다.
설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 은 TLS 1.1만 사용하지 않도록 설정하는 데 사용할 수 있습니다.
설정을 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 . 참고: 다음 암호는 Azure CloudService 내부 구성 요소(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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다.

properties.disableGateway
  • boolean
False

속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 마스터 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.

properties.enableClientCertificate
  • boolean
False

소비 SKU 서비스에만 사용되는 속성입니다. 이렇게 하면 게이트웨이에 대한 각 요청에 대해 클라이언트 인증서가 표시됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용할 수 있습니다.

properties.gatewayRegionalUrl
  • string

기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다.

properties.gatewayUrl
  • string

API Management 서비스의 게이트웨이 URL입니다.

properties.hostnameConfigurations

API Management 서비스의 사용자 지정 호스트 이름 구성입니다.

properties.managementApiUrl
  • string

API Management 서비스의 관리 API 엔드포인트 URL입니다.

properties.notificationSenderEmail
  • string

알림을 보낼 전자 메일 주소입니다.

properties.platformVersion

이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.

properties.portalUrl
  • string

API Management 서비스의 포털 엔드포인트 URL을 Publisher.

properties.privateEndpointConnections

이 서비스의 프라이빗 엔드포인트 연결 목록입니다.

properties.privateIPAddresses
  • string[]

내부 Virtual Network 배포되는 주 지역의 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

properties.provisioningState
  • string

생성/활성화/성공/업데이트/실패/중지/종료/종료/삭제 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다.

properties.publicIPAddresses
  • string[]

주 지역의 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

properties.publicIpAddressId
  • string

지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 Premium SKU에 대해서만 지원됩니다.

properties.publicNetworkAccess

이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 배타적 액세스 방법입니다. 기본값은 'Enabled'입니다.

properties.publisherEmail
  • string

전자 메일을 Publisher.

properties.publisherName
  • string

게시자 이름입니다.

properties.restore
  • boolean
False

이전에 일시 삭제된 경우 API Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성이 무시됩니다.

properties.scmUrl
  • string

API Management 서비스의 SCM 엔드포인트 URL입니다.

properties.targetProvisioningState
  • string

서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비전 상태입니다.

properties.virtualNetworkConfiguration

API Management 서비스의 가상 네트워크 구성입니다.

properties.virtualNetworkType None

API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에 설정됩니다.

sku

API Management 서비스의 SKU 속성입니다.

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

tags
  • object

리소스 태그.

type
  • string

API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다.

zones
  • string[]

리소스가 필요한 위치를 나타내는 가용성 영역 목록입니다.

ApiManagementServiceSkuProperties

API Management 서비스 리소스 SKU 속성입니다.

Name Type Description
capacity
  • integer

SKU의 용량(SKU의 배포된 단위 수)입니다. 소비 SKU 용량의 경우 0으로 지정해야 합니다.

name

SKU의 이름입니다.

ApiManagementServiceUpdateParameters

업데이트 API Management 서비스에 제공된 매개 변수입니다.

Name Type Default Value Description
etag
  • string

리소스의 ETag입니다.

id
  • string

리소스 ID입니다.

identity

Api Management 서비스의 관리 서비스 ID입니다.

name
  • string

리소스 이름입니다.

properties.additionalLocations

API Management 서비스의 추가 데이터 센터 위치입니다.

properties.apiVersionConstraint

API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.

properties.certificates

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 사용하지 않도록 설정합니다.
설정 Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 은 TLS 1.1만 사용하지 않도록 설정하는 데 사용할 수 있습니다.
설정을 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 . 참고: 다음 암호는 Azure CloudService 내부 구성 요소(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,TLS_RSA_WITH_AES_256_GCM_SHA384

properties.developerPortalUrl
  • string

API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다.

properties.disableGateway
  • boolean
False

속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 마스터 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.

properties.enableClientCertificate
  • boolean
False

소비 SKU 서비스에만 사용되는 속성입니다. 이렇게 하면 게이트웨이에 대한 각 요청에 대해 클라이언트 인증서가 표시됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용할 수 있습니다.

properties.gatewayRegionalUrl
  • string

기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다.

properties.gatewayUrl
  • string

API Management 서비스의 게이트웨이 URL입니다.

properties.hostnameConfigurations

API Management 서비스의 사용자 지정 호스트 이름 구성입니다.

properties.managementApiUrl
  • string

API Management 서비스의 관리 API 엔드포인트 URL입니다.

properties.notificationSenderEmail
  • string

알림을 보낼 전자 메일 주소입니다.

properties.platformVersion

이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.

properties.portalUrl
  • string

API Management 서비스의 포털 엔드포인트 URL을 Publisher.

properties.privateEndpointConnections

이 서비스의 프라이빗 엔드포인트 연결 목록입니다.

properties.privateIPAddresses
  • string[]

내부 Virtual Network 배포되는 주 지역의 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

properties.provisioningState
  • string

생성/활성화/성공/업데이트/실패/중지/종료/종료/삭제 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다.

properties.publicIPAddresses
  • string[]

주 지역의 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, Premium 및 격리된 SKU에만 사용할 수 있습니다.

properties.publicIpAddressId
  • string

지역에서 Virtual Network 배포된 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network 배포되는 개발자 및 Premium SKU에 대해서만 지원됩니다.

properties.publicNetworkAccess

이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 배타적 액세스 방법입니다. 기본값은 'Enabled'입니다.

properties.publisherEmail
  • string

전자 메일을 Publisher.

properties.publisherName
  • string

게시자 이름입니다.

properties.restore
  • boolean
False

이전에 일시 삭제된 경우 API Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성이 무시됩니다.

properties.scmUrl
  • string

API Management 서비스의 SCM 엔드포인트 URL입니다.

properties.targetProvisioningState
  • string

서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비전 상태입니다.

properties.virtualNetworkConfiguration

API Management 서비스의 가상 네트워크 구성입니다.

properties.virtualNetworkType None

API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 API Management 배포는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에 설정됩니다.

sku

API Management 서비스의 SKU 속성입니다.

tags
  • object

리소스 태그.

type
  • string

API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다.

zones
  • string[]

리소스가 필요한 위치를 나타내는 가용성 영역 목록입니다.

ApimIdentityType

리소스에 사용되는 ID의 형식입니다. ‘SystemAssigned, UserAssigned’ 유형에는 암시적으로 만들어진 ID와 사용자 할당 ID 세트가 모두 포함되어 있습니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ApiVersionConstraint

API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.

Name Type Description
minApiVersion
  • string

컨트롤 플레인 API 호출을 이 값보다 같거나 최신 버전의 API Management 서비스로 제한합니다.

ArmIdWrapper

ARM 리소스 ID에 대한 래퍼

Name Type Description
id
  • string

CertificateConfiguration

신뢰할 수 없는 중간 및 루트 인증서로 구성된 인증서 구성입니다.

Name Type Description
certificate

인증서 정보입니다.

certificatePassword
  • string

인증서 암호입니다.

encodedCertificate
  • string

Base64로 인코딩된 인증서입니다.

storeName enum:
  • CertificateAuthority
  • Root

System.Security.Cryptography.x509certificates.StoreName 인증서 저장소 위치입니다. 루트 및 CertificateAuthority만 유효한 위치입니다.

CertificateInformation

SSL 인증서 정보입니다.

Name Type Description
expiry
  • string

인증서의 만료 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.

subject
  • string

인증서의 주체입니다.

thumbprint
  • string

인증서의 지문입니다.

CertificateSource

인증서 원본입니다.

Name Type Description
BuiltIn
  • string
Custom
  • string
KeyVault
  • string
Managed
  • string

CertificateStatus

인증서 상태.

Name Type Description
Completed
  • string
Failed
  • string
InProgress
  • string

createdByType

리소스를 만든 ID의 형식입니다.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorFieldContract

오류 필드 계약입니다.

Name Type Description
code
  • string

속성 수준 오류 코드입니다.

message
  • string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target
  • string

속성 이름입니다.

ErrorResponse

오류 응답입니다.

Name Type Description
error.code
  • string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.

error.message
  • string

사람이 읽을 수 있는 오류 표현입니다.

HostnameConfiguration

사용자 지정 호스트 이름 구성입니다.

Name Type Default Value Description
certificate

인증서 정보입니다.

certificatePassword
  • string

인증서 암호입니다.

certificateSource

인증서 원본입니다.

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 인증서의 자동 업데이트가 작동하지 않습니다. 이렇게 하려면 Api Management 서비스를 aka.ms/apimmsi 구성해야 합니다. 비밀은 application/x-pkcs12 형식이어야 합니다.

negotiateClientCertificate
  • boolean
False

호스트 이름에서 항상 클라이언트 인증서를 협상하려면 true를 지정합니다. 기본값은 false입니다.

type

호스트 이름 형식입니다.

HostnameType

호스트 이름 형식입니다.

Name Type Description
DeveloperPortal
  • string
Management
  • string
Portal
  • string
Proxy
  • string
Scm
  • string

PlatformVersion

서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.

Name Type Description
mtv1
  • string

다중 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.

stv1
  • string

단일 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.

stv2
  • string

단일 테넌트 V2 플랫폼에서 서비스를 실행하는 플랫폼입니다.

undetermined
  • string

컴퓨팅 플랫폼이 배포되지 않았으므로 플랫폼 버전을 확인할 수 없습니다.

PrivateEndpointServiceConnectionStatus

프라이빗 엔드포인트 연결 상태입니다.

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.

Name Type Description
actionsRequired
  • string

서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.

description
  • string

연결의 승인/거부 이유입니다.

status

서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

PublicNetworkAccess

이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 배타적 액세스 방법입니다. 기본값은 'Enabled'입니다.

Name Type Description
Disabled
  • string
Enabled
  • string

RemotePrivateEndpointConnectionWrapper

원격 프라이빗 엔드포인트 연결 리소스입니다.

Name Type Description
id
  • string

프라이빗 엔드포인트 연결 리소스 ID

name
  • string

프라이빗 엔드포인트 연결 이름

properties.groupIds
  • string[]

모든 그룹 ID입니다.

properties.privateEndpoint

프라이빗 엔드포인트의 리소스입니다.

properties.privateLinkServiceConnectionState

서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.

properties.provisioningState
  • string

프라이빗 엔드포인트 연결 리소스의 프로비전 상태입니다.

type
  • string

프라이빗 엔드포인트 연결 리소스 유형

SkuType

SKU의 이름입니다.

Name Type 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를 Premium.

Standard
  • string

API Management의 표준 SKU입니다.

systemData

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name Type Description
createdAt
  • string

리소스 만들기의 타임스탬프(UTC)입니다.

createdBy
  • string

리소스를 만든 ID입니다.

createdByType

리소스를 만든 ID의 형식입니다.

lastModifiedAt
  • string

리소스 마지막 수정의 타임스탬프(UTC)

lastModifiedBy
  • string

리소스를 마지막으로 수정한 ID입니다.

lastModifiedByType

리소스를 마지막으로 수정한 ID의 형식입니다.

UserIdentityProperties

Name Type Description
clientId
  • string

사용자 할당 ID의 클라이언트 ID입니다.

principalId
  • string

사용자 할당 ID의 보안 주체 ID입니다.

VirtualNetworkConfiguration

API Management 서비스가 배포되는 가상 네트워크의 구성입니다.

Name Type 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 Type Description
External
  • string

이 서비스는 Virtual Network 일부이며 인터넷에서 액세스할 수 있습니다.

Internal
  • string

이 서비스는 Virtual Network 일부이며 가상 네트워크 내에서만 액세스할 수 있습니다.

None
  • string

서비스는 Virtual Network 일부가 아닙니다.