ApiManagementServiceUpdateParameters interface

패키지:

@azure/arm-apimanagement

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

Extends

ApimResource

속성

additionalLocations	API Management 서비스의 추가 데이터 센터 위치입니다.
apiVersionConstraint	API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
certificates	API Management 서비스에 설치해야 하는 인증서 목록입니다. 설치할 수 있는 지원되는 최대 인증서는 10개입니다.
configurationApi	API Management 서비스의 구성 API 구성입니다.
createdAtUtc	API Management 서비스의 만들기 UTC 날짜입니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
customProperties	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일 또는 그 이전에 만들어진 경우 기본값이 True, 그렇지 않으면 False. 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
developerPortalStatus	이 API Management 서비스의 개발자 포털 상태입니다.
developerPortalUrl	API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
disableGateway	속성은 여러 위치에 배포된 Api Management 서비스에만 유효합니다. 마스터 지역에서 게이트웨이를 사용하지 않도록 설정하는 데 사용할 수 있습니다.
enableClientCertificate	속성은 소비 SKU 서비스에만 사용됩니다. 이렇게 하면 게이트웨이에 대한 각 요청에 대해 클라이언트 인증서가 표시됩니다. 이렇게 하면 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용할 수 있습니다.
etag	리소스의 ETag입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
gatewayRegionalUrl	기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
gatewayUrl	API Management 서비스의 게이트웨이 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
hostnameConfigurations	API Management 서비스의 사용자 지정 호스트 이름 구성입니다.
identity	Api Management 서비스의 관리 서비스 ID입니다.
legacyPortalStatus	API Management 서비스의 레거시 포털 상태입니다.
managementApiUrl	API Management 서비스의 관리 API 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
natGatewayState	이 API Management 서비스에 NAT 게이트웨이를 사용하도록 설정하는 데 속성을 사용할 수 있습니다.
notificationSenderEmail	알림을 보낼 전자 메일 주소입니다.
outboundPublicIPAddresses	NAT 게이트웨이 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
platformVersion	이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
portalUrl	API Management 서비스의 게시자 포털 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
privateEndpointConnections	이 서비스의 프라이빗 엔드포인트 연결 목록입니다.
privateIPAddresses	내부 가상 네트워크에 배포된 주 지역의 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
provisioningState	생성/활성화/성공/업데이트/실패/중지/종료/TerminatFailed/Deleted 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
publicIPAddresses	주 지역에 있는 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
publicIpAddressId	지역에서 Virtual Network 배포 서비스와 연결할 공용 표준 SKU IP V4 기반 IP 주소입니다. Virtual Network에 배포되는 개발자 및 프리미엄 SKU에 대해서만 지원됩니다.
publicNetworkAccess	이 API Management 서비스에 대한 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
publisherEmail	게시자 전자 메일입니다.
publisherName	게시자 이름입니다.
restore	이전에 일시 삭제된 경우 Api Management 서비스를 삭제 취소합니다. 이 플래그를 지정하고 True로 설정하면 다른 모든 속성은 무시됩니다.
scmUrl	API Management 서비스의 SCM 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
sku	API Management 서비스의 SKU 속성입니다.
targetProvisioningState	서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비전 상태입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
virtualNetworkConfiguration	API Management 서비스의 가상 네트워크 구성입니다.
virtualNetworkType	API Management 서비스를 구성해야 하는 VPN의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network의 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 API Management 배포가 설정됨을 의미합니다.
zones	리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.

상속된 속성

id	리소스 ID입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
name	리소스 이름입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
tags	리소스 태그.
type	API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

속성 세부 정보

additionalLocations

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

additionalLocations?: AdditionalLocation[]

속성 값

AdditionalLocation[]

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

속성 값

ApiVersionConstraint

certificates

API Management 서비스에 설치해야 하는 인증서 목록입니다. 설치할 수 있는 지원되는 최대 인증서는 10개입니다.

certificates?: CertificateConfiguration[]

속성 값

CertificateConfiguration[]

configurationApi

API Management 서비스의 구성 API 구성입니다.

configurationApi?: ConfigurationApi

속성 값

ConfigurationApi

