@azure/arm-relay 2.2.1 → 3.0.0

package/review/arm-relay.api.md

@@ -0,0 +1,539 @@
+## API Report File for "@azure/arm-relay"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export interface AccessKeys {
+    keyName?: string;
+    primaryConnectionString?: string;
+    primaryKey?: string;
+    secondaryConnectionString?: string;
+    secondaryKey?: string;
+}
+
+// @public
+export type AccessRights = "Manage" | "Send" | "Listen";
+
+// @public
+export type AuthorizationRule = Resource & {
+    rights: AccessRights[];
+};
+
+// @public
+export interface AuthorizationRuleListResult {
+    nextLink?: string;
+    value?: AuthorizationRule[];
+}
+
+// @public
+export interface CheckNameAvailability {
+    name: string;
+}
+
+// @public
+export interface CheckNameAvailabilityResult {
+    readonly message?: string;
+    nameAvailable?: boolean;
+    reason?: UnavailableReason;
+}
+
+// @public
+export interface ErrorResponse {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export type HybridConnection = Resource & {
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly listenerCount?: number;
+    requiresClientAuthorization?: boolean;
+    userMetadata?: string;
+};
+
+// @public
+export interface HybridConnectionListResult {
+    nextLink?: string;
+    value?: HybridConnection[];
+}
+
+// @public
+export interface HybridConnections {
+    createOrUpdate(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, parameters: HybridConnection, options?: HybridConnectionsCreateOrUpdateOptionalParams): Promise<HybridConnectionsCreateOrUpdateResponse>;
+    createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<HybridConnectionsCreateOrUpdateAuthorizationRuleResponse>;
+    delete(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, options?: HybridConnectionsDeleteOptionalParams): Promise<void>;
+    deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, authorizationRuleName: string, options?: HybridConnectionsDeleteAuthorizationRuleOptionalParams): Promise<void>;
+    get(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, options?: HybridConnectionsGetOptionalParams): Promise<HybridConnectionsGetResponse>;
+    getAuthorizationRule(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, authorizationRuleName: string, options?: HybridConnectionsGetAuthorizationRuleOptionalParams): Promise<HybridConnectionsGetAuthorizationRuleResponse>;
+    listAuthorizationRules(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, options?: HybridConnectionsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule>;
+    listByNamespace(resourceGroupName: string, namespaceName: string, options?: HybridConnectionsListByNamespaceOptionalParams): PagedAsyncIterableIterator<HybridConnection>;
+    listKeys(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, authorizationRuleName: string, options?: HybridConnectionsListKeysOptionalParams): Promise<HybridConnectionsListKeysResponse>;
+    regenerateKeys(resourceGroupName: string, namespaceName: string, hybridConnectionName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: HybridConnectionsRegenerateKeysOptionalParams): Promise<HybridConnectionsRegenerateKeysResponse>;
+}
+
+// @public
+export interface HybridConnectionsCreateOrUpdateAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsCreateOrUpdateAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface HybridConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsCreateOrUpdateResponse = HybridConnection;
+
+// @public
+export interface HybridConnectionsDeleteAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface HybridConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface HybridConnectionsGetAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsGetAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface HybridConnectionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsGetResponse = HybridConnection;
+
+// @public
+export interface HybridConnectionsListAuthorizationRulesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsListAuthorizationRulesNextResponse = AuthorizationRuleListResult;
+
+// @public
+export interface HybridConnectionsListAuthorizationRulesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsListAuthorizationRulesResponse = AuthorizationRuleListResult;
+
+// @public
+export interface HybridConnectionsListByNamespaceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsListByNamespaceNextResponse = HybridConnectionListResult;
+
+// @public
+export interface HybridConnectionsListByNamespaceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsListByNamespaceResponse = HybridConnectionListResult;
+
+// @public
+export interface HybridConnectionsListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsListKeysResponse = AccessKeys;
+
+// @public
+export interface HybridConnectionsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type HybridConnectionsRegenerateKeysResponse = AccessKeys;
+
+// @public
+type KeyType_2 = "PrimaryKey" | "SecondaryKey";
+export { KeyType_2 as KeyType }
+
+// @public
+export interface Namespaces {
+    beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, parameters: RelayNamespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<NamespacesCreateOrUpdateResponse>, NamespacesCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, parameters: RelayNamespace, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespacesCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>;
+    checkNameAvailability(parameters: CheckNameAvailability, options?: NamespacesCheckNameAvailabilityOptionalParams): Promise<NamespacesCheckNameAvailabilityResponse>;
+    createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<NamespacesCreateOrUpdateAuthorizationRuleResponse>;
+    deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesDeleteAuthorizationRuleOptionalParams): Promise<void>;
+    get(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams): Promise<NamespacesGetResponse>;
+    getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<NamespacesGetAuthorizationRuleResponse>;
+    list(options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<RelayNamespace>;
+    listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule>;
+    listByResourceGroup(resourceGroupName: string, options?: NamespacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RelayNamespace>;
+    listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<NamespacesListKeysResponse>;
+    regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: NamespacesRegenerateKeysOptionalParams): Promise<NamespacesRegenerateKeysResponse>;
+    update(resourceGroupName: string, namespaceName: string, parameters: RelayUpdateParameters, options?: NamespacesUpdateOptionalParams): Promise<NamespacesUpdateResponse>;
+}
+
+// @public
+export interface NamespacesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
+
+// @public
+export interface NamespacesCreateOrUpdateAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesCreateOrUpdateAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface NamespacesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type NamespacesCreateOrUpdateResponse = RelayNamespace;
+
+// @public
+export interface NamespacesDeleteAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface NamespacesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface NamespacesGetAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesGetAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface NamespacesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesGetResponse = RelayNamespace;
+
+// @public
+export interface NamespacesListAuthorizationRulesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListAuthorizationRulesNextResponse = AuthorizationRuleListResult;
+
+// @public
+export interface NamespacesListAuthorizationRulesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListAuthorizationRulesResponse = AuthorizationRuleListResult;
+
+// @public
+export interface NamespacesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListByResourceGroupNextResponse = RelayNamespaceListResult;
+
+// @public
+export interface NamespacesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListByResourceGroupResponse = RelayNamespaceListResult;
+
+// @public
+export interface NamespacesListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListKeysResponse = AccessKeys;
+
+// @public
+export interface NamespacesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListNextResponse = RelayNamespaceListResult;
+
+// @public
+export interface NamespacesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesListResponse = RelayNamespaceListResult;
+
+// @public
+export interface NamespacesRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesRegenerateKeysResponse = AccessKeys;
+
+// @public
+export interface NamespacesUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type NamespacesUpdateResponse = RelayNamespace;
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    readonly name?: string;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type ProvisioningStateEnum = "Created" | "Succeeded" | "Deleted" | "Failed" | "Updating" | "Unknown";
+
+// @public
+export interface RegenerateAccessKeyParameters {
+    key?: string;
+    keyType: KeyType_2;
+}
+
+// @public (undocumented)
+export class RelayAPI extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: RelayAPIOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    hybridConnections: HybridConnections;
+    // (undocumented)
+    namespaces: Namespaces;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    wCFRelays: WCFRelays;
+}
+
+// @public
+export interface RelayAPIOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type RelayNamespace = TrackedResource & {
+    sku?: Sku;
+    readonly provisioningState?: ProvisioningStateEnum;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly serviceBusEndpoint?: string;
+    readonly metricId?: string;
+};
+
+// @public
+export interface RelayNamespaceListResult {
+    nextLink?: string;
+    value?: RelayNamespace[];
+}
+
+// @public
+export type Relaytype = "NetTcp" | "Http";
+
+// @public
+export type RelayUpdateParameters = ResourceNamespacePatch & {
+    sku?: Sku;
+    readonly provisioningState?: ProvisioningStateEnum;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly serviceBusEndpoint?: string;
+    readonly metricId?: string;
+};
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceNamespacePatch = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+};
+
+// @public
+export interface Sku {
+    name: "Standard";
+    tier?: "Standard";
+}
+
+// @public
+export type TrackedResource = Resource & {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+};
+
+// @public
+export type UnavailableReason = "None" | "InvalidName" | "SubscriptionIsDisabled" | "NameInUse" | "NameInLockdown" | "TooManyNamespaceInCurrentSubscription";
+
+// @public
+export type WcfRelay = Resource & {
+    readonly isDynamic?: boolean;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly listenerCount?: number;
+    relayType?: Relaytype;
+    requiresClientAuthorization?: boolean;
+    requiresTransportSecurity?: boolean;
+    userMetadata?: string;
+};
+
+// @public
+export interface WCFRelays {
+    createOrUpdate(resourceGroupName: string, namespaceName: string, relayName: string, parameters: WcfRelay, options?: WCFRelaysCreateOrUpdateOptionalParams): Promise<WCFRelaysCreateOrUpdateResponse>;
+    createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams): Promise<WCFRelaysCreateOrUpdateAuthorizationRuleResponse>;
+    delete(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysDeleteOptionalParams): Promise<void>;
+    deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysDeleteAuthorizationRuleOptionalParams): Promise<void>;
+    get(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysGetOptionalParams): Promise<WCFRelaysGetResponse>;
+    getAuthorizationRule(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysGetAuthorizationRuleOptionalParams): Promise<WCFRelaysGetAuthorizationRuleResponse>;
+    listAuthorizationRules(resourceGroupName: string, namespaceName: string, relayName: string, options?: WCFRelaysListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule>;
+    listByNamespace(resourceGroupName: string, namespaceName: string, options?: WCFRelaysListByNamespaceOptionalParams): PagedAsyncIterableIterator<WcfRelay>;
+    listKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, options?: WCFRelaysListKeysOptionalParams): Promise<WCFRelaysListKeysResponse>;
+    regenerateKeys(resourceGroupName: string, namespaceName: string, relayName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: WCFRelaysRegenerateKeysOptionalParams): Promise<WCFRelaysRegenerateKeysResponse>;
+}
+
+// @public
+export interface WCFRelaysCreateOrUpdateAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysCreateOrUpdateAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface WCFRelaysCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysCreateOrUpdateResponse = WcfRelay;
+
+// @public
+export interface WCFRelaysDeleteAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface WCFRelaysDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface WCFRelaysGetAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysGetAuthorizationRuleResponse = AuthorizationRule;
+
+// @public
+export interface WCFRelaysGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysGetResponse = WcfRelay;
+
+// @public
+export interface WCFRelaysListAuthorizationRulesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysListAuthorizationRulesNextResponse = AuthorizationRuleListResult;
+
+// @public
+export interface WCFRelaysListAuthorizationRulesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysListAuthorizationRulesResponse = AuthorizationRuleListResult;
+
+// @public
+export interface WCFRelaysListByNamespaceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysListByNamespaceNextResponse = WcfRelaysListResult;
+
+// @public
+export interface WCFRelaysListByNamespaceOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysListByNamespaceResponse = WcfRelaysListResult;
+
+// @public
+export interface WCFRelaysListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysListKeysResponse = AccessKeys;
+
+// @public
+export interface WcfRelaysListResult {
+    nextLink?: string;
+    value?: WcfRelay[];
+}
+
+// @public
+export interface WCFRelaysRegenerateKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type WCFRelaysRegenerateKeysResponse = AccessKeys;
+
+// (No @packageDocumentation comment for this package)
+
+```