Certificate - List By Batch Account
指定したアカウント内のすべての証明書を一覧表示します。
警告: この操作は非推奨となり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates?api-version=2024-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates?api-version=2024-07-01&maxresults={maxresults}&$select={$select}&$filter={$filter}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
account
|
path | True |
string minLength: 3maxLength: 24 pattern: ^[a-zA-Z0-9]+$ |
バッチアカウントの名前で、地域内で一意でなければならない。 バッチアカウント名は3文字から24文字の範囲で、数字と小文字のみを使用してください。 この名前は、アカウント作成地域のバッチサービスにアクセスするためのDNS名の一部として使われます。 たとえば、 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
$filter
|
query |
string |
OData フィルター式。 フィルター処理の有効なプロパティは、"properties/provisioningState"、"properties/provisioningStateTransitionTime"、"name" です。 |
|
|
$select
|
query |
string |
返されるプロパティのコンマ区切りリスト。 例: "properties/provisioningState"。 選択できるのは、プロパティ/ の下の最上位のプロパティのみです。 |
|
|
maxresults
|
query |
integer (int32) |
応答で返される項目の最大数。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azure 操作は正常に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
|
List |
|
List |
ListCertificates
要求のサンプル
応答のサンプル
{
"nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2024-07-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse",
"value": [
{
"name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
"type": "Microsoft.Batch/batchAccounts/certificates",
"id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
"properties": {
"format": "Pfx",
"provisioningState": "Succeeded",
"provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z",
"publicData": "MIICrjCCAZagAwI...",
"thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e",
"thumbprintAlgorithm": "sha1"
}
}
]
}
ListCertificates - Filter and Select
要求のサンプル
GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificates?api-version=2024-07-01&$select=properties/format,properties/provisioningState&$filter=properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'
応答のサンプル
{
"value": [
{
"name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
"type": "Microsoft.Batch/batchAccounts/certificates",
"id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e",
"properties": {
"format": "Pfx",
"provisioningState": "Failed"
}
},
{
"name": "sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
"type": "Microsoft.Batch/batchAccounts/certificates",
"id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1",
"properties": {
"format": "Cer",
"provisioningState": "Failed"
}
}
]
}
定義
| 名前 | 説明 |
|---|---|
| Certificate |
証明書に関する情報が含まれています。 |
|
Certificate |
証明書の形式 (Pfx または Cer)。 省略した場合、既定値は Pfx です。 |
|
Certificate |
|
|
Cloud |
Batch サービスからのエラー応答。 |
|
Cloud |
Batch サービスからのエラー応答。 |
|
created |
リソースを作成した ID の種類。 |
|
Delete |
Batch サービスからのエラー応答。 |
|
List |
List 操作によって返される値。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Certificate
証明書に関する情報が含まれています。
| 名前 | 型 | 説明 |
|---|---|---|
| etag |
string |
コンカレンシー ステートメントに使用されるリソースの ETag。 |
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
リソースの名前 |
| properties.deleteCertificateError |
証明書の削除中に発生したエラー |
|
| properties.format |
証明書の形式 (Pfx または Cer)。 省略した場合、既定値は Pfx です。 |
|
| properties.previousProvisioningState |
リソースの以前のプロビジョニング済み状態 |
|
| properties.previousProvisioningStateTransitionTime |
string (date-time) |
証明書が以前の状態になった時刻。 |
| properties.provisioningState |
リソースのプロビジョニング済み状態 |
|
| properties.provisioningStateTransitionTime |
string (date-time) |
証明書が現在の状態になった時刻。 |
| properties.publicData |
string |
証明書の公開キー。 |
| properties.thumbprint |
string |
証明書の拇印。 |
| properties.thumbprintAlgorithm |
string |
証明書の拇印のアルゴリズム。 |
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| tags |
object |
リソースのタグ。 |
| type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
CertificateFormat
証明書の形式 (Pfx または Cer)。 省略した場合、既定値は Pfx です。
| 値 | 説明 |
|---|---|
| Pfx |
証明書は PFX (PKCS#12) 形式の証明書または証明書チェーンです。 |
| Cer |
証明書は、base64 でエンコードされた X.509 証明書です。 |
CertificateProvisioningState
| 値 | 説明 |
|---|---|
| Succeeded |
証明書はプールで使用できます。 |
| Deleting |
ユーザーは証明書の削除を要求しましたが、削除操作はまだ完了していません。 プールの作成時または更新時に証明書を参照することはできません。 |
| Failed |
ユーザーは証明書の削除を要求しましたが、証明書への参照が残っているプールがあるか、1 つ以上のコンピューティング ノードにインストールされているプールがあります。 (後者は、証明書がプールから削除されているが、ノードがまだ再起動されていない場合に発生する可能性があります。ノードは、再起動時にのみ証明書を更新します)。証明書の削除の取り消し操作を使用して削除を取り消すか、削除を再試行する証明書の削除操作を使用できます。 |
CloudError
Batch サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー応答の本文。 |
CloudErrorBody
Batch サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| details |
エラーに関する追加の詳細の一覧。 |
|
| message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
| target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DeleteCertificateError
Batch サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| details |
エラーに関する追加の詳細の一覧。 |
|
| message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
| target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
ListCertificatesResult
List 操作によって返される値。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string (uri) |
項目の次のページへのリンク |
| value |
このページの証明書項目 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |