Partilhar via


Certificate - List By Batch Account

Lista todos os certificados na conta especificada.
Aviso: Esta operação foi preterida e será removida após fevereiro de 2024. Em vez disso, use o Azure KeyVault Extension.

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}

Parâmetros URI

Nome Em Necessário Tipo Descrição
accountName
path True

string

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

Um nome para a conta do lote que deve ser único dentro da região. Os nomes das contas do lote devem ter entre 3 e 24 caracteres e devem usar apenas números e letras minúsculas. Este nome é usado como parte do nome DNS que serve para aceder ao serviço Batch na região onde a conta é criada. Por exemplo: http://accountname.region.batch.azure.com/.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

$filter
query

string

Expressão de filtro OData. As propriedades válidas para filtragem são "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".

$select
query

string

Lista separada por vírgulas das propriedades que devem ser retornadas. por exemplo, "propriedades/provisionamento". Apenas as propriedades de nível superior em propriedades/ são válidas para seleção.

maxresults
query

integer (int32)

O número máximo de itens a serem retornados na resposta.

Respostas

Nome Tipo Descrição
200 OK

ListCertificatesResult

Operação do Azure concluída com êxito.

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome Descrição
user_impersonation personificar a sua conta de utilizador

Exemplos

ListCertificates
ListCertificates - Filter and Select

ListCertificates

Pedido de exemplo

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

Resposta de exemplo

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

Pedido de exemplo

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'

Resposta de exemplo

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

Definições

Nome Descrição
Certificate

Contém informações sobre um certificado.

CertificateFormat

O formato do certificado - Pfx ou Cer. Se omitido, o padrão é Pfx.

CertificateProvisioningState
CloudError

Uma resposta de erro do serviço em lote.

CloudErrorBody

Uma resposta de erro do serviço em lote.

createdByType

O tipo de identidade que criou o recurso.

DeleteCertificateError

Uma resposta de erro do serviço em lote.

ListCertificatesResult

Valores retornados pela operação List.

systemData

Metadados referentes à criação e última modificação do recurso.

Certificate

Contém informações sobre um certificado.

Nome Tipo Descrição
etag

string

O ETag do recurso, usado para instruções de simultaneidade.

id

string (arm-id)

ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties.deleteCertificateError

DeleteCertificateError

O erro que ocorreu ao excluir o certificado
Isso só é retornado quando o provisionamento de certificadoState é 'Falha'.

properties.format

CertificateFormat

O formato do certificado - Pfx ou Cer. Se omitido, o padrão é Pfx.

properties.previousProvisioningState

CertificateProvisioningState

O estado provisionado anterior do recurso

properties.previousProvisioningStateTransitionTime

string (date-time)

A hora em que o certificado entrou no seu estado anterior.

properties.provisioningState

CertificateProvisioningState

O estado provisionado do recurso

properties.provisioningStateTransitionTime

string (date-time)

A hora em que o certificado entrou em seu estado atual.

properties.publicData

string

A chave pública do certificado.

properties.thumbprint

string

A impressão digital do certificado.
Isso deve corresponder à impressão digital do nome.

properties.thumbprintAlgorithm

string

O algoritmo da impressão digital do certificado.
Isso deve corresponder à primeira parte do nome do certificado. Atualmente é necessário ser 'SHA1'.

systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.

tags

object

As tags do recurso.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

CertificateFormat

O formato do certificado - Pfx ou Cer. Se omitido, o padrão é Pfx.

Valor Descrição
Pfx

O certificado é um certificado formatado PFX (PKCS#12) ou cadeia de certificados.

Cer

O certificado é um certificado X.509 codificado em base64.

CertificateProvisioningState

Valor Descrição
Succeeded

O certificado está disponível para uso em pools.

Deleting

O usuário solicitou que o certificado fosse excluído, mas a operação de exclusão ainda não foi concluída. Você não pode fazer referência ao certificado ao criar ou atualizar pools.

Failed

O usuário solicitou que o certificado fosse excluído, mas há pools que ainda têm referências ao certificado ou ele ainda está instalado em um ou mais nós de computação. (Este último pode ocorrer se o certificado tiver sido removido do pool, mas o nó ainda não tiver sido reiniciado. Os nós atualizam seus certificados somente quando são reiniciados.) Você pode usar a operação cancelar exclusão de certificado para cancelar a exclusão ou a operação excluir certificado para tentar novamente a exclusão.

CloudError

Uma resposta de erro do serviço em lote.

Nome Tipo Descrição
error

CloudErrorBody

O corpo da resposta de erro.

CloudErrorBody

Uma resposta de erro do serviço em lote.

Nome Tipo Descrição
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

createdByType

O tipo de identidade que criou o recurso.

Valor Descrição
User
Application
ManagedIdentity
Key

DeleteCertificateError

Uma resposta de erro do serviço em lote.

Nome Tipo Descrição
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

DeleteCertificateError[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

ListCertificatesResult

Valores retornados pela operação List.

Nome Tipo Descrição
nextLink

string (uri)

O link para a próxima página de itens

value

Certificate[]

Os itens do Certificado nesta página

systemData

Metadados referentes à criação e última modificação do recurso.

Nome Tipo Descrição
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.