Invoke-RestMethod

참조

모듈:: Microsoft.PowerShell.Utility

HTTP 또는 HTTPS 요청을 RESTful 웹 서비스로 보냅니다.

Syntax

Invoke-RestMethod
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-StatusCodeVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-HttpVersion <Version>]
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-ConnectionTimeoutSeconds <Int32>]
      [-OperationTimeoutSeconds <Int32>]
      [-Headers <IDictionary>]
      [-SkipHeaderValidation]
      [-AllowInsecureRedirect]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-PreserveAuthorizationOnRedirect]
      [-RetryIntervalSec <Int32>]
      [-Method <WebRequestMethod>]
      [-PreserveHttpMethodOnRedirect]
      [-UnixSocket <UnixDomainSocketEndPoint>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-SkipHttpErrorCheck]
      [<CommonParameters>]

Invoke-RestMethod
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-StatusCodeVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-HttpVersion <Version>]
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-ConnectionTimeoutSeconds <Int32>]
      [-OperationTimeoutSeconds <Int32>]
      [-Headers <IDictionary>]
      [-SkipHeaderValidation]
      [-AllowInsecureRedirect]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-PreserveAuthorizationOnRedirect]
      [-RetryIntervalSec <Int32>]
      [-Method <WebRequestMethod>]
      [-PreserveHttpMethodOnRedirect]
      [-UnixSocket <UnixDomainSocketEndPoint>]
      [-NoProxy]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-SkipHttpErrorCheck]
      [<CommonParameters>]

Invoke-RestMethod
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-StatusCodeVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-HttpVersion <Version>]
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-ConnectionTimeoutSeconds <Int32>]
      [-OperationTimeoutSeconds <Int32>]
      [-Headers <IDictionary>]
      [-SkipHeaderValidation]
      [-AllowInsecureRedirect]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-PreserveAuthorizationOnRedirect]
      [-RetryIntervalSec <Int32>]
      -CustomMethod <String>
      [-PreserveHttpMethodOnRedirect]
      [-UnixSocket <UnixDomainSocketEndPoint>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-ProxyUseDefaultCredentials]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-SkipHttpErrorCheck]
      [<CommonParameters>]

Invoke-RestMethod
      [-FollowRelLink]
      [-MaximumFollowRelLink <Int32>]
      [-ResponseHeadersVariable <String>]
      [-StatusCodeVariable <String>]
      [-UseBasicParsing]
      [-Uri] <Uri>
      [-HttpVersion <Version>]
      [-WebSession <WebRequestSession>]
      [-SessionVariable <String>]
      [-AllowUnencryptedAuthentication]
      [-Authentication <WebAuthenticationType>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-CertificateThumbprint <String>]
      [-Certificate <X509Certificate>]
      [-SkipCertificateCheck]
      [-SslProtocol <WebSslProtocol>]
      [-Token <SecureString>]
      [-UserAgent <String>]
      [-DisableKeepAlive]
      [-ConnectionTimeoutSeconds <Int32>]
      [-OperationTimeoutSeconds <Int32>]
      [-Headers <IDictionary>]
      [-SkipHeaderValidation]
      [-AllowInsecureRedirect]
      [-MaximumRedirection <Int32>]
      [-MaximumRetryCount <Int32>]
      [-PreserveAuthorizationOnRedirect]
      [-RetryIntervalSec <Int32>]
      -CustomMethod <String>
      [-PreserveHttpMethodOnRedirect]
      [-UnixSocket <UnixDomainSocketEndPoint>]
      [-NoProxy]
      [-Body <Object>]
      [-Form <IDictionary>]
      [-ContentType <String>]
      [-TransferEncoding <String>]
      [-InFile <String>]
      [-OutFile <String>]
      [-PassThru]
      [-Resume]
      [-SkipHttpErrorCheck]
      [<CommonParameters>]

Description

cmdlet은 Invoke-RestMethod 풍부한 구조화된 데이터를 반환하는 REST(Representational State Transfer) 웹 서비스에 HTTP 및 HTTPS 요청을 보냅니다.

PowerShell은 데이터 형식에 따라 응답 형식을 지정합니다. RSS 또는 ATOM 피드의 경우 PowerShell은 항목 또는 항목 XML 노드를 반환합니다. JSON(JavaScript Object Notation) 또는 XML의 경우 PowerShell은 콘텐츠를 개체로 [PSCustomObject] 변환하거나 역직렬화합니다.

참고 항목

REST 엔드포인트가 여러 개체를 반환하면 개체가 배열로 수신됩니다. 출력을 다른 명령으로 Invoke-RestMethod 파이프하면 단일 [Object[]] 개체로 전송됩니다. 해당 배열의 내용은 파이프라인의 다음 명령에 대해 열거되지 않습니다.

이 cmdlet은 Windows PowerShell 3.0에서 도입되었습니다.

PowerShell 7.0 Invoke-RestMethod 부터 환경 변수로 정의된 프록시 구성을 지원합니다. 이 문서의 노트 섹션을 참조하세요.

PowerShell 7.4부터 요청에 대한 문자 인코딩은 기본적으로 ASCII 대신 UTF-8로 설정됩니다. 다른 인코딩이 필요한 경우 헤더에 charsetContent-Type 특성을 설정해야 합니다.

예제

예제 1: PowerShell RSS 피드 가져오기

이 예제에서는 cmdlet을 Invoke-RestMethod 사용하여 PowerShell 블로그 RSS 피드에서 정보를 가져옵니다. 이 명령은 cmdlet을 Format-Table 사용하여 표에 있는 각 블로그의 Title 및 pubDate 속성 값을 표시합니다.

Invoke-RestMethod -Uri https://blogs.msdn.microsoft.com/powershell/feed/ |
  Format-Table -Property Title, pubDate

Title                                                                pubDate
-----                                                                -------
Join the PowerShell 10th Anniversary Celebration!                    Tue, 08 Nov 2016 23:00:04 +0000
DSC Resource Kit November 2016 Release                               Thu, 03 Nov 2016 00:19:07 +0000
PSScriptAnalyzer Community Call - Oct 18, 2016                       Thu, 13 Oct 2016 17:52:35 +0000
New Home for In-Box DSC Resources                                    Sat, 08 Oct 2016 07:13:10 +0000
New Social Features on Gallery                                       Fri, 30 Sep 2016 23:04:34 +0000
PowerShellGet and PackageManagement in PowerShell Gallery and GitHub Thu, 29 Sep 2016 22:21:42 +0000
PowerShell Security at DerbyCon                                      Wed, 28 Sep 2016 01:13:19 +0000
DSC Resource Kit September Release                                   Thu, 22 Sep 2016 00:25:37 +0000
PowerShell DSC and implicit remoting broken in KB3176934             Tue, 23 Aug 2016 15:07:50 +0000
PowerShell on Linux and Open Source!                                 Thu, 18 Aug 2016 15:32:02 +0000

예제 2: POST 요청 실행

이 예제에서는 사용자가 실행 Invoke-RestMethod 하여 사용자 조직의 인트라넷 웹 사이트에서 POST 요청을 수행합니다.

$Cred = Get-Credential
$Url = "https://server.contoso.com:8089/services/search/jobs/export"
$Body = @{
    search = "search index=_internal | reverse | table index,host,source,sourcetype,_raw"
    output_mode = "csv"
    earliest_time = "-2d@d"
    latest_time = "-1d@d"
}
Invoke-RestMethod -Method 'Post' -Uri $url -Credential $Cred -Body $body -OutFile output.csv

자격 증명에 대한 메시지가 표시되고 저장 $Cred 되고 액세스할 URL이 정의 $Url됩니다.

이 변수는 $Body 검색 조건을 설명하고, CSV를 출력 모드로 지정하며, 반환된 데이터에 대해 이틀 전에 시작하여 하루 전에 끝나는 기간을 지정합니다. 본문 변수는 통신 중인 특정 REST API Invoke-RestMethod 에 적용되는 매개 변수의 값을 지정합니다.

이 Invoke-RestMethod 명령은 모든 변수와 함께 실행되어 결과 CSV 출력 파일의 경로 및 파일 이름을 지정합니다.

예제 3: 관계 링크 팔로우

일부 REST API는 RFC5988당 관계 링크를 통한 페이지 매김을 지원합니다. 헤더를 구문 분석하여 다음 페이지의 URL을 가져오는 대신 cmdlet에서 이 작업을 수행하도록 할 수 있습니다. 이 예제에서는 PowerShell GitHub 리포지토리에서 처음 두 페이지의 문제를 반환합니다.

$url = 'https://api.github.com/repos/powershell/powershell/issues'
Invoke-RestMethod $url -FollowRelLink -MaximumFollowRelLink 2

예제 4: 간소화된 다중 파트/양식 데이터 제출

일부 API는 파일 및 혼합 콘텐츠를 업로드하기 위해 제출이 필요합니다 multipart/form-data . 이 예제에서는 사용자의 프로필을 업데이트하는 방법을 보여 줍니다.

$Uri = 'https://api.contoso.com/v2/profile'
$Form = @{
    firstName  = 'John'
    lastName   = 'Doe'
    email      = 'john.doe@contoso.com'
    avatar     = Get-Item -Path 'c:\Pictures\jdoe.png'
    birthday   = '1980-10-15'
    hobbies    = 'Hiking','Fishing','Jogging'
}
$Result = Invoke-RestMethod -Uri $Uri -Method Post -Form $Form

프로필 폼에는 다음과 같은 필드가 birthdayhobbieslastNameavataremail필요합니다. firstName API는 사용자 프로필 그림에 대한 이미지가 필드에 제공 avatar 될 것으로 예상합니다. 또한 API는 동일한 형식으로 제출될 여러 hobbies 항목을 허용합니다.

HashTable을 $Form 만들 때 키 이름은 양식 필드 이름으로 사용됩니다. 기본적으로 HashTable의 값은 문자열로 변환됩니다. 값이 System.IO.FileInfo 있으면 파일 내용이 제출됩니다. 배열 또는 목록과 같은 컬렉션이 있는 경우 양식 필드가 여러 번 제출됩니다.

키를 사용하면 Get-Itemavatar 개체가 FileInfo 값으로 설정됩니다. 그 결과 이미지 데이터가 jdoe.png 제출됩니다.

키 hobbies 에 목록을 제공하면 각 목록 hobbies 항목에 대해 한 번씩 제출에 필드가 표시됩니다.

예제 5: 여러 헤더 전달

API는 인증 또는 유효성 검사를 위해 전달된 헤더가 필요한 경우가 많습니다. 이 예제에서는 여러 헤더를 REST API로 hash-table 전달하는 방법을 보여 줍니다.

$headers = @{
    'userId' = 'UserIDValue'
    'token' = 'TokenValue'
}
Invoke-RestMethod -Uri $uri -Method Post -Headers $headers -Body $body

예제 6: 파이프라인에서 반환된 항목 열거

GitHub는 배열을 여러 개체로 반환합니다. 출력을 다른 명령으로 파이프하면 단일 [Object[]]개체로 전송됩니다.

개체를 파이프라인으로 열거하려면 결과를 Write-Output 괄호로 괄호 안에 넣거나 cmdlet을 래핑합니다. 다음 예제에서는 GitHub에서 반환된 개체 수를 계산합니다. 그런 다음 파이프라인에 열거된 개체 수를 계산합니다.

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
$x = 0
Invoke-RestMethod -Uri $uri | ForEach-Object { $x++ }
$x
1

$x = 0
(Invoke-RestMethod -Uri $uri) | ForEach-Object { $x++ }
$x
30

$x = 0
Invoke-RestMethod -Uri $uri | Write-Output | ForEach-Object { $x++ }
$x
30

예제 7: 헤더 유효성 검사 건너뛰기

기본적으로 cmdlet은 Invoke-RestMethod 표준 정의 값 형식을 가진 잘 알려진 헤더의 값의 유효성을 검사합니다. 다음 예제에서는 이 유효성 검사에서 오류를 발생시키는 방법과 SkipHeaderValidation 매개 변수를 사용하여 잘못된 형식의 값을 허용한 엔드포인트에 대한 값의 유효성을 검사하지 않도록 하는 방법을 보여 줍니다.

$Uri = 'https://httpbin.org/headers'
$InvalidHeaders = @{
    'If-Match' = '12345'
}

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders

Invoke-RestMethod -Uri $Uri -Headers $InvalidHeaders -SkipHeaderValidation |
    Format-List

Invoke-RestMethod: The format of value '12345' is invalid.

headers : @{Host=httpbin.org; If-Match=12345; User-Agent=Mozilla/5.0 (Windows NT 10.0; Microsoft Windows
          10.0.19044; en-US) PowerShell/7.2.5;  X-Amzn-Trace-Id=Root=1-62f150a6-27754fd4226f31b43a3d2874}

httpbin.org 문제 해결을 위한 웹 요청 및 응답에 대한 정보를 반환하는 서비스입니다. 변수는 $Uri 요청의 헤더를 /headers 응답의 콘텐츠로 반환하는 서비스의 엔드포인트에 할당됩니다.

If-Match 요청 헤더는 RFC-7232 섹션 3.1에서 정의되며 해당 헤더의 값을 주변 따옴표로 정의해야 합니다. 변수에는 $InvalidHeaders 값이 잘못된 해시 테이블이 할당됩니다. 이 테이블 If-Match 은 값이 대신 "12345"정의되어 있기 때문 12345 입니다.

잘못된 헤더를 사용하여 호출 Invoke-RestMethod 하면 형식이 지정된 값이 잘못되었다는 오류 보고가 반환됩니다. 요청이 엔드포인트로 전송되지 않습니다.

SkipHeaderValidation 매개 변수를 사용하여 호출 Invoke-RestMethod 하면 유효성 검사 오류가 무시되고 요청이 엔드포인트로 전송됩니다. 엔드포인트는 비준수 헤더 값을 허용하므로 cmdlet은 오류 없이 응답 개체를 반환합니다.

예제 8: HTTP 2.0을 사용하여 요청 보내기

이 예제에서는 HTTP 2.0 프로토콜을 사용하여 GitHub 문제를 쿼리합니다.

$uri = 'https://api.github.com/repos/microsoftdocs/powershell-docs/issues'
Invoke-RestMethod -Uri $uri -HttpVersion 2.0 -SkipCertificateCheck

예제 9: Unix 소켓 애플리케이션에 요청 보내기

Docker와 같은 일부 애플리케이션은 통신을 위해 Unix 소켓을 노출합니다. 이 예제에서는 Docker API를 사용하여 Docker 이미지 목록을 쿼리합니다. 이 cmdlet은 Unix 소켓을 사용하여 Docker 디먼에 연결합니다.

Invoke-RestMethod -Uri "http://localhost/v1.40/images/json/" -UnixSocket "/var/run/docker.sock"

매개 변수

-AllowInsecureRedirect

HTTPS에서 HTTP로 리디렉션할 수 있습니다. 기본적으로 HTTPS에서 HTTP로 리디렉션되는 요청은 오류가 발생하며, 암호화되지 않은 연결을 통해 의도치 않게 일반 텍스트로 통신하지 못하도록 요청이 중단됩니다. 사용자 고유의 위험에서 이 동작을 재정의 하려면 AllowInsecureRedirect 매개 변수를 사용합니다.

이 매개 변수는 PowerShell 7.4에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowUnencryptedAuthentication

암호화되지 않은 연결을 통해 자격 증명 및 비밀을 보낼 수 있습니다. 기본적으로 자격 증명 또는 인증 옵션에 시작되지 않는 URI를 https:// 제공하면 오류가 발생하며, 암호화되지 않은 연결을 통해 실수로 일반 텍스트로 비밀을 전달하지 못하도록 요청이 중단됩니다. 사용자 고유의 위험에서 이 동작을 재정의 하려면 AllowUnencryptedAuthentication 매개 변수를 제공합니다.

Warning

이 매개 변수를 사용하는 것은 안전하지 않으며 권장되지 않습니다. 암호화된 연결을 제공할 수 없는 레거시 시스템과의 호환성을 위해서만 제공됩니다. 사용자 고유의 위험에 사용합니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Authentication

요청에 사용할 명시적 인증 유형을 지정합니다. 기본값은 None(없음)입니다. Authentication 매개 변수는 UseDefaultCredentials 매개 변수와 함께 사용할 수 없습니다.

사용 가능한 인증 옵션:

None: 인증이 제공되지 않는 경우 기본 옵션입니다. 명시적 인증은 사용되지 않습니다.
Basic: 자격 증명이 필요합니다. 자격 증명은 RFC 7617 기본 인증 Authorization: Basic 헤더를 형식으로 base64(user:password)보내는 데 사용됩니다.
Bearer: 토큰 매개 변수가 필요합니다. 제공된 토큰을 사용하여 RFC 6750 Authorization: Bearer 헤더를 보냅니다.
OAuth: 토큰 매개 변수가 필요합니다. 제공된 토큰을 사용하여 RFC 6750 Authorization: Bearer 헤더를 보냅니다.

인증을 제공하면 헤더에 제공되거나 WebSession에 포함된 헤더 Authorization 가 재정의됩니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	WebAuthenticationType
Accepted values:	None, Basic, Bearer, OAuth
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Body

요청 본문을 지정합니다. 본문은 헤더 뒤에 있는 요청의 내용입니다. 본문 값을 으로 파이프할 Invoke-RestMethod수도 있습니다.

Body 매개 변수를 사용하여 쿼리 매개 변수 목록을 지정하거나 응답 내용을 지정할 수 있습니다.

입력이 POST 요청이고 본문이 String이면 첫 번째 등호(=)의 왼쪽에 있는 값이 양식 데이터의 키로 설정되고 다시 기본 텍스트가 값으로 설정됩니다. 여러 키를 지정하려면 Body에 해시 테이블과 같은 IDictionary 개체를 사용합니다.

