@azure/arm-apicenter 1.0.0-beta.1

package/src/operationsInterfaces/services.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  Service,
+  ServicesListBySubscriptionOptionalParams,
+  ServicesListByResourceGroupOptionalParams,
+  ServicesGetOptionalParams,
+  ServicesGetResponse,
+  ServicesCreateOrUpdateOptionalParams,
+  ServicesCreateOrUpdateResponse,
+  ServicesUpdateOptionalParams,
+  ServicesUpdateResponse,
+  ServicesDeleteOptionalParams
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a Services. */
+export interface Services {
+  /**
+   * Lists services within an Azure subscription.
+   * @param options The options parameters.
+   */
+  listBySubscription(
+    options?: ServicesListBySubscriptionOptionalParams
+  ): PagedAsyncIterableIterator<Service>;
+  /**
+   * Lists services within a resource group
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param options The options parameters.
+   */
+  listByResourceGroup(
+    resourceGroupName: string,
+    options?: ServicesListByResourceGroupOptionalParams
+  ): PagedAsyncIterableIterator<Service>;
+  /**
+   * Get service
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName Service name
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    serviceName: string,
+    options?: ServicesGetOptionalParams
+  ): Promise<ServicesGetResponse>;
+  /**
+   * Create or update service
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName Service name
+   * @param options The options parameters.
+   */
+  createOrUpdate(
+    resourceGroupName: string,
+    serviceName: string,
+    options?: ServicesCreateOrUpdateOptionalParams
+  ): Promise<ServicesCreateOrUpdateResponse>;
+  /**
+   * Update service
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName Service name
+   * @param options The options parameters.
+   */
+  update(
+    resourceGroupName: string,
+    serviceName: string,
+    options?: ServicesUpdateOptionalParams
+  ): Promise<ServicesUpdateResponse>;
+  /**
+   * Delete service
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param serviceName Service name
+   * @param options The options parameters.
+   */
+  delete(
+    resourceGroupName: string,
+    serviceName: string,
+    options?: ServicesDeleteOptionalParams
+  ): Promise<void>;
+}

package/src/pagingHelper.ts

@@ -0,0 +1,39 @@
+/*
+ * 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.
+ */
+
+export interface PageInfo {
+  continuationToken?: string;
+}
+
+const pageMap = new WeakMap<object, PageInfo>();
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export function getContinuationToken(page: unknown): string | undefined {
+  if (typeof page !== "object" || page === null) {
+    return undefined;
+  }
+  return pageMap.get(page)?.continuationToken;
+}
+
+export function setContinuationToken(
+  page: unknown,
+  continuationToken: string | undefined
+): void {
+  if (typeof page !== "object" || page === null || !continuationToken) {
+    return;
+  }
+  const pageInfo = pageMap.get(page) ?? {};
+  pageInfo.continuationToken = continuationToken;
+  pageMap.set(page, pageInfo);
+}

package/tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "module": "es6",
+    "moduleResolution": "node",
+    "strict": true,
+    "target": "es6",
+    "sourceMap": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    "declaration": true,
+    "outDir": "./dist-esm",
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-apicenter": [
+        "./src/index"
+      ]
+    }
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts",
+    "samples-dev/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-apicenter.d.ts

