Auf dieser Seite wird beschrieben, wie Sie Secrets und Secret-Versionen in Secret Manager filtern. In Umgebungen mit zahlreichen Secrets können Sie mithilfe des Filters schnell bestimmte Secrets oder Versionen finden, ohne manuell durch die gesamte Liste scrollen zu müssen. Sie können nach Kriterien wie Labels, Erstellungsdatum oder bestimmten Mustern in geheimen Namen filtern, um bestimmte Gruppen von Geheimnissen gezielt zu verwalten.
In Secret Manager können Sie mit der Option Filter in der Google Cloud Console oder durch Angabe von Filterkriterien in einem API-Aufruf nach Geheimnissen und Geheimversionsvarianten filtern. In der Google Cloud CLI können Sie Secrets und Secret-Versionen filtern, indem Sie beim Auflisten von Secrets einen filter
-String angeben.
Secrets filtern
Sie haben folgende Möglichkeiten, ein Secret zu filtern:
Console
-
Rufen Sie in der Google Cloud Console die Seite Secret Manager auf.
-
Klicken Sie auf der Seite Secret Manager auf den Tab Regionale Secrets.
-
Klicken Sie in der Tabelle Regionale Secrets in das Feld Filter.
-
Wählen Sie ein Filterattribut und den entsprechenden Wert aus, z. B.
Location:asia-east1
.Die Tabelle wird automatisch anhand der eingegebenen Werte gefiltert. Die Ergebnisse werden in aufsteigender Reihenfolge nach Name sortiert.
gcloud
Ersetzen Sie folgende Werte, bevor sie einen der Befehlsdaten verwenden:
- LOCATION: den Speicherort des Geheimnisses in Google Cloud
- FILTER: Der Filterstring, z. B.
name:asecret OR name:bsecret
. Die gcloud CLI unterstützt auch reguläre Ausdrücke, z. B.name ~ "secret_ab.*"
.
Führen Sie folgenden Befehl aus:
Linux, macOS oder Cloud Shell
gcloud secrets list --location=LOCATION --filter="FILTER"
Windows (PowerShell)
gcloud secrets list --location=LOCATION --filter="FILTER"
Windows (cmd.exe)
gcloud secrets list --location=LOCATION --filter="FILTER"
REST
Ersetzen Sie diese Werte in den folgenden Anfragedaten:
- LOCATION: den Speicherort des Geheimnisses in Google Cloud
- PROJECT_ID: die Google Cloud-Projekt-ID
- FILTER: den Filterstring. Filter werden als
filter
-Abfragestringparameter angegeben und müssen URL-codiert sein. Der Filtername:asecret OR name:bsecret
wäre beispielsweise alsname%3Aasecret+OR+name%3Absecret
URL-codiert. Reguläre Ausdrücke werden in der API nicht unterstützt.
HTTP-Methode und URL:
GET https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets?filter=FILTER
JSON-Text der Anfrage:
{}
Wenn Sie die Anfrage senden möchten, wählen Sie eine der folgenden Optionen aus:
curl
Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json
und führen Sie den folgenden Befehl aus:
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets?filter=FILTER"
PowerShell
Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json
und führen Sie den folgenden Befehl aus:
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method GET `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets?filter=FILTER" | Select-Object -Expand Content
Sie sollten in etwa folgende JSON-Antwort erhalten:
{ "secrets": [ { "name": "projects/PROJECT_ID/locations/LOCATION/secrets/SECRET_ID", "createTime": "2024-09-02T07:14:00.281541Z", "etag": "\"16211dd90b37e7\"" } ] }
Go
Um diesen Code auszuführen, müssen Sie zuerst eine Go-Entwicklungsumgebung einrichten und das Secret Manager Go SDK installieren. In Compute Engine oder GKE müssen Sie sich mit dem Bereich cloud-platform authentifizieren.
Java
Um diesen Code auszuführen, müssen Sie zuerst eine Java-Entwicklungsumgebung einrichten und das Secret Manager Java SDK installieren. In Compute Engine oder GKE müssen Sie sich mit dem Bereich cloud-platform authentifizieren.
Python
Um diesen Code auszuführen, müssen Sie zuerst eine Python-Entwicklungsumgebung einrichten und das Secret Manager Python SDK installieren. In Compute Engine oder GKE müssen Sie sich mit dem Bereich cloud-platform authentifizieren.
Secret-Version filtern
So filtern Sie eine geheime Version:
-
Wählen Sie in der Google Cloud Console ein Geheimnis aus, um auf seine Versionen zuzugreifen, und verwenden Sie dann die Option Filter in der Tabelle Versionen.
-
Wenn Sie die Google Cloud CLI oder die Secret Manager API verwenden, fügen Sie beim Auflisten von Secret-Versionen einen
filter
-String hinzu.
Beispiele für Filter
Anwendungsfall | Filter |
---|---|
Secrets, deren Name den Teilstring mysecret enthält |
name:mysecret |
Secrets mit einem bestimmten Label | labels.environment=production |
Secrets, die innerhalb des Datums-/Zeitbereichs erstellt wurden | create_time<2021-01-01T06:00:00Z AND create_time>2021-01-01T12:00:00Z |
Secrets mit automatischer Replikation | replication.automatic:* |
Secrets mit vom Nutzer verwalteter Replikation, die aber in keiner der angegebenen Regionen gespeichert sind | replication.user_managed.replicas.location:* AND NOT replication.user_managed.replicas.location:(us-central1 OR us-east1) |
Mit CMEK-Schlüsseln verschlüsselte Secrets | replication.user_managed.replicas.customerManagedEncryption:* |
Secrets, die mit einem bestimmten CMEK-Schlüssel verschlüsselt wurden | replication.user_managed.replicas.customerManagedEncryption.kmsKeyName=projects/p/locations/us-central1/keyRings/kr/cryptoKeys/my-cmek-key |
Secrets ohne Rotationszeitraum | NOT rotation.next_rotation_time:* |
Secrets mit einem Rotationszeitraum > 30 d | rotation.rotation_period>259200s |
Secrets mit festgelegtem Ablauf | expire_time:* |
Secrets, die vor einem Datum ablaufen | expire_time<2021-07-31 |
Aktivierte oder deaktivierte Versionen | state:(ENABLED OR DISABLED) |
Nach dem Datum gelöschte Versionen | state:DESTROYED AND destroy_time>2021-01-01 |
Filtersyntax
Die Filtersyntax besteht aus einem Ausdruck für ein oder mehrere Felder der zu filternden Objekte.
Sie können die folgenden Operatoren verwenden.
Operator | Beschreibung |
---|---|
= |
Gleich. |
> |
Größer als. |
< |
Kleiner als. |
>= |
Größer als oder gleich. |
<= |
Kleiner als oder gleich. |
!= - NOT |
Ungleich. Folgendes ist äquivalent:name!="topsecret" -name="topsecret" NOT name="topsecret"
|
: |
Eingrenzung. Dies ist ein Teilstring-Abgleich, bei dem die Groß- und Kleinschreibung nicht berücksichtigt wird.
Beispielsweise filtert |
AND |
Logisches UND.
Ein Leerzeichen ist gleichbedeutend mit |
OR |
Logisches ODER. |
* |
Platzhalter.
Kann eigenständig verwendet werden, wobei |
Wie bei der Cloud Search API werden OR
-Vorgänge vor AND
-Vorgängen ausgewertet, sofern nicht durch Klammern eine andere Reihenfolge explizit definiert wird.
Wenn nach time
-Werten gefiltert wird, codieren Sie die Zeit als einen String im RFC 3399-Format. Beispiel: 2020-10-15T01:30:15Z
Verwenden Sie für den Zugriff auf ein untergeordnetes Feld die Punktsyntax. Die Ressource Secret kann beispielsweise das Feld labels
enthalten, dessen Wert ein Schlüssel/Wert-Paar map
ist.
Wenn ein color
-Label verwendet wird, können Sie Secret
-Ergebnisse so nach dem Unterfeld labels.color
filtern:
labels.color=red
Wenn Sie nur Secrets mit dem Label color
auflisten möchten, verwenden Sie einen Platzhalter:
labels.color:*
Ein String in Anführungszeichen wird als einzelner Wert und nicht als Folge von Werten interpretiert.
Felder filtern
Sie können nach einem beliebigen Feld des Objekts Secret
oder SecretVersion
filtern.
List-Methode | Link zu filterbaren Feldern |
---|---|
projects.secrets.list
|
Secret-Felder |
projects.secrets.versions.list
|
SecretVersion-Felder |
Gesamtzahl der Ergebnisse
Wennfilter
in einer Auflistungsanfrage festgelegt ist, gibt die Antwort nicht die Gesamtzahl der Ergebnisse (total_size=0
in der Antwort) an.