Api Management Service - Refresh Hostnames

서비스:: API Management

API 버전:: 2025-03-01-preview

Api Management 서비스에서 KeyVault에서 비밀로 설정한 사용자 지정 호스트네임에 연결된 SSL 인증서를 강제 새로고침합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	ApiManagementServiceResource	Azure 작업이 성공적으로 완료되었습니다.
202 Accepted		리소스 작업이 수락되었습니다. 헤더 Retry-After: integer location: string
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

Name

형식

Description

200 OK

ApiManagementServiceResource

Azure 작업이 성공적으로 완료되었습니다.

202 Accepted

리소스 작업이 수락되었습니다.

헤더

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

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_service_refresh_key_vault_hostnames.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="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.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

샘플 응답

상태 코드:: 200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

상태 코드:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2025-03-01-preview

정의

Name	Description
AdditionalLocation	추가 API Management 리소스 위치에 대한 설명입니다.
ApiManagementServiceIdentity	Api Management 서비스 리소스의 ID 속성입니다.
ApiManagementServiceResource	나열 또는 응답 가져오기의 단일 API Management 서비스 리소스입니다.
ApiManagementServiceSkuProperties	API Management 서비스 리소스 SKU 속성입니다.
ApimIdentityType	리소스에 사용되는 ID의 형식입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.
ApiVersionConstraint	API Management 서비스에 대한 컨트롤 플레인 API 버전 제약 조건입니다.
ArmIdWrapper	ARM 리소스 ID에 대한 래퍼
CertificateConfiguration	신뢰할 수 없는 중간 및 루트 인증서로 구성된 인증서 구성입니다.
CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName 인증서 저장소 위치입니다. 루트 및 CertificateAuthority만 유효한 위치입니다.
CertificateInformation	SSL 인증서 정보.
CertificateSource	인증서 원본.
CertificateStatus	인증서 상태.
ConfigurationApi	API Management 서비스의 구성 API에 대한 정보입니다.
createdByType	리소스를 만든 ID의 형식입니다.
DeveloperPortalStatus	이 API Management 서비스의 개발자 포털 상태입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
HostnameConfiguration	사용자 지정 호스트 이름 구성.
HostnameType	호스트 이름 형식입니다.
LegacyApiState	레거시 구성 API(v1)를 API Management 서비스에 노출해야 하는지 여부를 나타냅니다. 값은 선택 사항이지만 'Enabled' 또는 'Disabled'여야 합니다. '사용 안 함'인 경우 자체 호스팅 게이트웨이에 레거시 구성 API(v1)를 사용할 수 없습니다. 기본값은 'Enabled'입니다.
LegacyPortalStatus	API Management 서비스의 레거시 포털 상태입니다.
NatGatewayState	속성을 사용하여 이 API Management 서비스에 대해 NAT 게이트웨이를 사용하도록 설정할 수 있습니다.
PlatformVersion	서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
PrivateEndpointServiceConnectionStatus	프라이빗 엔드포인트 연결 상태입니다.
PrivateLinkServiceConnectionState	서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.
PublicNetworkAccess	이 API Management 서비스에 대해 퍼블릭 엔드포인트 액세스가 허용되는지 여부입니다. 값은 선택 사항이지만 전달된 경우 '사용' 또는 '사용 안 함'이어야 합니다. 'Disabled'인 경우 프라이빗 엔드포인트는 전용 액세스 방법입니다. 기본값은 'Enabled'입니다.
ReleaseChannel	이 API Management 서비스의 릴리스 채널입니다.
RemotePrivateEndpointConnectionWrapper	원격 프라이빗 엔드포인트 연결 리소스입니다.
SkuType	Sku의 이름입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
UserIdentityProperties
VirtualNetworkConfiguration	API Management 서비스가 배포되는 가상 네트워크의 구성입니다.
VirtualNetworkType	API Management 게이트웨이를 구성해야 하는 VPN 유형입니다.

AdditionalLocation