@@ -0,0 +1,494 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+/**
+ * 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 declare type ActionType = string;
+
+export declare class AzureAPICenter extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the AzureAPICenter class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The ID of the target subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureAPICenterOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    operations: Operations;
+    services: Services;
+}
+
+/** Optional parameters. */
+export declare interface AzureAPICenterOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/**
+ * 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 declare type CreatedByType = string;
+
+/** The resource management error additional info. */
+export declare 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 error detail. */
+export declare 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[];
+}
+
+/** 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 declare interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+
+/**
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
+ * that point later.
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
+ */
+export declare function getContinuationToken(page: unknown): string | undefined;
+
+/** Known values of {@link ActionType} that the service accepts. */
+export declare enum KnownActionType {
+    /** Internal */
+    Internal = "Internal"
+}
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export declare enum KnownCreatedByType {
+    /** User */
+    User = "User",
+    /** Application */
+    Application = "Application",
+    /** ManagedIdentity */
+    ManagedIdentity = "ManagedIdentity",
+    /** Key */
+    Key = "Key"
+}
+
+/** Known values of {@link ManagedServiceIdentityType} that the service accepts. */
+export declare enum KnownManagedServiceIdentityType {
+    /** None */
+    None = "None",
+    /** SystemAssigned */
+    SystemAssigned = "SystemAssigned",
+    /** UserAssigned */
+    UserAssigned = "UserAssigned",
+    /** SystemAssignedUserAssigned */
+    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned"
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export declare enum KnownOrigin {
+    /** User */
+    User = "user",
+    /** System */
+    System = "system",
+    /** UserSystem */
+    UserSystem = "user,system"
+}
+
+/** Known values of {@link ProvisioningState} that the service accepts. */
+export declare enum KnownProvisioningState {
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled"
+}
+
+/** Managed service identity (system assigned and/or user assigned identities) */
+export declare interface ManagedServiceIdentity {
+    /**
+     * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly tenantId?: string;
+    /** Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */
+    type: ManagedServiceIdentityType;
+    /** The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity | null;
+    };
+}
+
+/**
+ * Defines values for ManagedServiceIdentityType. \
+ * {@link KnownManagedServiceIdentityType} can be used interchangeably with ManagedServiceIdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **None** \
+ * **SystemAssigned** \
+ * **UserAssigned** \
+ * **SystemAssigned,UserAssigned**
+ */
+export declare type ManagedServiceIdentityType = string;
+
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export declare 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 declare 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;
+}
+
+/** 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 declare 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;
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * List the operations for the provider
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type OperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationListResult;
+
+/**
+ * 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 declare type Origin = string;
+
+/**
+ * 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** \
+ * **Failed** \
+ * **Canceled**
+ */
+export declare type ProvisioningState = string;
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export declare 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;
+}
+
+/** The service entity. */
+export declare interface Service extends TrackedResource {
+    /** The identity of the service. */
+    identity?: ManagedServiceIdentity;
+    /**
+     * The status of the last operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/** The response of a Service list operation. */
+export declare interface ServiceCollection {
+    /** The Service items on this page */
+    value: Service[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+
+/** Interface representing a Services. */
+export declare interface Services {
+    /**
+     * Lists services within an Azure subscription.
+     * @param options The options parameters.
+     */
+    listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Service>;
+    /**
+     * Lists services within a resource group
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Service>;
+    /**
+     * Get service
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param serviceName Service name
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<ServicesGetResponse>;
+    /**
+     * Create or update service
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param serviceName Service name
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, serviceName: string, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServicesCreateOrUpdateResponse>;
+    /**
+     * Update service
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param serviceName Service name
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, serviceName: string, options?: ServicesUpdateOptionalParams): Promise<ServicesUpdateResponse>;
+    /**
+     * Delete service
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param serviceName Service name
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** The service entity. */
+    resource?: Service;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type ServicesCreateOrUpdateResponse = Service;
+
+/** Optional parameters. */
+export declare interface ServicesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface ServicesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ServicesGetResponse = Service;
+
+/** Optional parameters. */
+export declare interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type ServicesListByResourceGroupNextResponse = ServiceCollection;
+
+/** Optional parameters. */
+export declare interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type ServicesListByResourceGroupResponse = ServiceCollection;
+
+/** Optional parameters. */
+export declare interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscriptionNext operation. */
+export declare type ServicesListBySubscriptionNextResponse = ServiceCollection;
+
+/** Optional parameters. */
+export declare interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listBySubscription operation. */
+export declare type ServicesListBySubscriptionResponse = ServiceCollection;
+
+/** Optional parameters. */
+export declare interface ServicesUpdateOptionalParams extends coreClient.OperationOptions {
+    /** The service properties to be updated. */
+    parameters?: ServiceUpdate;
+}
+
+/** Contains response data for the update operation. */
+export declare type ServicesUpdateResponse = Service;
+
+/** The service properties to be updated. */
+export declare interface ServiceUpdate {
+    /**
+     * The status of the last operation.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ProvisioningState;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare 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 resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export declare interface TrackedResource extends Resource {
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The geo-location where the resource lives */
+    location: string;
+}
+
+/** User assigned identity properties */
+export declare interface UserAssignedIdentity {
+    /**
+     * The principal ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly principalId?: string;
+    /**
+     * The client ID of the assigned identity.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly clientId?: string;
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.36.4"
+    }
+  ]
+}