Class PrivateNetworkAPI

constructor

• new PrivateNetworkAPI(client: Client): AppleSilicon.v1alpha1.PrivateNetworkAPI

• Parameters

  • client: Client

  Returns AppleSilicon.v1alpha1.PrivateNetworkAPI

Static ReadonlyLOCALITIES

addServerPrivateNetwork

• addServerPrivateNetwork(
      request: Readonly<
          AppleSilicon.v1alpha1.PrivateNetworkApiAddServerPrivateNetworkRequest,
      >,
  ): Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

• Add a server to a Private Network. Add an Apple silicon server to a Private Network.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.PrivateNetworkApiAddServerPrivateNetworkRequest>

    The request PrivateNetworkApiAddServerPrivateNetworkRequest

  Returns Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

  A Promise of ServerPrivateNetwork

deleteServerPrivateNetwork

• deleteServerPrivateNetwork(
      request: Readonly<
          AppleSilicon.v1alpha1.PrivateNetworkApiDeleteServerPrivateNetworkRequest,
      >,
  ): Promise<void>

• Delete a Private Network.

  Parameters

  • request: Readonly<
        AppleSilicon.v1alpha1.PrivateNetworkApiDeleteServerPrivateNetworkRequest,
    >

    The request PrivateNetworkApiDeleteServerPrivateNetworkRequest

  Returns Promise<void>

getServerPrivateNetwork

• getServerPrivateNetwork(
      request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>,
  ): Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

• Parameters

  • request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>

  Returns Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

listServerPrivateNetworks

• listServerPrivateNetworks(
      request?: Readonly<
          AppleSilicon.v1alpha1.PrivateNetworkApiListServerPrivateNetworksRequest,
      >,
  ): Promise<AppleSilicon.v1alpha1.ListServerPrivateNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          AppleSilicon.v1alpha1.ServerPrivateNetwork[],
          void,
          void,
      >;
      all: () => Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork[]>;
  }

• List the Private Networks of a server. List the Private Networks of an Apple silicon server.

  Parameters

  • request: Readonly<
        AppleSilicon.v1alpha1.PrivateNetworkApiListServerPrivateNetworksRequest,
    > = {}

    The request PrivateNetworkApiListServerPrivateNetworksRequest

  Returns Promise<AppleSilicon.v1alpha1.ListServerPrivateNetworksResponse> & {
      "[asyncIterator]": () => AsyncGenerator<
          AppleSilicon.v1alpha1.ServerPrivateNetwork[],
          void,
          void,
      >;
      all: () => Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork[]>;
  }

  A Promise of ListServerPrivateNetworksResponse

setServerPrivateNetworks

• setServerPrivateNetworks(
      request: Readonly<
          AppleSilicon.v1alpha1.PrivateNetworkApiSetServerPrivateNetworksRequest,
      >,
  ): Promise<AppleSilicon.v1alpha1.SetServerPrivateNetworksResponse>

• Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.

  Parameters

  • request: Readonly<AppleSilicon.v1alpha1.PrivateNetworkApiSetServerPrivateNetworksRequest>

    The request PrivateNetworkApiSetServerPrivateNetworksRequest

  Returns Promise<AppleSilicon.v1alpha1.SetServerPrivateNetworksResponse>

  A Promise of SetServerPrivateNetworksResponse

waitForServerPrivateNetwork

• waitForServerPrivateNetwork(
      request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>,
      options?: Readonly<
          WaitForOptions<AppleSilicon.v1alpha1.ServerPrivateNetwork>,
      >,
  ): Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

• Waits for ServerPrivateNetwork to be in a final state.

  Parameters

  • request: Readonly<PrivateNetworkApiGetServerPrivateNetworkRequest>

    The request PrivateNetworkApiGetServerPrivateNetworkRequest
  • Optionaloptions: Readonly<WaitForOptions<AppleSilicon.v1alpha1.ServerPrivateNetwork>>

    The waiting options

  Returns Promise<AppleSilicon.v1alpha1.ServerPrivateNetwork>

  A Promise of ServerPrivateNetwork