다음을 통해 공유

Api Management Service - Backup

  • 참조
서비스:
API Management
API 버전:
2024-05-01

지정된 Azure Storage 계정에 대한 API Management 서비스의 백업을 만듭니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2024-05-01

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 (uuid)

대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

요청 본문

Name 필수 형식 Description
backupName True

string

만들거나 검색할 백업 파일의 이름입니다.
containerName True

string

Blob 컨테이너의 이름입니다(백업을 배치/검색하는 데 사용됨).
storageAccount True

string

Azure Storage 계정의 이름입니다(백업을 배치/검색하는 데 사용됨).
accessKey

string

스토리지 계정 액세스 키입니다. accessType AccessKey설정된 경우에만 필요합니다.
accessType

AccessType

스토리지 계정에 사용할 액세스 유형입니다.
clientId

string

사용자 할당 관리 ID의 클라이언트 ID입니다. accessType UserAssignedManagedIdentity설정된 경우에만 필요합니다.

응답

Name 형식 Description
200 OK

ApiManagementServiceResource

API Management 서비스를 스토리지 계정에 백업했습니다.
202 Accepted

수락됨: 위치 헤더에는 장기 실행 작업의 상태를 확인할 수 있는 URL이 포함됩니다.

헤더

location: string
Other Status Codes

ErrorResponse

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

보안

azure_auth

Azure Active Directory OAuth2 Flow.

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementBackupWithAccessKey
ApiManagementBackupWithSystemManagedIdentity
ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

샘플 요청

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

샘플 응답

상태 코드:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
상태 코드:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westus-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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementBackupWithSystemManagedIdentity

샘플 요청

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

샘플 응답

상태 코드:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
상태 코드:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

샘플 요청

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2024-05-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

샘플 응답

상태 코드:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
상태 코드:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "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.Ciphers.TripleDes168": "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": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

정의

Name Description
AccessType

스토리지 계정에 사용할 액세스 유형입니다.
AdditionalLocation

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

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

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

SSL 인증서 정보입니다.
CertificateSource

인증서 원본입니다.
CertificateStatus

인증서 상태.
ConfigurationApi

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

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

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

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

오류 세부 정보입니다.
ErrorResponse

오류 응답
HostnameConfiguration

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

호스트 이름 형식입니다.
LegacyApiState

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

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

이 API Management 서비스에 NAT 게이트웨이를 사용하도록 설정하는 데 속성을 사용할 수 있습니다.
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 내에 설정됨을 의미하며, 내부는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 API Management 배포가 설정됨을 의미합니다.

AccessType

열거형

스토리지 계정에 사용할 액세스 유형입니다.

값 Description
AccessKey

액세스 키를 사용합니다.
SystemAssignedManagedIdentity

시스템 할당 관리 ID를 사용합니다.
UserAssignedManagedIdentity

사용자 할당 관리 ID를 사용합니다.

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[]

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

ApiManagementServiceBackupRestoreParameters

Object

API Management 서비스 작업의 백업/복원에 제공된 매개 변수입니다.

Name 형식 Default value Description
accessKey

string

스토리지 계정 액세스 키입니다. accessType AccessKey설정된 경우에만 필요합니다.
accessType

AccessType

AccessKey

스토리지 계정에 사용할 액세스 유형입니다.
backupName

string

만들거나 검색할 백업 파일의 이름입니다.
clientId

string

사용자 할당 관리 ID의 클라이언트 ID입니다. accessType UserAssignedManagedIdentity설정된 경우에만 필요합니다.
containerName

string

Blob 컨테이너의 이름입니다(백업을 배치/검색하는 데 사용됨).
storageAccount

string

Azure Storage 계정의 이름입니다(백업을 배치/검색하는 데 사용됨).

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입니다.
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일 또는 그 이전에 만들어진 경우 기본값이 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
properties.developerPortalStatus

developerPortalStatus