createdAtUtc

API Management 서비스의 만들기 UTC 날짜입니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

createdAtUtc?: Date

속성 값

Date

customProperties

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일 또는 그 이전에 만들어진 경우 기본값이 True, 그렇지 않으면 False. 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

customProperties?: {[propertyName: string]: string}

속성 값

{[propertyName: string]: string}

developerPortalStatus

이 API Management 서비스의 개발자 포털 상태입니다.

developerPortalStatus?: string

속성 값

string

developerPortalUrl

API Management 서비스의 DEveloper 포털 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

developerPortalUrl?: string

속성 값

string

disableGateway

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

disableGateway?: boolean

속성 값

boolean

enableClientCertificate

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

enableClientCertificate?: boolean

속성 값

boolean

etag

리소스의 ETag입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

etag?: string

속성 값

string

gatewayRegionalUrl

기본 지역에 있는 API Management 서비스의 게이트웨이 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

gatewayRegionalUrl?: string

속성 값

string

gatewayUrl

API Management 서비스의 게이트웨이 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

gatewayUrl?: string

속성 값

string

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

속성 값

HostnameConfiguration[]

identity

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

identity?: ApiManagementServiceIdentity

속성 값

ApiManagementServiceIdentity

legacyPortalStatus

API Management 서비스의 레거시 포털 상태입니다.

legacyPortalStatus?: string

속성 값

string

managementApiUrl

API Management 서비스의 관리 API 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

managementApiUrl?: string

속성 값

string

natGatewayState

이 API Management 서비스에 NAT 게이트웨이를 사용하도록 설정하는 데 속성을 사용할 수 있습니다.

natGatewayState?: string

속성 값

string

notificationSenderEmail

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

notificationSenderEmail?: string

속성 값

string

outboundPublicIPAddresses

NAT 게이트웨이 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

outboundPublicIPAddresses?: string[]

속성 값

string[]

platformVersion

이 위치에서 서비스를 실행하는 컴퓨팅 플랫폼 버전입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

platformVersion?: string

속성 값

string

portalUrl

API Management 서비스의 게시자 포털 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

portalUrl?: string

속성 값

string

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

속성 값

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

내부 가상 네트워크에 배포된 주 지역의 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

privateIPAddresses?: string[]

속성 값

string[]

provisioningState

생성/활성화/성공/업데이트/실패/중지/종료/TerminatFailed/Deleted 중 하나일 수 있는 API Management 서비스의 현재 프로비전 상태입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

provisioningState?: string

속성 값

string

publicIPAddresses

주 지역에 있는 API Management 서비스의 공용 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

publicIPAddresses?: string[]

속성 값

string[]

publicIpAddressId

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

publicIpAddressId?: string

속성 값

string

publicNetworkAccess

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

publicNetworkAccess?: string

속성 값

string

publisherEmail

게시자 전자 메일입니다.

publisherEmail?: string

속성 값

string

publisherName

게시자 이름입니다.

publisherName?: string

속성 값

string

restore

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

restore?: boolean

속성 값

boolean

scmUrl

API Management 서비스의 SCM 엔드포인트 URL입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

scmUrl?: string

속성 값

string

sku

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

sku?: ApiManagementServiceSkuProperties

속성 값

ApiManagementServiceSkuProperties

targetProvisioningState

서비스에서 시작된 장기 실행 작업의 대상이 되는 API Management 서비스의 프로비전 상태입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

targetProvisioningState?: string

속성 값

string

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

속성 값

VirtualNetworkConfiguration

virtualNetworkType

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

virtualNetworkType?: string

속성 값

string

zones

리소스의 원본 위치를 나타내는 가용성 영역 목록입니다.

zones?: string[]

속성 값

string[]

상속된 속성 세부 정보

id

리소스 ID입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

id?: string

속성 값

string

ApimResource.id 상속된

name

리소스 이름입니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

name?: string

속성 값

string

ApimResource.name 상속된

tags

리소스 태그.

tags?: {[propertyName: string]: string}

속성 값

{[propertyName: string]: string}

ApimResource.tags 상속된

type

API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

type?: string

속성 값

string

ApimResource.type 상속된