Class: DeploymentProfilesClient

Defined in: src/management/deployment-profiles.ts:23

Client for listing deployment profiles.

Constructors

Constructor

new DeploymentProfilesClient(opts): DeploymentProfilesClient;

Defined in: src/management/deployment-profiles.ts:28

Parameters

Parameter	Type
opts	DeploymentProfilesClientOptions

Returns

DeploymentProfilesClient

Methods

list()

list(opts?): Promise<objectOutputType<{
  deployment_profiles: ZodArray<ZodObject<{
     dp_name: ZodString;
     auth_code: ZodString;
     tsg_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     expiration_date: ZodOptional<ZodString>;
     ave_text_records: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     dp_name: ZodString;
     auth_code: ZodString;
     tsg_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     expiration_date: ZodOptional<ZodString>;
     ave_text_records: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     dp_name: ZodString;
     auth_code: ZodString;
     tsg_id: ZodOptional<ZodString>;
     status: ZodOptional<ZodString>;
     expiration_date: ZodOptional<ZodString>;
     ave_text_records: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>, "many">;
  status: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/management/deployment-profiles.ts:49

List deployment profiles for the TSG.

Parameters

Parameter	Type	Description
opts?	DeploymentProfileListOptions	Optional filter options.

Returns

Promise<objectOutputType<{ deployment_profiles: ZodArray<ZodObject<{ dp_name: ZodString; auth_code: ZodString; tsg_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; expiration_date: ZodOptional<ZodString>; ave_text_records: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ dp_name: ZodString; auth_code: ZodString; tsg_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; expiration_date: ZodOptional<ZodString>; ave_text_records: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ dp_name: ZodString; auth_code: ZodString; tsg_id: ZodOptional<ZodString>; status: ZodOptional<ZodString>; expiration_date: ZodOptional<ZodString>; ave_text_records: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>, "many">; status: ZodString; }, ZodTypeAny, "passthrough">>

Deployment profiles response.

Example

import { ManagementClient } from '@cdot65/prisma-airs-sdk';
const mgmt = new ManagementClient(); // reads PANW_MGMT_* env vars

const result = await mgmt.deploymentProfiles.list({ unactivated: true });
// result =>
// { deployment_profiles: [ { dp_name: 'prod-dp', auth_code: 'ac', status: 'active' } ],
//   status: 'ok' }