Object

추가 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 게이트웨이를 사용하도록 설정할 수 있습니다.
outboundPublicIPAddresses	string[]		NAT 게이트웨이 배포 서비스와 연결된 아웃바운드 공용 IPV4 주소 접두사입니다. stv2 플랫폼의 프리미엄 SKU에만 사용할 수 있습니다.
platformVersion	PlatformVersion		서비스를 실행하는 컴퓨팅 플랫폼 버전입니다.
privateIPAddresses	string[]		특정 추가 위치의 내부 가상 네트워크에 배포된 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

Object

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

Name	형식	Description
principalId	string (uuid)	ID의 보안 주체 ID입니다.
tenantId	string (uuid)	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

Object

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

Name	형식	Default value	Description
etag	string		리소스의 ETag입니다.
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.configurationApi	ConfigurationApi		API Management 서비스의 구성 API 구성입니다.
properties.createdAtUtc	string (date-time)		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일 또는 그 이전에 만들어진 경우입니다 `TrueFalse` . Http2 설정의 기본값은 `False`. 설정을 사용하여 `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]`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 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.developerPortalStatus	DeveloperPortalStatus	Enabled	이 API Management 서비스의 개발자 포털 상태입니다.
properties.developerPortalUrl	string		API Management 서비스의 개발자 포털 엔드포인트 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	HostnameConfiguration[]		API Management 서비스의 사용자 지정 호스트 이름 구성입니다.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	API Management 서비스의 레거시 포털 상태입니다.
properties.managementApiUrl	string		API Management 서비스의 관리 API 엔드포인트 URL입니다.
properties.natGatewayState	NatGatewayState	Disabled	속성을 사용하여 이 API Management 서비스에 대해 NAT 게이트웨이를 사용하도록 설정할 수 있습니다.
properties.notificationSenderEmail	string maxLength: 100		알림을 보낼 전자 메일 주소입니다.
properties.outboundPublicIPAddresses	string[]		NAT 게이트웨이 배포 서비스와 연결된 아웃바운드 공용 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		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 maxLength: 100		게시자 전자 메일입니다.
properties.publisherName	string maxLength: 100		게시자 이름입니다.
properties.releaseChannel	ReleaseChannel		이 API Management 서비스의 릴리스 채널입니다.
properties.restore	boolean	False	이전에 일시 삭제된 경우 Api Management Service를 삭제 취소합니다. 이 플래그를 지정하고 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 내에 설정됨을 의미하며, 내부는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 API Management 배포가 설정됨을 의미합니다.
properties.zoneRedundant	boolean	False	StandardV2와 PremiumV2를 생성할 때 존 중복 요구사항. 이 플래그가 True로 설정되어 있으면, Zone 중복 APIM 서비스를 반환하거나, 하위 구성 요소가 존 중복이 될 수 없으면 요청을 실패합니다.
sku	ApiManagementServiceSkuProperties		API Management 서비스의 SKU 속성입니다.
systemData	systemData		createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
tags	object		리소스 태그.
type	string		리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"
zones	string[]		가용성 영역입니다.

ApiManagementServiceSkuProperties

Object

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

Name	형식	Description
capacity	integer (int32)	SKU의 용량(SKU의 배포된 단위 수)입니다. 소비 SKU 용량의 경우 0으로 지정해야 합니다.
name	SkuType	Sku의 이름입니다.

ApimIdentityType

열거형

리소스에 사용되는 ID의 형식입니다. 'SystemAssigned, UserAssigned' 형식에는 암시적으로 생성된 ID와 사용자 할당 ID 집합이 모두 포함됩니다. 'None' 형식은 서비스에서 모든 ID를 제거합니다.

값	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Object

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

Name	형식	Description
minApiVersion	string	이 값보다 최신 버전의 API Management 서비스에 대한 컨트롤 플레인 API 호출을 제한합니다.

ArmIdWrapper

Object

ARM 리소스 ID에 대한 래퍼

