@azure/arm-hybridconnectivity 1.0.0-beta.1

package/src/models/index.ts

@@ -0,0 +1,552 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import * as coreClient from "@azure/core-client";
+
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export interface OperationListResult {
+  /**
+   * List of operations supported by the resource provider
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly value?: Operation[];
+  /**
+   * URL to get the next set of operation list results (if there are any).
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly nextLink?: string;
+}
+
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export interface Operation {
+  /**
+   * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly isDataAction?: boolean;
+  /** Localized display information for this particular operation. */
+  display?: OperationDisplay;
+  /**
+   * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly origin?: Origin;
+  /**
+   * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly actionType?: ActionType;
+}
+
+/** Localized display information for this particular operation. */
+export interface OperationDisplay {
+  /**
+   * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provider?: string;
+  /**
+   * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly resource?: string;
+  /**
+   * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly operation?: string;
+  /**
+   * The short, localized friendly description of the operation; suitable for tool tips and detailed views.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly description?: string;
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export interface ErrorResponse {
+  /** The error object. */
+  error?: ErrorDetail;
+}
+
+/** The error detail. */
+export interface ErrorDetail {
+  /**
+   * The error code.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly code?: string;
+  /**
+   * The error message.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly message?: string;
+  /**
+   * The error target.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly target?: string;
+  /**
+   * The error details.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly details?: ErrorDetail[];
+  /**
+   * The error additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** The resource management error additional info. */
+export interface ErrorAdditionalInfo {
+  /**
+   * The additional info type.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * The additional info.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly info?: Record<string, unknown>;
+}
+
+/** The list of endpoints. */
+export interface EndpointsList {
+  /** The link used to get the next page of endpoints list. */
+  nextLink?: string;
+  /** The list of endpoint. */
+  value?: EndpointResource[];
+}
+
+/** Endpoint details */
+export interface EndpointProperties {
+  /** The type of endpoint. */
+  type: Type;
+  /** The resource Id of the connectivity endpoint (optional). */
+  resourceId?: string;
+  /**
+   * The resource provisioning state.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provisioningState?: string;
+}
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export interface Resource {
+  /**
+   * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly id?: string;
+  /**
+   * The name of the resource
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly name?: string;
+  /**
+   * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly type?: string;
+  /**
+   * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly systemData?: SystemData;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+  /** The identity that created the resource. */
+  createdBy?: string;
+  /** The type of identity that created the resource. */
+  createdByType?: CreatedByType;
+  /** The timestamp of resource creation (UTC). */
+  createdAt?: Date;
+  /** The identity that last modified the resource. */
+  lastModifiedBy?: string;
+  /** The type of identity that last modified the resource. */
+  lastModifiedByType?: CreatedByType;
+  /** The timestamp of resource last modification (UTC) */
+  lastModifiedAt?: Date;
+}
+
+/** The paginated list of serviceConfigurations */
+export interface ServiceConfigurationList {
+  /** The list of service configuration */
+  value?: ServiceConfigurationResource[];
+  /** The link to fetch the next page of connected cluster */
+  nextLink?: string;
+}
+
+/** The service details under service configuration for the target endpoint resource. */
+export interface ServiceConfigurationResourcePatch {
+  /** The port on which service is enabled. */
+  port?: number;
+}
+
+/** The details of the service for which credentials needs to be returned. */
+export interface ListCredentialsRequest {
+  /** The name of the service. If not provided, the request will by pass the generation of service configuration token */
+  serviceName?: ServiceName;
+}
+
+/** The endpoint access for the target resource. */
+export interface EndpointAccessResource {
+  /** The namespace name. */
+  namespaceName?: string;
+  /** The suffix domain name of relay namespace. */
+  namespaceNameSuffix?: string;
+  /** Azure Relay hybrid connection name for the resource. */
+  hybridConnectionName?: string;
+  /**
+   * Access key for hybrid connection.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly accessKey?: string;
+  /** The expiration of access key in unix time. */
+  expiresOn?: number;
+  /** The token to access the enabled service. */
+  serviceConfigurationToken?: string;
+}
+
+/** Represent ListIngressGatewayCredentials Request object. */
+export interface ListIngressGatewayCredentialsRequest {
+  /** The name of the service. */
+  serviceName?: ServiceName;
+}
+
+/** The ingress gateway access credentials */
+export interface IngressGatewayResource {
+  /** The ingress hostname. */
+  hostname?: string;
+  /** The arc ingress gateway server app id. */
+  serverId?: string;
+  /** The target resource home tenant id. */
+  tenantId?: string;
+  /** The namespace name. */
+  namespaceName?: string;
+  /** The suffix domain name of relay namespace. */
+  namespaceNameSuffix?: string;
+  /** Azure Relay hybrid connection name for the resource. */
+  hybridConnectionName?: string;
+  /**
+   * Access key for hybrid connection.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly accessKey?: string;
+  /** The expiration of access key in unix time. */
+  expiresOn?: number;
+  /** The token to access the enabled service. */
+  serviceConfigurationToken?: string;
+}
+
+/** Represent ManageProxy Request object. */
+export interface ManagedProxyRequest {
+  /** The name of the service. */
+  service: string;
+  /** The target host name. */
+  hostname?: string;
+  /** The name of the service. It is an optional property, if not provided, service configuration tokens issue code would be by passed. */
+  serviceName?: ServiceName;
+}
+
+/** Managed Proxy */
+export interface ManagedProxyResource {
+  /** The short lived proxy name. */
+  proxy: string;
+  /** The expiration time of short lived proxy name in unix epoch. */
+  expiresOn: number;
+}
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {}
+
+/** The endpoint for the target resource. */
+export interface EndpointResource extends ProxyResource {
+  /** The endpoint properties. */
+  properties?: EndpointProperties;
+}
+
+/** The service configuration details associated with the target resource. */
+export interface ServiceConfigurationResource extends ProxyResource {
+  /** Name of the service. */
+  serviceName?: ServiceName;
+  /** The resource Id of the connectivity endpoint (optional). */
+  resourceId?: string;
+  /** The port on which service is enabled. */
+  port?: number;
+  /**
+   * The resource provisioning state.
+   * NOTE: This property will not be serialized. It can only be populated by the server.
+   */
+  readonly provisioningState?: ProvisioningState;
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export enum KnownOrigin {
+  /** User */
+  User = "user",
+  /** System */
+  System = "system",
+  /** UserSystem */
+  UserSystem = "user,system"
+}
+
+/**
+ * Defines values for Origin. \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **user** \
+ * **system** \
+ * **user,system**
+ */
+export type Origin = string;
+
+/** Known values of {@link ActionType} that the service accepts. */
+export enum KnownActionType {
+  /** Internal */
+  Internal = "Internal"
+}
+
+/**
+ * Defines values for ActionType. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Internal**
+ */
+export type ActionType = string;
+
+/** Known values of {@link Type} that the service accepts. */
+export enum KnownType {
+  /** Default */
+  Default = "default",
+  /** Custom */
+  Custom = "custom"
+}
+
+/**
+ * Defines values for Type. \
+ * {@link KnownType} can be used interchangeably with Type,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **default** \
+ * **custom**
+ */
+export type Type = string;
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export enum KnownCreatedByType {
+  /** User */
+  User = "User",
+  /** Application */
+  Application = "Application",
+  /** ManagedIdentity */
+  ManagedIdentity = "ManagedIdentity",
+  /** Key */
+  Key = "Key"
+}
+
+/**
+ * Defines values for CreatedByType. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export type CreatedByType = string;
+
+/** Known values of {@link ServiceName} that the service accepts. */
+export enum KnownServiceName {
+  /** SSH */
+  SSH = "SSH",
+  /** WAC */
+  WAC = "WAC"
+}
+
+/**
+ * Defines values for ServiceName. \
+ * {@link KnownServiceName} can be used interchangeably with ServiceName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **SSH** \
+ * **WAC**
+ */
+export type ServiceName = string;
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export enum KnownProvisioningState {
+  /** Succeeded */
+  Succeeded = "Succeeded",
+  /** Creating */
+  Creating = "Creating",
+  /** Updating */
+  Updating = "Updating",
+  /** Failed */
+  Failed = "Failed",
+  /** Canceled */
+  Canceled = "Canceled"
+}
+
+/**
+ * Defines values for ProvisioningState. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded** \
+ * **Creating** \
+ * **Updating** \
+ * **Failed** \
+ * **Canceled**
+ */
+export type ProvisioningState = string;
+
+/** Optional parameters. */
+export interface OperationsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type OperationsListResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface OperationsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type OperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface EndpointsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type EndpointsListResponse = EndpointsList;
+
+/** Optional parameters. */
+export interface EndpointsGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type EndpointsGetResponse = EndpointResource;
+
+/** Optional parameters. */
+export interface EndpointsCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdate operation. */
+export type EndpointsCreateOrUpdateResponse = EndpointResource;
+
+/** Optional parameters. */
+export interface EndpointsUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the update operation. */
+export type EndpointsUpdateResponse = EndpointResource;
+
+/** Optional parameters. */
+export interface EndpointsDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface EndpointsListCredentialsOptionalParams
+  extends coreClient.OperationOptions {
+  /** Object of type ListCredentialsRequest */
+  listCredentialsRequest?: ListCredentialsRequest;
+  /** The is how long the endpoint access token is valid (in seconds). */
+  expiresin?: number;
+}
+
+/** Contains response data for the listCredentials operation. */
+export type EndpointsListCredentialsResponse = EndpointAccessResource;
+
+/** Optional parameters. */
+export interface EndpointsListIngressGatewayCredentialsOptionalParams
+  extends coreClient.OperationOptions {
+  /** The is how long the endpoint access token is valid (in seconds). */
+  expiresin?: number;
+  /** Object of type ListIngressGatewayCredentialsRequest */
+  listIngressGatewayCredentialsRequest?: ListIngressGatewayCredentialsRequest;
+}
+
+/** Contains response data for the listIngressGatewayCredentials operation. */
+export type EndpointsListIngressGatewayCredentialsResponse = IngressGatewayResource;
+
+/** Optional parameters. */
+export interface EndpointsListManagedProxyDetailsOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listManagedProxyDetails operation. */
+export type EndpointsListManagedProxyDetailsResponse = ManagedProxyResource;
+
+/** Optional parameters. */
+export interface EndpointsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type EndpointsListNextResponse = EndpointsList;
+
+/** Optional parameters. */
+export interface ServiceConfigurationsListByEndpointResourceOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByEndpointResource operation. */
+export type ServiceConfigurationsListByEndpointResourceResponse = ServiceConfigurationList;
+
+/** Optional parameters. */
+export interface ServiceConfigurationsGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type ServiceConfigurationsGetResponse = ServiceConfigurationResource;
+
+/** Optional parameters. */
+export interface ServiceConfigurationsCreateOrupdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrupdate operation. */
+export type ServiceConfigurationsCreateOrupdateResponse = ServiceConfigurationResource;
+
+/** Optional parameters. */
+export interface ServiceConfigurationsUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the update operation. */
+export type ServiceConfigurationsUpdateResponse = ServiceConfigurationResource;
+
+/** Optional parameters. */
+export interface ServiceConfigurationsDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface ServiceConfigurationsListByEndpointResourceNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listByEndpointResourceNext operation. */
+export type ServiceConfigurationsListByEndpointResourceNextResponse = ServiceConfigurationList;
+
+/** Optional parameters. */
+export interface HybridConnectivityManagementAPIOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}