Udostępnij przez


Certificate - List By Batch Account

Wyświetla listę wszystkich certyfikatów na określonym koncie.
Ostrzeżenie: Ta operacja jest przestarzała i zostanie usunięta po lutym 2024 r. Zamiast tego użyj rozszerzenia 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}

Parametry URI

Nazwa W Wymagane Typ Opis
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-zA-Z0-9]+$

Nazwa konta wsadowego, która musi być unikalna w danym regionie. Nazwy kont wsadowych muszą mieć długość od 3 do 24 znaków i zawierać jedynie cyfry oraz małe litery. Ta nazwa jest używana jako część nazwy DNS, która służy do dostępu do usługi Batch w regionie, w którym konto zostało utworzone. Na przykład: http://accountname.region.batch.azure.com/.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

subscriptionId
path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

$filter
query

string

Wyrażenie filtru OData. Prawidłowe właściwości filtrowania to "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".

$select
query

string

Rozdzielona przecinkami lista właściwości, które powinny być zwracane. np. "properties/provisioningState". Tylko właściwości najwyższego poziomu we właściwościach/ są prawidłowe dla zaznaczenia.

maxresults
query

integer (int32)

Maksymalna liczba elementów do zwrócenia w odpowiedzi.

Odpowiedzi

Nazwa Typ Opis
200 OK

ListCertificatesResult

Operacja platformy Azure została zakończona pomyślnie.

Other Status Codes

CloudError

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 w usłudze Azure Active Directory.

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ListCertificates
ListCertificates - Filter and Select

ListCertificates

Przykładowa prośba

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

Przykładowa odpowiedź

{
  "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

Przykładowa prośba

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'

Przykładowa odpowiedź

{
  "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"
      }
    }
  ]
}

Definicje

Nazwa Opis
Certificate

Zawiera informacje o certyfikacie.

CertificateFormat

Format certyfikatu — Pfx lub Cer. W przypadku pominięcia wartość domyślna to Pfx.

CertificateProvisioningState
CloudError

Odpowiedź na błąd z usługi Batch.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

createdByType

Typ tożsamości, która utworzyła zasób.

DeleteCertificateError

Odpowiedź na błąd z usługi Batch.

ListCertificatesResult

Wartości zwracane przez operację Lista.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Certificate

Zawiera informacje o certyfikacie.

Nazwa Typ Opis
etag

string

Element ETag zasobu używany na potrzeby instrukcji współbieżności.

id

string (arm-id)

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nazwa zasobu

properties.deleteCertificateError

DeleteCertificateError

Błąd, który wystąpił podczas usuwania certyfikatu
Jest to zwracane tylko wtedy, gdy stan aprowizacji certyfikatu to "Niepowodzenie".

properties.format

CertificateFormat

Format certyfikatu — Pfx lub Cer. W przypadku pominięcia wartość domyślna to Pfx.

properties.previousProvisioningState

CertificateProvisioningState

Poprzedni stan aprowizacji zasobu

properties.previousProvisioningStateTransitionTime

string (date-time)

Czas, w którym certyfikat wprowadził swój poprzedni stan.

properties.provisioningState

CertificateProvisioningState

Stan aprowizacji zasobu

properties.provisioningStateTransitionTime

string (date-time)

Czas, w którym certyfikat wprowadził bieżący stan.

properties.publicData

string

Klucz publiczny certyfikatu.

properties.thumbprint

string

Odcisk palca certyfikatu.
Musi to być zgodne z odciskiem palca z nazwy.

properties.thumbprintAlgorithm

string

Algorytm odcisku palca certyfikatu.
Musi to być zgodna z pierwszą częścią nazwy certyfikatu. Obecnie wymagane jest użycie algorytmu "SHA1".

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.

tags

object

Tagi zasobu.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

CertificateFormat

Format certyfikatu — Pfx lub Cer. W przypadku pominięcia wartość domyślna to Pfx.

Wartość Opis
Pfx

Certyfikat jest certyfikatem PFX (PKCS#12) sformatowanym certyfikatem lub łańcuchem certyfikatów.

Cer

Certyfikat jest certyfikatem X.509 zakodowanym w formacie base64.

CertificateProvisioningState

Wartość Opis
Succeeded

Certyfikat jest dostępny do użycia w pulach.

Deleting

Użytkownik zażądał usunięcia certyfikatu, ale operacja usuwania nie została jeszcze ukończona. Nie można odwołać się do certyfikatu podczas tworzenia lub aktualizowania pul.

Failed

Użytkownik zażądał usunięcia certyfikatu, ale istnieją pule, które nadal zawierają odwołania do certyfikatu lub jest on nadal zainstalowany w co najmniej jednym węźle obliczeniowym. (Ten ostatni może wystąpić, jeśli certyfikat został usunięty z puli, ale węzeł nie został jeszcze uruchomiony ponownie. Węzły odświeżają swoje certyfikaty tylko po ponownym uruchomieniu). Możesz użyć operacji anulowania usuwania certyfikatu w celu anulowania usunięcia lub operacji usuwania certyfikatu w celu ponawiania próby usunięcia.

CloudError

Odpowiedź na błąd z usługi Batch.

Nazwa Typ Opis
error

CloudErrorBody

Treść odpowiedzi o błędzie.

CloudErrorBody

Odpowiedź na błąd z usługi Batch.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

CloudErrorBody[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

createdByType

Typ tożsamości, która utworzyła zasób.

Wartość Opis
User
Application
ManagedIdentity
Key

DeleteCertificateError

Odpowiedź na błąd z usługi Batch.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

DeleteCertificateError[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

ListCertificatesResult

Wartości zwracane przez operację Lista.

Nazwa Typ Opis
nextLink

string (uri)

Link do następnej strony z elementami

value

Certificate[]

Przedmioty certyfikatu na tej stronie

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string (date-time)

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string (date-time)

Znacznik czasu ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.