Certificate - List

참조

Service:: Batch Service

API Version:: 2023-11-01.18.0

지정된 계정에 추가된 모든 인증서를 나열합니다.
경고: 이 작업은 더 이상 사용되지 않으며 2024년 2월 이후에 제거됩니다. 대신 Azure KeyVault 확장을 사용하세요.

GET {batchUrl}/certificates?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/certificates?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
batchUrl	path	True	string	모든 Azure Batch 서비스 요청에 대한 기본 URL입니다.
api-version	query	True	string	클라이언트 API 버전.
$filter	query		string	OData $filter 절입니다. 이 필터를 생성하는 방법에 대한 자세한 내용은 를 참조하세요 https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.
$select	query		string	OData $select 절입니다.
maxresults	query		integer int32	응답에서 반환할 최대 항목 수입니다. 최대 1,000개의 인증서를 반환할 수 있습니다.
timeout	query		integer int32	서버에서 요청을 처리하는 데 소요할 수 있는 최대 시간(초)입니다. 기본값은 30초입니다.

요청 헤더

Media Types: "application/json; odata=minimalmetadata"

Name	형식	Description
client-request-id	string uuid	9C4D50EE-2D56-4CD3-8152-34347DC9F2B0과 같이 장식이 없는 GUID 형식의 호출자 생성 요청 ID입니다.
return-client-request-id	boolean	서버가 응답에서 client-request-id를 반환해야 하는지 여부입니다.
ocp-date	string date-time-rfc1123	요청이 실행된 시간입니다. 클라이언트 라이브러리는 일반적으로 이를 현재 시스템 클록 시간으로 설정합니다. REST API를 직접 호출하는 경우 명시적으로 설정합니다.

응답

Name	형식	Description
200 OK	CertificateListResult	인증서 목록을 포함하는 응답입니다. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 서비스의 오류입니다.

Name

형식

Description

200 OK

CertificateListResult

인증서 목록을 포함하는 응답입니다.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Batch 서비스의 오류입니다.

보안

azure_auth

OAuth 2.0 인증 코드 흐름 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

Authorization

Type: apiKey
In: header

예제

Certificate list

Sample Request

HTTP

GET account.region.batch.azure.com/certificates?api-version=2023-11-01.18.0

Sample Response

Status code:: 200

{
  "value": [
    {
      "thumbprint": "0123456789abcdef0123456789abcdef01234567",
      "thumbprintAlgorithm": "sha1",
      "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)",
      "state": "deletefailed",
      "stateTransitionTime": "2014-07-31T21:12:58.236Z",
      "previousState": "deleting",
      "previousStateTransitionTime": "2014-07-31T21:11:58.236Z",
      "publicData": "#####...",
      "deleteCertificateError": {
        "code": "PoolsReferencingCertificate",
        "message": "The specified certificate is being used by the below mentioned pool(s)",
        "values": [
          {
            "name": "Pools",
            "value": "mypool1"
          }
        ]
      }
    }
  ]
}

정의

Name	Description
BatchError	Azure Batch 서비스에서 받은 오류 응답입니다.
BatchErrorDetail	Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.
Certificate	컴퓨팅 노드에 설치할 수 있고 컴퓨터에서 작업을 인증하는 데 사용할 수 있는 인증서입니다.
CertificateListResult	계정에 인증서를 나열한 결과입니다.
CertificateState	인증서의 상태입니다.
DeleteCertificateError	인증서를 삭제할 때 Batch 서비스에서 발생하는 오류입니다.
ErrorMessage	Azure Batch 오류 응답에서 받은 오류 메시지입니다.
NameValuePair	이름-값 쌍을 나타냅니다.

BatchError

Azure Batch 서비스에서 받은 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	ErrorMessage	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.
values	BatchErrorDetail[]	오류에 대한 추가 세부 정보를 포함하는 키-값 쌍의 컬렉션입니다.

BatchErrorDetail

Azure Batch 오류 응답에 포함된 추가 정보의 항목입니다.

Name	형식	Description
key	string	Value 속성의 의미를 지정하는 식별자입니다.
value	string	오류 응답에 포함된 추가 정보입니다.

Certificate

컴퓨팅 노드에 설치할 수 있고 컴퓨터에서 작업을 인증하는 데 사용할 수 있는 인증서입니다.

Name	형식	Description
deleteCertificateError	DeleteCertificateError	이 인증서를 마지막으로 삭제하려고 할 때 발생한 오류입니다. 이 속성은 인증서가 DeleteFailed 상태인 경우에만 설정됩니다.
previousState	CertificateState	인증서의 이전 상태입니다. 인증서가 초기 활성 상태이면 이 속성이 설정되지 않습니다.
previousStateTransitionTime	string	인증서가 이전 상태로 진입한 시간입니다. 인증서가 초기 활성 상태이면 이 속성이 설정되지 않습니다.
publicData	string	base-64로 인코딩된 .cer 파일인 인증서의 공용 부분입니다.
state	CertificateState	인증서의 현재 상태입니다.
stateTransitionTime	string	인증서가 현재 상태를 입력한 시간입니다.
thumbprint	string	인증서의 X.509 지문입니다. 최대 4016자리 숫자의 시퀀스입니다.
thumbprintAlgorithm	string	지문을 파생하는 데 사용되는 알고리즘입니다.
url	string	인증서의 URL입니다.

CertificateListResult

계정에 인증서를 나열한 결과입니다.

Name	형식	Description
odata.nextLink	string	다음 결과 집합을 가져올 URL입니다.
value	Certificate[]	인증서 목록입니다.

CertificateState

인증서의 상태입니다.

Name	형식	Description
active	string	인증서는 풀에서 사용할 수 있습니다.
deletefailed	string	사용자가 인증서를 삭제하도록 요청했지만 여전히 인증서에 대한 참조가 있는 풀이 있거나 하나 이상의 노드에 여전히 설치되어 있습니다. (인증서가 풀에서 제거되었지만 컴퓨팅 노드가 아직 다시 시작되지 않은 경우 후자가 발생할 수 있습니다. 컴퓨팅 노드는 다시 시작할 때만 인증서를 새로 고칩니다.) 인증서 삭제 취소 작업을 사용하여 삭제를 취소하거나 인증서 삭제 작업을 사용하여 삭제를 다시 시도할 수 있습니다.
deleting	string	사용자가 인증서 삭제를 요청했지만 삭제 작업이 아직 완료되지 않았습니다. 풀을 만들거나 업데이트할 때 인증서를 참조할 수 없습니다.

DeleteCertificateError

인증서를 삭제할 때 Batch 서비스에서 발생하는 오류입니다.

Name	형식	Description
code	string	인증서 삭제 오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 인증서 삭제 오류를 설명하는 메시지입니다.
values	NameValuePair[]	인증서 삭제 오류와 관련된 추가 오류 세부 정보 목록입니다. 이 목록에는 이 인증서를 참조하는 활성 풀 및 컴퓨팅 노드와 같은 세부 정보가 포함됩니다. 그러나 많은 수의 리소스가 인증서를 참조하는 경우 목록에는 처음 100개 정도만 포함됩니다.

ErrorMessage

Azure Batch 오류 응답에서 받은 오류 메시지입니다.

Name	형식	Description
lang	string	오류 메시지의 언어 코드
value	string	메시지의 텍스트입니다.

NameValuePair

이름-값 쌍을 나타냅니다.

Name	형식	Description
name	string	이름-값 쌍의 이름입니다.
value	string	이름-값 쌍의 값입니다.

다음을 통해 공유

Certificate - List

URI 매개 변수

요청 헤더

응답

보안

azure_auth

Scopes

Authorization

예제

Certificate list

Sample Request

Sample Response

정의

BatchError

BatchErrorDetail

Certificate

CertificateListResult

CertificateState

DeleteCertificateError

ErrorMessage

NameValuePair

추가 리소스