Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions sdk/web-pubsub/arm-webpubsub/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,63 @@
# Release History

## 1.2.0 (2024-09-11)

### Features Added

- Added operation group WebPubSubReplicas
- Added operation group WebPubSubReplicaSharedPrivateLinkResources
- Added operation WebPubSub.listReplicaSkus
- Added Interface IPRule
- Added Interface Replica
- Added Interface ReplicaList
- Added Interface WebPubSubListReplicaSkusOptionalParams
- Added Interface WebPubSubRegenerateKeyHeaders
- Added Interface WebPubSubReplicasCreateOrUpdateOptionalParams
- Added Interface WebPubSubReplicasDeleteOptionalParams
- Added Interface WebPubSubReplicasGetOptionalParams
- Added Interface WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams
- Added Interface WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams
- Added Interface WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams
- Added Interface WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams
- Added Interface WebPubSubReplicasListNextOptionalParams
- Added Interface WebPubSubReplicasListOptionalParams
- Added Interface WebPubSubReplicasRestartHeaders
- Added Interface WebPubSubReplicasRestartOptionalParams
- Added Interface WebPubSubReplicasUpdateHeaders
- Added Interface WebPubSubReplicasUpdateOptionalParams
- Added Interface WebPubSubRestartHeaders
- Added Interface WebPubSubSocketIOSettings
- Added Interface WebPubSubUpdateHeaders
- Added Type Alias ServiceKind
- Added Type Alias WebPubSubListReplicaSkusResponse
- Added Type Alias WebPubSubReplicasCreateOrUpdateResponse
- Added Type Alias WebPubSubReplicasGetResponse
- Added Type Alias WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse
- Added Type Alias WebPubSubReplicaSharedPrivateLinkResourcesGetResponse
- Added Type Alias WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse
- Added Type Alias WebPubSubReplicaSharedPrivateLinkResourcesListResponse
- Added Type Alias WebPubSubReplicasListNextResponse
- Added Type Alias WebPubSubReplicasListResponse
- Added Type Alias WebPubSubReplicasRestartResponse
- Added Type Alias WebPubSubReplicasUpdateResponse
- Added Type Alias WebPubSubRestartResponse
- Interface Resource has a new optional parameter systemData
- Interface WebPubSubHubProperties has a new optional parameter webSocketKeepAliveIntervalInSeconds
- Interface WebPubSubNetworkACLs has a new optional parameter ipRules
- Interface WebPubSubResource has a new optional parameter kind
- Interface WebPubSubResource has a new optional parameter regionEndpointEnabled
- Interface WebPubSubResource has a new optional parameter resourceStopped
- Interface WebPubSubResource has a new optional parameter socketIO
- Added Enum KnownServiceKind
- Interface CustomCertificate no longer has parameter systemData
- Interface CustomDomain no longer has parameter systemData
- Interface PrivateEndpointConnection no longer has parameter systemData
- Interface SharedPrivateLinkResource no longer has parameter systemData
- Interface WebPubSubHub no longer has parameter systemData
- Interface WebPubSubResource no longer has parameter systemData
- Parameter location of interface TrackedResource is now required


## 2.0.0-beta.2 (2023-10-10)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/web-pubsub/arm-webpubsub/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2023 Microsoft
Copyright (c) 2024 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion sdk/web-pubsub/arm-webpubsub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ REST API for Azure WebPubSub Service

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/web-pubsub/arm-webpubsub) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-webpubsub) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-webpubsub?view=azure-node-preview) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-webpubsub) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down
8 changes: 4 additions & 4 deletions sdk/web-pubsub/arm-webpubsub/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "e1017d9ab49f41296177b4f4c9ac741fb7de044d",
"commit": "3519c80fe510a268f6e59a29ccac8a53fdec15b6",
"readme": "specification/webpubsub/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\webpubsub\\resource-manager\\readme.md --use=@autorest/typescript@6.0.9 --generate-sample=true",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\webpubsub\\resource-manager\\readme.md --use=@autorest/typescript@6.0.27 --generate-sample=true",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.2",
"use": "@autorest/typescript@6.0.9"
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.13",
"use": "@autorest/typescript@6.0.27"
}
2 changes: 1 addition & 1 deletion sdk/web-pubsub/arm-webpubsub/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "js",
"TagPrefix": "js/web-pubsub/arm-webpubsub",
"Tag": "js/web-pubsub/arm-webpubsub_33e23101b1"
"Tag": "js/web-pubsub/arm-webpubsub_3a173487ab"
}
4 changes: 2 additions & 2 deletions sdk/web-pubsub/arm-webpubsub/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for WebPubSubManagementClient.",
"version": "2.0.0-beta.2",
"version": "1.2.0",
"engines": {
"node": ">=18.0.0"
},
Expand Down Expand Up @@ -116,4 +116,4 @@
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-webpubsub?view=azure-node-preview"
}
}
}
47 changes: 47 additions & 0 deletions sdk/web-pubsub/arm-webpubsub/review/arm-webpubsub.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -752,6 +752,7 @@ export interface WebPubSubHubProperties {
anonymousConnectPolicy?: string;
eventHandlers?: EventHandler[];
eventListeners?: EventListener_2[];
webSocketKeepAliveIntervalInSeconds?: number;
}