입력이 GET 요청이고 본문이 IDictionary (일반적으로 해시 테이블)인 경우 본문은 쿼리 매개 변수로 URI에 추가됩니다. 다른 요청 형식(예: PATCH)의 경우 본문은 URL로 인코딩된 값을 사용하여 표준 name=value 형식의 요청 본문 값으로 설정됩니다.

입력이 System.Xml.XmlNode 개체이고 XML 선언이 인코딩을 지정하는 경우 ContentType 매개 변수로 재정의되지 않는 한 해당 인코딩이 요청의 데이터에 사용됩니다.

본문이 폼이거나 다른 Invoke-WebRequest 호출의 출력인 경우 PowerShell은 요청 콘텐츠를 양식 필드로 설정합니다.

Body 매개 변수는 System.Net.Http.MultipartFormDataContent 개체를 수락할 수도 있습니다. 이렇게 하면 요청이 용 multipart/form-data 이합니다. MultipartFormDataContent 개체가 Body에 제공되면 ContentType, Headers 또는 WebSession 매개 변수에 제공된 모든 콘텐츠 관련 헤더가 개체의 콘텐츠 헤더에 의해 재정의 MultipartFormDataContent 됩니다. 이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	Object
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Certificate

보안 웹 요청에 사용되는 클라이언트 인증서를 지정합니다. 인증서가 포함된 변수를 입력하거나 인증서를 가져오는 명령 또는 식을 입력합니다.

인증서를 찾으려면 인증서(Cert:) 드라이브에서 cmdlet을 사용하거나 사용합니다.Get-PfxCertificateGet-ChildItem 인증서가 유효하지 않거나 권한이 충분하지 않으면 명령이 실패합니다.

Type:	X509Certificate
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CertificateThumbprint

요청을 보낼 수 있는 권한이 있는 사용자 계정의 디지털 공개 키 인증서(X509)를 지정합니다. 인증서의 인증서 지문을 입력합니다.

인증서는 클라이언트 인증서 기반 인증에 사용됩니다. 인증서는 로컬 사용자 계정에만 매핑할 수 있으며 기본 계정만 매핑할 수 있습니다.

인증서 지문을 보려면 또는 명령을 사용하여 Get-Item 인증서를 찾습니다Cert:\CurrentUser\My.Get-ChildItem

참고 항목

이 기능은 현재 Windows OS 플랫폼에서만 지원됩니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConnectionTimeoutSeconds

요청이 시간 초과되기 전에 보류할 수 있는 기간을 지정합니다. 값을 초 단위로 입력합니다. 기본값 0은 무기한 시간 제한을 지정합니다.

DNS(Do기본 Name System) 쿼리는 반환하거나 시간 초과하는 데 최대 15초가 걸릴 수 있습니다. 요청에 해결이 필요한 호스트 이름이 포함되어 있고 커넥트ionTimeoutSeconds를 0보다 크지만 15초 미만의 값으로 설정하는 경우 WebException이 throw되기까지 15초 이상 걸릴 수 있으며 요청 시간이 초과됩니다.

이 매개 변수는 PowerShell 7.4의 TimeoutSec 매개 변수를 대체했습니다. TimeoutSec을 커넥트TimeoutSeconds의 별칭으로 사용할 수 있습니다.

Type:	Int32
Aliases:	TimeoutSec
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContentType

웹 요청의 콘텐츠 형식을 지정합니다.

ContentType 값에 인코딩 형식(예:charset)이 포함된 경우 cmdlet은 해당 형식을 사용하여 웹 요청의 본문을 인코딩합니다. ContentType에서 인코딩 형식을 지정하지 않으면 기본 인코딩 형식이 대신 사용됩니다. 인코딩 형식을 사용하는 ContentType의 예는 text/plain; charset=iso-8859-5라틴어/키릴 자모 알파벳을 지정하는 것입니다.

이 매개 변수를 생략하고 요청 메서드가 POST Invoke-RestMethod 이면 콘텐츠 형식 application/x-www-form-urlencoded을 .로 설정합니다. 그렇지 않으면 콘텐츠 형식이 호출에 지정되지 않습니다.

개체가 Body에 제공되면 ContentType이 재정의 MultipartFormDataContent 됩니다.

PowerShell 7.4부터 이 매개 변수와 Headers 매개 변수를 모두 사용하여 헤더를 정의하는 Content-Type 경우 ContentType 매개 변수에 지정된 값이 사용됩니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

요청을 보낼 수 있는 권한이 있는 사용자 계정을 지정합니다. 기본값은 현재 사용자입니다.

User01 또는 Do기본01\User01과 같은 사용자 이름을 입력하거나 cmdlet에서 생성된 PSCredential 개체를 Get-Credential 입력합니다.

자격 증명은 단독으로 또는 특정 인증 매개 변수 옵션과 함께 사용할 수 있습니다. 단독으로 사용하는 경우 원격 서버가 인증 챌린지 요청을 보내는 경우에만 원격 서버에 자격 증명을 제공합니다. 인증 옵션과 함께 사용하면 자격 증명이 명시적으로 전송됩니다.

자격 증명은 PSCredential 개체에 저장되고 암호는 SecureString 으로 저장됩니다.

참고 항목

SecureString 데이터 보호에 대한 자세한 내용은 SecureString이 얼마나 안전한가요?를 참조하세요.

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomMethod

웹 요청에 사용되는 사용자 지정 메서드를 지정합니다. 이 옵션은 메서드에서 사용할 수 있는 옵션이 아닌 엔드포인트에 필요한 요청 메서드와 함께 사용할 수 있습니다. 메서드 와 CustomMethod를 함께 사용할 수 없습니다.

예시:

Invoke-RestMethod -uri 'https://api.contoso.com/widget/' -CustomMethod 'TEST'

이렇게 하면 API에 TEST 대한 HTTP 요청이 수행됩니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	String
Aliases:	CM
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableKeepAlive

cmdlet이 HTTP 헤더의 KeepAlive 값을 False로 설정했음을 나타냅니다. 기본적으로 KeepAlive 는 True입니다. KeepAlive 는 후속 요청을 용이하게 하기 위해 서버에 대한 영구 연결을 설정합니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FollowRelLink