Enabled

이 API Management 서비스의 개발자 포털 상태입니다.
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

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[]

내부 가상 네트워크에 배포된 주 지역의 API Management 서비스의 개인 정적 부하 분산 IP 주소입니다. 기본, 표준, 프리미엄 및 격리된 SKU에만 사용할 수 있습니다.
properties.provisioningState

string

생성/활성화/성공/업데이트/실패/중지/종료/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

maxLength: 100

게시자 전자 메일입니다.
properties.publisherName

string

maxLength: 100

게시자 이름입니다.
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 내에 설정됨을 의미하며, 내부는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 API Management 배포가 설정됨을 의미합니다.
sku

ApiManagementServiceSkuProperties

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

systemData

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

object

리소스 태그.
type

string

API Management 리소스의 리소스 종류는 Microsoft.ApiManagement로 설정됩니다.
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
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

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 enum:
  • CertificateAuthority
  • Root

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

CertificateInformation

Object

SSL 인증서 정보입니다.

Name 형식 Description
expiry

string (date-time)

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

string

인증서의 주체입니다.
thumbprint

string

인증서의 지문입니다.

CertificateSource

열거형

인증서 원본입니다.

값 Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

열거형

인증서 상태.

값 Description
Completed
Failed
InProgress

ConfigurationApi

Object

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

Name 형식 Default value Description
legacyApi

LegacyApiState

Enabled

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

createdByType

열거형

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

값 Description
Application
Key
ManagedIdentity
User

developerPortalStatus

열거형

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

값 Description
Disabled

서비스에 대해 개발자 포털을 사용할 수 없습니다.
Enabled

개발자 포털은 서비스에 대해 사용하도록 설정됩니다.

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

boolean

False

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

HostnameType

호스트 이름 형식입니다.

HostnameType

열거형

호스트 이름 형식입니다.

값 Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

열거형

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

값 Description
Disabled

레거시 구성 API(v1)는 서비스에 사용할 수 없으며 자체 호스팅 게이트웨이는 연결할 수 없습니다.
Enabled

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

LegacyPortalStatus

열거형

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

값 Description
Disabled

레거시 포털은 서비스에 사용할 수 없습니다.
Enabled

레거시 포털은 서비스에 대해 사용하도록 설정됩니다.

NatGatewayState

열거형

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

값 Description
Disabled

서비스에 대해 Nat 게이트웨이를 사용할 수 없습니다.
Enabled

서비스에 대해 Nat 게이트웨이를 사용할 수 있습니다.

PlatformVersion

열거형

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

값 Description
mtv1

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

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

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

최신 하드웨어의 단일 테넌트 V2 플랫폼에서 서비스를 실행하는 플랫폼입니다.
undetermined

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

PrivateEndpointServiceConnectionStatus

열거형

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

값 Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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

Name 형식 Description
actionsRequired

string

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

string

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

PrivateEndpointServiceConnectionStatus

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

PublicNetworkAccess

열거형

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

값 Description
Disabled
Enabled

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
Basic

Api Management의 기본 SKU입니다.
BasicV2

Api Management의 BasicV2 SKU입니다.
Consumption

Api Management의 소비 SKU입니다.
Developer

Api Management의 개발자 SKU입니다.
Isolated

Api Management의 격리된 SKU입니다.
Premium

Api Management의 프리미엄 SKU입니다.
Standard

Api Management의 표준 SKU입니다.
StandardV2

Api Management의 StandardV2 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의 유형입니다. 없음(기본값)은 API Management 서비스가 Virtual Network의 일부가 아님을 의미하고, 외부는 API Management 배포가 인터넷 연결 엔드포인트가 있는 Virtual Network 내에 설정됨을 의미하며, 내부는 인트라넷 연결 엔드포인트만 있는 Virtual Network 내에서 API Management 배포가 설정됨을 의미합니다.

값 Description
External

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

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

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