ApiManagementService interface
ApiManagementService를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
가상 네트워크에서 실행되는 Microsoft.ApiManagement 리소스를 업데이트 업데이트된 DNS 변경 내용을 선택합니다.
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
가상 네트워크에서 실행되는 Microsoft.ApiManagement 리소스를 업데이트 업데이트된 DNS 변경 내용을 선택합니다.
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
지정된 Azure Storage 계정에 대한 API Management 서비스의 백업을 만듭니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceBackupRestoreParameters
ApiManagementService_Backup 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
지정된 Azure Storage 계정에 대한 API Management 서비스의 백업을 만듭니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceBackupRestoreParameters
ApiManagementService_Backup 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
API Management 서비스 만들거나 업데이트 하기 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceResource
CreateOrUpdate API Management 서비스 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
API Management 서비스 만들거나 업데이트 하기 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceResource
CreateOrUpdate API Management 서비스 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
기존 API Management 서비스를 삭제합니다.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
기존 API Management 서비스를 삭제합니다.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
API Management 서비스를 Stv2 플랫폼으로 업그레이드합니다. 자세한 내용은 을 참조하세요 https://aka.ms/apim-migrate-stv2. 이 변경은 되돌릴 수 없습니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
API Management 서비스를 Stv2 플랫폼으로 업그레이드합니다. 자세한 내용은 을 참조하세요 https://aka.ms/apim-migrate-stv2. 이 변경은 되돌릴 수 없습니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
현재 서비스의 ApiManagementService_Backup 작업을 사용하여 만든 API Management 서비스의 백업을 복원합니다. 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceBackupRestoreParameters
백업 작업에서 API Management 서비스 복원에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
현재 서비스의 ApiManagementService_Backup 작업을 사용하여 만든 API Management 서비스의 백업을 복원합니다. 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceBackupRestoreParameters
백업 작업에서 API Management 서비스 복원에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
기존 API Management 서비스를 업데이트.
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceUpdateParameters
CreateOrUpdate API Management 서비스 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
기존 API Management 서비스를 업데이트.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- parameters
- ApiManagementServiceUpdateParameters
CreateOrUpdate API Management 서비스 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
API Management 서비스의 이름 가용성 및 정확성을 확인합니다.
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>매개 변수
CheckNameAvailability 작업에 제공된 매개 변수입니다.
옵션 매개 변수입니다.
반환
get(string, string, ApiManagementServiceGetOptionalParams)
API Management 서비스 리소스 설명을 가져옵니다.
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
API Management 서비스에 대한 사용자 지정 도메인 소유권 식별자를 가져옵니다.
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>매개 변수
옵션 매개 변수입니다.
반환
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
5분 동안 유효한 API Management 서비스에 대한 Single Sign-On 토큰을 가져옵니다.
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
list(ApiManagementServiceListOptionalParams)
Azure 구독 내의 모든 API Management 서비스를 나열합니다.
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>매개 변수
옵션 매개 변수입니다.
반환
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
리소스 그룹 내의 모든 API Management 서비스를 나열합니다.
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
옵션 매개 변수입니다.