// @public
Expand Down Expand Up @@ -885,6 +886,8 @@ export class WebPubSubManagementClient extends coreClient.ServiceClient {
// (undocumented)
webPubSubReplicas: WebPubSubReplicas;
// (undocumented)
webPubSubReplicaSharedPrivateLinkResources: WebPubSubReplicaSharedPrivateLinkResources;
// (undocumented)
webPubSubSharedPrivateLinkResources: WebPubSubSharedPrivateLinkResources;
}

Expand Down Expand Up @@ -1013,6 +1016,44 @@ export interface WebPubSubReplicasGetOptionalParams extends coreClient.Operation
// @public
export type WebPubSubReplicasGetResponse = Replica;

// @public
export interface WebPubSubReplicaSharedPrivateLinkResources {
beginCreateOrUpdate(resourceGroupName: string, resourceName: string, replicaName: string, sharedPrivateLinkResourceName: string, parameters: SharedPrivateLinkResource, options?: WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse>, WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse>>;
beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, replicaName: string, sharedPrivateLinkResourceName: string, parameters: SharedPrivateLinkResource, options?: WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse>;
get(resourceGroupName: string, resourceName: string, replicaName: string, sharedPrivateLinkResourceName: string, options?: WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams): Promise<WebPubSubReplicaSharedPrivateLinkResourcesGetResponse>;
list(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource>;
}

// @public
export interface WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}

// @public
export type WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource;

// @public
export interface WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
}

// @public
export type WebPubSubReplicaSharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource;

// @public
export interface WebPubSubReplicaSharedPrivateLinkResourcesListNextOptionalParams extends coreClient.OperationOptions {
}

// @public
export type WebPubSubReplicaSharedPrivateLinkResourcesListNextResponse = SharedPrivateLinkResourceList;

// @public
export interface WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams extends coreClient.OperationOptions {
}

// @public
export type WebPubSubReplicaSharedPrivateLinkResourcesListResponse = SharedPrivateLinkResourceList;

// @public
export interface WebPubSubReplicasListNextOptionalParams extends coreClient.OperationOptions {
}
Expand Down Expand Up @@ -1081,6 +1122,7 @@ export interface WebPubSubResource extends TrackedResource {
readonly serverPort?: number;
readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[];
sku?: ResourceSku;
socketIO?: WebPubSubSocketIOSettings;
tls?: WebPubSubTlsSettings;
readonly version?: string;
}
Expand Down Expand Up @@ -1155,6 +1197,11 @@ export type WebPubSubSharedPrivateLinkResourcesListResponse = SharedPrivateLinkR
// @public
export type WebPubSubSkuTier = string;

// @public
export interface WebPubSubSocketIOSettings {
serviceMode?: string;
}

// @public
export interface WebPubSubTlsSettings {
clientCertEnabled?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dotenv.config();
* This sample demonstrates how to Lists all of the available REST API operations of the Microsoft.SignalRService provider.
*
* @summary Lists all of the available REST API operations of the Microsoft.SignalRService provider.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/Operations_List.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/Operations_List.json
*/
async function operationsList() {
const subscriptionId =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dotenv.config();
* This sample demonstrates how to List resource usage quotas by location.
*
* @summary List resource usage quotas by location.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/Usages_List.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/Usages_List.json
*/
async function usagesList() {
const subscriptionId =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
// Licensed under the MIT License.
import {
NameAvailabilityParameters,
WebPubSubManagementClient
WebPubSubManagementClient,
} from "@azure/arm-webpubsub";
import { DefaultAzureCredential } from "@azure/identity";
import * as dotenv from "dotenv";
Expand All @@ -21,7 +21,7 @@ dotenv.config();
* This sample demonstrates how to Checks that the resource name is valid and is not already in use.
*
* @summary Checks that the resource name is valid and is not already in use.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/WebPubSub_CheckNameAvailability.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_CheckNameAvailability.json
*/
async function webPubSubCheckNameAvailability() {
const subscriptionId =
Expand All @@ -30,13 +30,13 @@ async function webPubSubCheckNameAvailability() {
const location = "eastus";
const parameters: NameAvailabilityParameters = {
name: "myWebPubSubService",
type: "Microsoft.SignalRService/WebPubSub"
type: "Microsoft.SignalRService/WebPubSub",
};
const credential = new DefaultAzureCredential();
const client = new WebPubSubManagementClient(credential, subscriptionId);
const result = await client.webPubSub.checkNameAvailability(
location,
parameters
parameters,
);
console.log(result);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
// Licensed under the MIT License.
import {
WebPubSubResource,
WebPubSubManagementClient
WebPubSubManagementClient,
} from "@azure/arm-webpubsub";
import { DefaultAzureCredential } from "@azure/identity";
import * as dotenv from "dotenv";
Expand All @@ -21,7 +21,7 @@ dotenv.config();
* This sample demonstrates how to Create or update a resource.
*
* @summary Create or update a resource.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/WebPubSub_CreateOrUpdate.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSub_CreateOrUpdate.json
*/
async function webPubSubCreateOrUpdate() {
const subscriptionId =
Expand All @@ -37,30 +37,31 @@ async function webPubSubCreateOrUpdate() {
kind: "WebPubSub",
liveTraceConfiguration: {
categories: [{ name: "ConnectivityLogs", enabled: "true" }],
enabled: "false"
enabled: "false",
},
location: "eastus",
networkACLs: {
defaultAction: "Deny",
privateEndpoints: [
{
name: "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
allow: ["ServerConnection"]
}
allow: ["ServerConnection"],
},
],
publicNetwork: { allow: ["ClientConnection"] }
publicNetwork: { allow: ["ClientConnection"] },
},
publicNetworkAccess: "Enabled",
sku: { name: "Premium_P1", capacity: 1, tier: "Premium" },
socketIO: { serviceMode: "Serverless" },
tags: { key1: "value1" },
tls: { clientCertEnabled: false }
tls: { clientCertEnabled: false },
};
const credential = new DefaultAzureCredential();
const client = new WebPubSubManagementClient(credential, subscriptionId);
const result = await client.webPubSub.beginCreateOrUpdateAndWait(
resourceGroupName,
resourceName,
parameters
parameters,
);
console.log(result);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
// Licensed under the MIT License.
import {
CustomCertificate,
WebPubSubManagementClient
WebPubSubManagementClient,
} from "@azure/arm-webpubsub";
import { DefaultAzureCredential } from "@azure/identity";
import * as dotenv from "dotenv";
Expand All @@ -21,7 +21,7 @@ dotenv.config();
* This sample demonstrates how to Create or update a custom certificate.
*
* @summary Create or update a custom certificate.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/WebPubSubCustomCertificates_CreateOrUpdate.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubCustomCertificates_CreateOrUpdate.json
*/
async function webPubSubCustomCertificatesCreateOrUpdate() {
const subscriptionId =
Expand All @@ -34,16 +34,17 @@ async function webPubSubCustomCertificatesCreateOrUpdate() {
const parameters: CustomCertificate = {
keyVaultBaseUri: "https://myvault.keyvault.azure.net/",
keyVaultSecretName: "mycert",
keyVaultSecretVersion: "bb6a44b2743f47f68dad0d6cc9756432"
keyVaultSecretVersion: "bb6a44b2743f47f68dad0d6cc9756432",
};
const credential = new DefaultAzureCredential();
const client = new WebPubSubManagementClient(credential, subscriptionId);
const result = await client.webPubSubCustomCertificates.beginCreateOrUpdateAndWait(
resourceGroupName,
resourceName,
certificateName,
parameters
);
const result =
await client.webPubSubCustomCertificates.beginCreateOrUpdateAndWait(
resourceGroupName,
resourceName,
certificateName,
parameters,
);
console.log(result);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dotenv.config();
* This sample demonstrates how to Delete a custom certificate.
*
* @summary Delete a custom certificate.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/WebPubSubCustomCertificates_Delete.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubCustomCertificates_Delete.json
*/
async function webPubSubCustomCertificatesDelete() {
const subscriptionId =
Expand All @@ -33,7 +33,7 @@ async function webPubSubCustomCertificatesDelete() {
const result = await client.webPubSubCustomCertificates.delete(
resourceGroupName,
resourceName,
certificateName
certificateName,
);
console.log(result);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dotenv.config();
* This sample demonstrates how to Get a custom certificate.
*
* @summary Get a custom certificate.
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/preview/2023-08-01-preview/examples/WebPubSubCustomCertificates_Get.json
* x-ms-original-file: specification/webpubsub/resource-manager/Microsoft.SignalRService/stable/2024-03-01/examples/WebPubSubCustomCertificates_Get.json
*/
async function webPubSubCustomCertificatesGet() {
const subscriptionId =
Expand All @@ -33,7 +33,7 @@ async function webPubSubCustomCertificatesGet() {
const result = await client.webPubSubCustomCertificates.get(
resourceGroupName,
resourceName,
certificateName
certificateName,
);
console.log(result);
}
Expand Down
Loading