Name	형식	Description
id	string

CertificateConfiguration

Object

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

Name	형식	Description
certificate	CertificateInformation	인증서 정보입니다.
certificatePassword	string	인증서 암호입니다.
encodedCertificate	string	Base64로 인코딩된 인증서입니다.
storeName	CertificateConfigurationStoreName	System.Security.Cryptography.x509certificates.StoreName 인증서 저장소 위치입니다. 루트 및 CertificateAuthority만 유효한 위치입니다.

CertificateConfigurationStoreName

열거형

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

값	Description
CertificateAuthority
Root

CertificateInformation

Object

SSL 인증서 정보.

Name	형식	Description
expiry	string (date-time)	인증서의 만료 날짜입니다. 날짜는 ISO 8601 표준에 지정된 `yyyy-MM-ddTHH:mm:ssZ` 형식을 준수합니다.
subject	string	인증서의 주체입니다.
thumbprint	string	인증서의 지문입니다.

CertificateSource

열거형

인증서 원본.

값	Description
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

열거형

인증서 상태.

값	Description
Completed
Failed
InProgress

ConfigurationApi

Object

API Management 서비스의 구성 API에 대한 정보입니다.

Name	형식	Default value	Description
legacyApi	LegacyApiState	Enabled	레거시 구성 API(v1)를 API Management 서비스에 노출해야 하는지 여부를 나타냅니다. 값은 선택 사항이지만 'Enabled' 또는 'Disabled'여야 합니다. '사용 안 함'인 경우 자체 호스팅 게이트웨이에 레거시 구성 API(v1)를 사용할 수 없습니다. 기본값은 'Enabled'입니다.

createdByType

열거형

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

값	Description
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

열거형

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

값	Description
Enabled	서비스에 대해 개발자 포털이 사용 가능합니다.
Disabled	서비스에 대해 개발자 포털이 사용 안함으로 설정되었습니다.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

오류 응답

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

HostnameConfiguration

Object

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

Name	형식	Default value	Description
certificate	CertificateInformation		인증서 정보입니다.
certificatePassword	string		인증서 암호입니다.
certificateSource	CertificateSource		인증서 원본.
certificateStatus	CertificateStatus		인증서 상태.
defaultSslBinding	boolean	False	이 호스트 이름과 연결된 인증서를 기본 SSL 인증서로 설정하려면 true를 지정합니다. 클라이언트가 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		호스트 이름 형식입니다.

HostnameType

열거형

호스트 이름 형식입니다.

값	Description
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

LegacyApiState

열거형

레거시 구성 API(v1)를 API Management 서비스에 노출해야 하는지 여부를 나타냅니다. 값은 선택 사항이지만 'Enabled' 또는 'Disabled'여야 합니다. '사용 안 함'인 경우 자체 호스팅 게이트웨이에 레거시 구성 API(v1)를 사용할 수 없습니다. 기본값은 'Enabled'입니다.

값	Description
Enabled	레거시 구성 API(v1)가 서비스에 사용하도록 설정되어 있으며 자체 호스팅 게이트웨이가 연결할 수 있습니다.
Disabled	레거시 구성 API(v1)는 서비스에 대해 사용하지 않도록 설정되었으며 자체 호스팅 게이트웨이는 연결할 수 없습니다.

LegacyPortalStatus

열거형

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

값	Description
Enabled	레거시 포털이 서비스에 대해 사용하도록 설정되어 있습니다.
Disabled	레거시 포털은 서비스에 대해 비활성화되어 있습니다.

NatGatewayState

열거형

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

값	Description
Enabled	Nat Gateway가 서비스에 대해 사용하도록 설정되어 있습니다.
Disabled	Nat Gateway는 서비스에 대해 사용하지 않도록 설정되었습니다.

PlatformVersion

열거형

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

