REST Resource: organizations.locations.postureDeployments

Resource: PostureDeployment

Detail untuk deployment Posture di organisasi, folder, atau project.

Anda dapat men-deploy maksimal satu postur ke setiap organisasi, folder, atau project. Resource induk untuk deployment postur selalu berupa organisasi, meskipun deployment berlaku untuk folder atau project.

Representasi JSON
{
  "name": string,
  "targetResource": string,
  "state": enum (State),
  "postureId": string,
  "postureRevisionId": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "reconciling": boolean,
  "desiredPostureId": string,
  "desiredPostureRevisionId": string,
  "failureMessage": string,
  "categories": [
    enum (Category)
  ]
}
Kolom
name

string

Wajib. ID. Nama deployment postur, dalam format organizations/{organization}/locations/global/postureDeployments/{deployment_id}.

targetResource

string

Wajib. Organisasi, folder, atau project tempat postur di-deploy. Menggunakan salah satu format berikut:

  • organizations/{organization_number}
  • folders/{folder_number}
  • projects/{project_number}
state

enum (State)

Hanya output. Status deployment postur.

postureId

string

Wajib. Postur yang digunakan dalam deployment, dalam format organizations/{organization}/locations/global/postures/{postureId}.

postureRevisionId

string

Wajib. ID revisi postur yang digunakan dalam deployment.

createTime

string (Timestamp format)

Hanya output. Waktu deployment postur dibuat.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Hanya output. Waktu saat deployment postur terakhir diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

description

string

Opsional. Deskripsi deployment postur.

etag

string

Opsional. ID buram untuk versi deployment postur saat ini.

Untuk mencegah update serentak menimpa satu sama lain, selalu berikan etag saat Anda mengupdate deployment postur. Anda juga dapat memberikan etag saat menghapus deployment postur, untuk membantu memastikan bahwa Anda menghapus deployment postur yang dimaksud.

annotations

map (key: string, value: string)

Opsional. Anotasi yang ditentukan pengguna untuk deployment postur.

Untuk mengetahui detail tentang nilai yang dapat Anda gunakan dalam anotasi, lihat AIP-148: Kolom standar.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

reconciling

boolean

Hanya output. Apakah deployment postur sedang dalam proses diperbarui.

desiredPostureId

string

Hanya output. ID postur yang ditentukan untuk deployment. Hanya ada jika deployment postur berada dalam status gagal.

desiredPostureRevisionId

string

Hanya output. ID revisi postur yang ditentukan untuk deployment. Hanya ada jika deployment dalam status gagal.

failureMessage

string

Hanya output. Deskripsi alasan deployment postur gagal. Hanya ada jika deployment dalam status gagal.

categories[]

enum (Category)

Hanya output. Kategori yang menjadi bagian dari deployment postur, seperti yang ditentukan oleh Security Posture API.

Negara bagian/Provinsi

Status PostureDeployment.

Enum
STATE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
CREATING Deployment postur sedang dibuat.
DELETING Deployment postur sedang dihapus.
UPDATING Deployment postur sedang diperbarui.
ACTIVE Deployment postur aktif dan digunakan.
CREATE_FAILED Deployment postur tidak dapat dibuat.
UPDATE_FAILED Deployment postur tidak dapat diperbarui.
DELETE_FAILED Deployment postur tidak dapat dihapus.

Metode

create

Membuat PostureDeployment baru di project dan lokasi tertentu.

delete

Menghapus PostureDeployment.

get

Mendapatkan detail untuk PostureDeployment.

list

Mencantumkan setiap PostureDeployment di project dan lokasi.

patch

Memperbarui PostureDeployment yang ada.