cmdlet이 관계 링크를 따라야 했음을 나타냅니다.

일부 REST API는 RFC5988당 관계 링크를 통한 페이지 매김을 지원합니다. 헤더를 구문 분석하여 다음 페이지의 URL을 가져오는 대신 cmdlet에서 이 작업을 수행하도록 할 수 있습니다. 관계 링크를 따라야 하는 횟수를 설정하려면 MaximumFollowRelLink 매개 변수를 사용합니다.

이 스위치를 사용하는 경우 cmdlet은 결과의 페이지 컬렉션을 반환합니다. 결과의 각 페이지에는 여러 결과 항목이 포함될 수 있습니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	SwitchParameter
Aliases:	FL
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Form

사전을 제출로 multipart/form-data 변환합니다. 본문에는 폼을 사용할 수 없습니다. ContentType이 무시되는 경우

사전의 키는 양식 필드 이름으로 사용됩니다. 기본적으로 양식 값은 문자열 값으로 변환됩니다.

값이 System.IO.FileInfo 개체인 경우 이진 파일 내용이 제출됩니다. 파일 이름이 .로 filename제출됩니다. MIME는 .로 application/octet-stream설정됩니다. Get-Item를 사용하여 System.IO.FileInfo 개체의 공급을 간소화할 수 있습니다.

$Form = @{ resume = Get-Item 'c:\Users\jdoe\Documents\John Doe.pdf' }

값이 배열 또는 목록과 같은 컬렉션 형식인 경우 for 필드가 여러 번 제출됩니다. 목록의 값은 기본적으로 문자열로 처리됩니다. 값이 System.IO.FileInfo 개체인 경우 이진 파일 내용이 제출됩니다. 중첩된 컬렉션은 지원되지 않습니다.

$Form = @{ tags = 'Vacation', 'Italy', '2017' pictures = Get-ChildItem 'c:\Users\jdoe\Pictures\2017-Italy' }

위의 예제 tags 에서 필드는 양식에서 세 번, 각각VacationItaly에 대해 한 번, 및 2017. 또한 폴더 pictures 의 각 파일에 대해 필드가 2017-Italy 한 번 제출됩니다. 해당 폴더에 있는 파일의 이진 콘텐츠는 값으로 제출됩니다.

이 기능은 PowerShell 6.1.0에 추가되었습니다.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

웹 요청의 헤더를 지정합니다. 해시 테이블 또는 사전을 입력합니다.

개체가 Body에 제공될 때와 같은 Content-Type 콘텐츠 관련 헤더가 재정의 MultipartFormDataContent 됩니다.

PowerShell 7.4부터 이 매개 변수를 사용하여 헤더를 정의 Content-Type 하고 ContentType 매개 변수를 사용하는 경우 ContentType 매개 변수에 지정된 값이 사용됩니다.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HttpVersion

요청에 사용되는 HTTP 버전을 지정합니다. 기본값은 1.1입니다.

유효한 값은 다음과 같습니다.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InFile

파일에서 웹 요청의 콘텐츠를 가져옵니다.

경로 및 파일 이름을 입력합니다. 경로를 생략하면 기본값은 현재 위치입니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumFollowRelLink

FollowRelLink를 사용하는 경우 관계 링크를 따라야 하는 횟수를 지정합니다. REST API가 너무 많은 요청으로 인해 제한되는 경우 더 작은 값이 필요할 수 있습니다. 기본값은 [Int32]::MaxValue입니다. 값이 0이면 다음 관계 링크가 차단됩니다.

Type:	Int32
Aliases:	ML
Position:	Named
Default value:	Int32.MaxValue
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumRedirection

연결이 실패하기 전에 PowerShell이 대체 URI(Uniform Resource Identifier)로 연결을 리디렉션하는 횟수를 지정합니다. 기본 값은 5입니다. 값이 0이면 모든 리디렉션이 방지됩니다.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaximumRetryCount

400에서 599 사이의 오류 코드(포함 또는 304)가 수신될 때 PowerShell이 연결을 다시 시도한 횟수를 지정합니다. 또한 재시도 사이의 시간(초)을 지정하려면 RetryIntervalSec 매개 변수를 참조하세요.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Method

웹 요청에 사용되는 메서드를 지정합니다. 이 매개 변수에 허용되는 값은 다음과 같습니다.

Default
Delete
Get
Head
Merge
Options
Patch
Post
Put
Trace

CustomMethod 매개 변수는 위에 나열되지 않은 요청 메서드에 사용할 수 있습니다.

Type:	WebRequestMethod
Accepted values:	Default, Get, Head, Post, Put, Delete, Trace, Options, Merge, Patch
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoProxy

cmdlet이 프록시를 사용하여 대상에 도달하지 않음을 나타냅니다.

Internet Explorer에 구성된 프록시 또는 환경에 지정된 프록시를 바이패스해야 하는 경우 이 스위치를 사용합니다.

이 매개 변수는 PowerShell 6.0에서 도입되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OperationTimeoutSeconds

이 시간 제한은 스트림 시간 전체가 아니라 스트림 내의 데이터 읽기에 적용됩니다. 기본값 0은 무기한 시간 제한을 지정합니다.

값을 30초로 설정하면 스트림의 데이터 사이에 30초보다 긴 지연이 있으면 요청이 종료됩니다. 다운로드하는 데 몇 분 정도 걸리는 큰 파일은 스트림이 30초 이상 중단되지 않는 한 종료되지 않습니다.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutFile

지정된 출력 파일에 응답 본문을 저장합니다. 경로 및 파일 이름을 입력합니다. 경로를 생략하면 기본값은 현재 위치입니다. 이름은 리터럴 경로로 처리됩니다. 대괄호([])를 포함하는 이름은 작은따옴표(')로 묶어야 합니다.

기본적으로 Invoke-RestMethod 파이프라인에 결과를 반환합니다.

PowerShell 7.4부터 파일 이름 없이 폴더 경로를 지정할 수 있습니다. 이렇게 하면 파일의 이름은 리디렉션 후 확인된 URI의 마지막 세그먼트에서 가져온 것입니다. OutFile에 대한 폴더 경로를 지정하는 경우 Resume 매개 변수를 사용할 수 없습니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

이 매개 변수는 OutFile 매개 변수가 명령에 사용되는 경우에만 유효합니다. 결과는 파일 및 파이프라인에 기록됩니다.

참고 항목

PassThru 매개 변수를 사용하면 출력이 파이프라인에 기록되지만 파일이 만들어지지 않습니다. 자세한 내용은 PowerShell 문제 #15409를 참조하세요.

Type:	SwitchParameter
Position:	Named
Default value:	No output
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreserveAuthorizationOnRedirect

cmdlet이 리디렉션 간에 헤더를 Authorization 유지해야 하며, 있는 경우를 나타냅니다.

기본적으로 cmdlet은 리디렉션하기 전에 헤더를 Authorization 제거합니다. 이 매개 변수를 지정하면 헤더를 리디렉션 위치로 보내야 하는 경우 이 논리를 사용하지 않도록 설정합니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreserveHttpMethodOnRedirect

cmdlet이 리디렉션에서 요청의 메서드를 유지해야 했음을 나타냅니다.

기본적으로 cmdlet은 리디렉션될 때 메서드를 GET 변경합니다. 이 매개 변수를 지정하면 의도한 메서드를 리디렉션과 함께 사용할 수 있도록 이 논리를 사용하지 않도록 설정합니다.

이 기능은 PowerShell 7.4에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Proxy

인터넷 리소스에 직접 연결하는 대신 요청에 프록시 서버를 사용합니다. 네트워크 프록시 서버의 URI(Uniform Resource Identifier)를 입력합니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyCredential

프록시 매개 변수로 지정된 프록시 서버를 사용할 수 있는 권한이 있는 사용자 계정을 지정합니다. 기본값은 현재 사용자입니다.

User01 또는 Do기본01\User01User@Domain.Com과 같은 사용자 이름을 입력하거나 cmdlet에서 생성된 개체와 같은 개체를 Get-Credential 입력 PSCredential 합니다.

이 매개 변수는 프록시 매개 변수가 명령에 사용되는 경우에만 유효합니다. 동일한 명령에서는 ProxyCredential 및 ProxyUseDefaultCredentials 매개 변수를 사용할 수 없습니다.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProxyUseDefaultCredentials

cmdlet이 현재 사용자의 자격 증명을 사용하여 프록시 매개 변수로 지정된 프록시 서버에 액세스하도록 나타냅니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

응답 헤더 사전을 포함하는 변수를 만듭니다. 달러 기호($) 기호 없이 변수 이름을 입력합니다. 사전의 키에는 웹 서버에서 반환하는 응답 헤더의 필드 이름과 값이 포함됩니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Resume

부분 파일 다운로드를 다시 시작하려면 최선을 다합니다. Resume 매개 변수에는 OutFile 매개 변수가 필요합니다.

다시 시작 은 로컬 파일 및 원격 파일의 크기에 대해서만 작동하며 로컬 파일과 원격 파일이 동일하다는 다른 유효성 검사를 수행하지 않습니다.

로컬 파일 크기가 원격 파일 크기보다 작은 경우 cmdlet은 파일 다운로드를 다시 시작하고 파일 끝에 다시 기본 바이트를 추가합니다.

로컬 파일 크기가 원격 파일 크기와 동일한 경우 아무 작업도 수행되지 않으며 cmdlet은 다운로드가 이미 완료된 것으로 가정합니다.

로컬 파일 크기가 원격 파일 크기보다 크면 로컬 파일을 덮어쓰고 전체 원격 파일이 완전히 다시 다운로드됩니다. 이 동작은 Resume 없이 OutFile을 사용하는 것과 같습니다.

원격 서버에서 다운로드 다시 시작이 지원되지 않는 경우 로컬 파일을 덮어쓰고 전체 원격 파일이 완전히 다시 다운로드됩니다. 이 동작은 Resume 없이 OutFile을 사용하는 것과 같습니다.

로컬 파일이 없으면 로컬 파일이 만들어지고 전체 원격 파일이 완전히 다운로드됩니다. 이 동작은 Resume 없이 OutFile을 사용하는 것과 같습니다.

이 기능은 PowerShell 6.1.0에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RetryIntervalSec

400에서 599 사이의 오류 코드(포함 또는 304)가 수신될 때 연결에 대한 재시도 간격을 지정합니다. 값은 사이 1 여야 합니다.[int]::MaxValue 오류 코드가 429이고 응답에 헤더에 Retry-After 속성이 포함된 경우 이 매개 변수가 지정된 경우에도 cmdlet은 재시도 간격에 해당 값을 사용합니다.

또한 재시도 횟수를 지정하려면 MaximumRetryCount 매개 변수를 참조하세요.

Type:	Int32
Position:	Named
Default value:	5
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionVariable

웹 요청 세션을 포함하는 변수를 만듭니다. 달러 기호($) 기호 없이 변수 이름을 입력합니다.

세션 변수 Invoke-RestMethod 를 지정하면 웹 요청 세션 개체를 만들고 PowerShell 세션에서 지정된 이름을 가진 변수에 할당합니다. 명령이 완료되는 즉시 세션에서 변수를 사용할 수 있습니다.

PowerShell 7.4 이전에는 웹 요청 세션이 영구 연결이 아닙니다. 쿠키, 자격 증명, 최대 리디렉션 값 및 사용자 에이전트 문자열을 포함하여 연결 및 요청에 대한 정보를 포함하는 개체입니다. 웹 요청 간에 상태 및 데이터를 공유하는 데 사용할 수 있습니다.

PowerShell 7.4부터 세션의 속성이 후속 요청에서 재정의되지 않는 한 웹 요청 세션은 영구적입니다. 이 경우 cmdlet은 새 값을 사용하여 세션을 다시 만듭니다. 영구 세션은 반복된 요청에 대한 오버헤드를 줄여 훨씬 더 빠르게 만듭니다.

후속 웹 요청에서 웹 요청 세션을 사용하려면 WebSession 매개 변수 값에 세션 변수를 지정합니다. PowerShell은 새 연결을 설정할 때 웹 요청 세션 개체의 데이터를 사용합니다. 웹 요청 세션의 값을 재정의하려면 UserAgent 또는 Credential과 같은 cmdlet 매개 변수를 사용합니다. 매개 변수 값이 웹 요청 세션의 값보다 우선합니다.

동일한 명령에서는 SessionVariable 및 WebSession 매개 변수를 사용할 수 없습니다.

Type:	String
Aliases:	SV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipCertificateCheck

만료, 해지, 신뢰할 수 있는 루트 기관 등과 같은 모든 유효성 검사를 포함하는 인증서 유효성 검사 검사 건너뜁니다.

Warning

이 매개 변수를 사용하는 것은 안전하지 않으며 권장되지 않습니다. 이 스위치는 테스트 목적으로 자체 서명된 인증서를 사용하는 알려진 호스트에 대해서만 사용됩니다. 사용자 고유의 위험에 사용합니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipHeaderValidation

cmdlet이 유효성 검사 없이 요청에 헤더를 추가해야 함을 나타냅니다.

이 스위치는 표준을 준수하지 않는 헤더 값이 필요한 사이트에 사용해야 합니다. 이 스위치를 지정하면 값을 검사 전달할 수 있도록 유효성 검사가 비활성화됩니다. 지정하면 모든 헤더가 유효성 검사 없이 추가됩니다.

이렇게 하면 ContentType, Headers 및 UserAgent 매개 변수에 전달된 값에 대한 유효성 검사가 비활성화됩니다.

이 기능은 PowerShell 6.0.0에 추가되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipHttpErrorCheck

이 매개 변수를 사용하면 cmdlet이 HTTP 오류 상태 무시하고 응답을 계속 처리합니다. 오류 응답은 성공한 것처럼 파이프라인에 기록됩니다.

이 매개 변수는 PowerShell 7에서 도입되었습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SslProtocol

웹 요청에 허용되는 SSL/TLS 프로토콜을 설정합니다. 기본적으로 시스템에서 지원하는 SSL/TLS 프로토콜이 모두 허용됩니다. SslProtocol 을 사용하면 규정 준수를 위해 특정 프로토콜로 제한할 수 있습니다.

이러한 값은 플래그 기반 열거형으로 정의됩니다. 이 매개 변수를 사용하여 여러 값을 결합하여 여러 플래그를 설정할 수 있습니다. 값은 값 배열 또는 해당 값의 쉼표로 구분된 문자열로 SslProtocol 매개 변수에 전달될 수 있습니다. cmdlet은 이진 OR 연산을 사용하여 값을 결합합니다. 값을 배열로 전달하는 것이 가장 간단한 옵션이며 값에 대한 탭 완성을 사용할 수도 있습니다. 모든 플랫폼에서 여러 값을 제공하지 못할 수 있습니다.

참고 항목

비 Windows 플랫폼에서는 제공 Tls 하거나 Tls12 옵션으로 제공하지 못할 수 있습니다. Tls13 지원은 모든 운영 체제에서 사용할 수 없으며 운영 체제별로 확인해야 합니다.

이 기능은 PowerShell 6.0.0에 추가되었으며 PowerShell 7.1에 대한 Tls13 지원이 추가되었습니다.

Type:	WebSslProtocol
Accepted values:	Default, Tls, Tls11, Tls12, Tls13
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StatusCodeVariable

요청의 HTTP 상태 코드 결과를 포함하는 변수를 만듭니다. 달러 기호($) 기호 없이 변수 이름을 입력합니다.

매개 변수는 SkipHttpErrorCheck 매개 변수와 함께 사용할 때 성공 메시지 또는 실패 메시지를 식별할 수 있습니다.

매개 변수의 변수 이름을 다음과 같은 -StatusCodeVariable "scv"문자열로 입력합니다.

이 매개 변수는 PowerShell 7에서 도입되었습니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Token

요청에 포함할 OAuth 또는 전달자 토큰입니다. 토큰 은 특정 인증 옵션에 필요합니다. 독립적으로 사용할 수 없습니다.

토큰은 토큰 을 SecureString 포함하는 토큰을 사용합니다. 토큰을 제공하려면 다음을 수동으로 사용합니다.

Invoke-RestMethod -Uri $uri -Authentication OAuth -Token (Read-Host -AsSecureString)

이 매개 변수는 PowerShell 6.0에서 도입되었습니다.

Type:	SecureString
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TransferEncoding

전송 인코딩 HTTP 응답 헤더의 값을 지정합니다. 이 매개 변수에 허용되는 값은 다음과 같습니다.

청크 분할
압축
폐
GZip
ID

Type:	String
Accepted values:	chunked, compress, deflate, gzip, identity
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UnixSocket

연결할 Unix 소켓의 이름을 지정합니다. 이 매개 변수는 Unix 기반 시스템 및 Windows 버전 1803 이상에서 지원됩니다. Unix 소켓의 Windows 지원에 대한 자세한 내용은 AF_UNIX 블로그 게시물과 함께 Windows/WSL Interop을 참조하세요.

이 매개 변수는 PowerShell 7.4에 추가되었습니다.

Type:	UnixDomainSocketEndPoint
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Uri

웹 요청을 보낼 인터넷 리소스의 URI(Uniform Resource Identifier)를 지정합니다. 이 매개 변수는 HTTP, HTTPS, FTP 및 FILE 값을 지원합니다.

이 매개 변수는 필수입니다. 매개 변수 이름(Uri)은 선택 사항입니다.

Type:	Uri
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UseBasicParsing

이 매개 변수는 더 이상 사용되지 않습니다. PowerShell 6.0.0부터 모든 웹 요청은 기본 구문 분석만 사용합니다. 이 매개 변수는 이전 버전과의 호환성을 위해서만 포함되며 이 매개 변수를 사용하면 cmdlet 작업에 영향을 주지 않습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseDefaultCredentials

cmdlet이 현재 사용자의 자격 증명을 사용하여 웹 요청을 보내도록 나타냅니다. 인증 또는 자격 증명과 함께 사용할 수 없으며 모든 플랫폼에서 지원되지 않을 수 있습니다.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAgent

웹 요청에 대한 사용자 에이전트 문자열을 지정합니다.

기본 사용자 에이전트는 각 운영 체제 및 플랫폼에 대한 약간의 변형과 유사 Mozilla/5.0 (Windows NT 10.0; Microsoft Windows 10.0.15063; en-US) PowerShell/6.0.0 합니다.

대부분의 인터넷 브라우저에서 사용되는 표준 사용자 에이전트 문자열을 사용하여 웹 사이트를 테스트하려면 Chrome, FireFox, InternetExplorer, Opera 및 Safari와 같은 PSUserAgent 클래스의 속성을 사용합니다.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WebSession

웹 요청 세션을 지정합니다. 달러 기호($)를 포함하여 변수 이름을 입력합니다.

웹 요청 세션의 값을 재정의하려면 UserAgent 또는 Credential과 같은 cmdlet 매개 변수를 사용합니다. 매개 변수 값이 웹 요청 세션의 값보다 우선합니다. MultipartFormDataContent 개체가 Body에 제공될 때와 같은 Content-Type콘텐츠 관련 헤더도 재정의됩니다.

원격 세션과 달리 웹 요청 세션은 영구 연결이 아닙니다. 쿠키, 자격 증명, 최대 리디렉션 값 및 사용자 에이전트 문자열을 포함하여 연결 및 요청에 대한 정보를 포함하는 개체입니다. 웹 요청 간에 상태 및 데이터를 공유하는 데 사용할 수 있습니다.

웹 요청 세션을 만들려면 명령의 SessionVariable 매개 변수 Invoke-RestMethod 값에 달러 기호 없이 변수 이름을 입력합니다. Invoke-RestMethod 는 세션을 만들고 변수에 저장합니다. 후속 명령에서 변수를 WebSession 매개 변수의 값으로 사용합니다.

동일한 명령에서는 SessionVariable 및 WebSession 매개 변수를 사용할 수 없습니다.

Type:	WebRequestSession
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

입력

Object

웹 요청의 본문을 이 cmdlet으로 파이프할 수 있습니다.

출력

Int64

요청에서 정수가 반환되면 이 cmdlet은 해당 정수를 반환합니다.

String

요청이 문자열을 반환하면 이 cmdlet은 해당 문자열을 반환합니다.

XmlDocument

요청이 유효한 XML을 반환하면 이 cmdlet은 XmlDocument로 반환합니다.

PSObject

요청이 JSON 문자열을 반환하면 이 cmdlet은 데이터를 나타내는 PSObject를 반환합니다.

참고

PowerShell에는 다음 별칭이 포함됩니다.Invoke-RestMethod

모든 플랫폼:
- irm

일부 기능은 일부 플랫폼에서 사용할 수 없습니다.

.NET Core 3.1의 변경으로 인해 PowerShell 7.0 이상에서는 HttpClient.DefaultProxy 속성을 사용하여 프록시 구성을 확인합니다.

이 속성의 값은 플랫폼에 따라 다른 규칙입니다.

Windows: 환경 변수에서 프록시 구성을 읽거나, 정의되지 않은 경우 사용자의 프록시 설정에서 프록시 구성을 읽습니다.
macOS: 환경 변수에서 프록시 구성을 읽거나, 정의되지 않은 경우 시스템의 프록시 설정에서 프록시 구성을 읽습니다.
Linux: 환경 변수에서 프록시 구성을 읽거나 정의되지 않은 경우 이 속성은 모든 주소를 우회하는 구성되지 않은 인스턴스를 초기화합니다.

Windows 및 Unix 기반 플랫폼에서 DefaultProxy 초기화에 사용되는 환경 변수는 다음과 같습니다.

HTTP_PROXY: HTTP 요청에 사용되는 프록시 서버의 호스트 이름 또는 IP 주소입니다.
HTTPS_PROXY: HTTPS 요청에 사용되는 프록시 서버의 호스트 이름 또는 IP 주소입니다.
ALL_PROXY: HTTP 및 HTTPS 요청에 사용되는 프록시 서버의 호스트 이름 또는 IP 주소입니다(예: 정의되지 않은 경우 HTTP_PROXYHTTPS_PROXY ).
NO_PROXY: 프록시에서 제외해야 하는 쉼표로 구분된 호스트 이름 목록입니다.

PowerShell 7.4는 Brotli 압축 알고리즘에 대한 지원을 추가했습니다.

Invoke-RestMethod

Syntax

Description

예제

예제 1: PowerShell RSS 피드 가져오기

예제 2: POST 요청 실행

예제 3: 관계 링크 팔로우

예제 4: 간소화된 다중 파트/양식 데이터 제출

예제 5: 여러 헤더 전달

예제 6: 파이프라인에서 반환된 항목 열거

예제 7: 헤더 유효성 검사 건너뛰기

예제 8: HTTP 2.0을 사용하여 요청 보내기

예제 9: Unix 소켓 애플리케이션에 요청 보내기

매개 변수

-AllowInsecureRedirect

-AllowUnencryptedAuthentication

-Authentication

-Body

-Certificate

-CertificateThumbprint

-ConnectionTimeoutSeconds

-ContentType

-Credential

-CustomMethod

-DisableKeepAlive

-FollowRelLink

-Form

-Headers

-HttpVersion

-InFile

-MaximumFollowRelLink

-MaximumRedirection

-MaximumRetryCount

-Method

-NoProxy

-OperationTimeoutSeconds

-OutFile

-PassThru

-PreserveAuthorizationOnRedirect

-PreserveHttpMethodOnRedirect

-Proxy

-ProxyCredential

-ProxyUseDefaultCredentials

-ResponseHeadersVariable

-Resume

-RetryIntervalSec

-SessionVariable

-SkipCertificateCheck

-SkipHeaderValidation

-SkipHttpErrorCheck

-SslProtocol

-StatusCodeVariable

-Token

-TransferEncoding

-UnixSocket

-Uri

-UseBasicParsing

-UseDefaultCredentials

-UserAgent

-WebSession

입력

출력

참고

관련 링크

피드백

추가 리소스