값	Description
undetermined	컴퓨팅 플랫폼이 배포되지 않았으므로 플랫폼 버전을 확인할 수 없습니다.
stv1	단일 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.
stv2	단일 테넌트 V2 플랫폼에서 서비스를 실행하는 플랫폼입니다.
mtv1	다중 테넌트 V1 플랫폼에서 서비스를 실행하는 플랫폼입니다.
stv2.1	최신 하드웨어의 단일 테넌트 V2 플랫폼에서 서비스를 실행하는 플랫폼입니다.

PrivateEndpointServiceConnectionStatus

열거형

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

값	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Object

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

Name	형식	Description
actionsRequired	string	서비스 공급자의 변경 내용에 소비자에 대한 업데이트가 필요한지 여부를 나타내는 메시지입니다.
description	string	연결의 승인/거부 이유입니다.
status	PrivateEndpointServiceConnectionStatus	서비스 소유자가 연결을 승인/거부/제거했는지 여부를 나타냅니다.

PublicNetworkAccess

열거형

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

값	Description
Enabled
Disabled

ReleaseChannel

열거형

이 API Management 서비스의 릴리스 채널입니다.

값	Description
Preview	서비스의 미리 보기 채널입니다.
Default	서비스의 기본 채널입니다.
Stable	서비스의 안정적인 채널입니다.

RemotePrivateEndpointConnectionWrapper

Object

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

Name	형식	Description
id	string	프라이빗 엔드포인트 연결 리소스 ID
name	string	프라이빗 엔드포인트 연결 이름
properties.groupIds	string[]	모든 그룹 ID입니다.
properties.privateEndpoint	ArmIdWrapper	프라이빗 엔드포인트의 리소스입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	서비스 소비자와 공급자 간의 연결 상태에 대한 정보 컬렉션입니다.
properties.provisioningState	string	프라이빗 엔드포인트 연결 리소스의 프로비전 상태입니다.
type	string	프라이빗 엔드포인트 연결 리소스 종류

SkuType

열거형

Sku의 이름입니다.

값	Description
Developer	Api Management의 개발자 SKU입니다.
Standard	API Management의 표준 SKU입니다.
Premium	API 관리의 프리미엄 SKU.
Basic	Api Management의 기본 SKU.
Consumption	Api Management의 소비 SKU입니다.
Isolated	Api Management의 격리된 SKU.
BasicV2	Api Management의 BasicV2 SKU입니다.
StandardV2	StandardV2 SKU를 사용합니다.
PremiumV2	PremiumV2 API 관리용 SKU.

systemData

Object

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

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

UserIdentityProperties

Object

Name	형식	Description
clientId	string	사용자 할당 ID의 클라이언트 ID입니다.
principalId	string	사용자 할당 ID의 보안 주체 ID입니다.

VirtualNetworkConfiguration

Object

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

Name	형식	Description
subnetResourceId	string pattern: ^/subscriptions/[^/]/resourceGroups/[^/]/providers/Microsoft.(ClassicNetwork\|Network)/virtualNetworks/[^/]/subnets/[^/]$	API Management 서비스를 배포할 가상 네트워크에 있는 서브넷의 전체 리소스 ID입니다.
subnetname	string	서브넷의 이름입니다.
vnetid	string	가상 네트워크 ID입니다. 일반적으로 GUID입니다. 기본적으로 null GUID가 예상됩니다.

VirtualNetworkType

열거형

API Management 게이트웨이를 구성해야 하는 VPN 유형입니다.

값	Description
None	API Management 게이트웨이는 Virtual Network의 일부가 아닙니다.
External	API Management 게이트웨이는 Virtual Network의 일부이며 인터넷에서 액세스할 수 있습니다.
Internal	API Management 게이트웨이는 Virtual Network의 일부이며 가상 네트워크 내에서만 액세스할 수 있습니다.

다음을 통해 공유

Api Management Service - Refresh Hostnames

URI 매개 변수

응답

보안

azure_auth

범위

예제

ApiManagementServiceRefreshKeyVaultHostnames

샘플 요청

샘플 응답

정의

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType