Skip to content

Commit

Permalink
[mgmt] servicenetworking release (#32481)
Browse files Browse the repository at this point in the history
  • Loading branch information
kazrael2119 authored Feb 11, 2025
1 parent fe3ded9 commit d9da44a
Show file tree
Hide file tree
Showing 246 changed files with 6,814 additions and 10,891 deletions.
50 changes: 33 additions & 17 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

83 changes: 76 additions & 7 deletions sdk/servicenetworking/arm-servicenetworking/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,84 @@
# Release History

## 1.1.0-beta.2 (Unreleased)

## 2.0.0 (2025-02-07)
### Features Added

### Breaking Changes

### Bugs Fixed
- Added operation group SecurityPoliciesInterfaceOperations
- Added operation AssociationsInterfaceOperations.createOrUpdate
- Added operation AssociationsInterfaceOperations.delete
- Added operation FrontendsInterfaceOperations.createOrUpdate
- Added operation FrontendsInterfaceOperations.delete
- Added operation TrafficControllerInterfaceOperations.createOrUpdate
- Added operation TrafficControllerInterfaceOperations.delete
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface RestorePollerOptions
- Added Interface SecurityPoliciesInterfaceCreateOrUpdateOptionalParams
- Added Interface SecurityPoliciesInterfaceDeleteOptionalParams
- Added Interface SecurityPoliciesInterfaceGetOptionalParams
- Added Interface SecurityPoliciesInterfaceListByTrafficControllerOptionalParams
- Added Interface SecurityPoliciesInterfaceUpdateOptionalParams
- Added Interface SecurityPolicy
- Added Interface SecurityPolicyConfigurations
- Added Interface SecurityPolicyProperties
- Added Interface SecurityPolicyUpdate
- Added Interface SecurityPolicyUpdateProperties
- Added Interface TrafficControllerUpdateProperties
- Added Interface WafPolicy
- Added Interface WafSecurityPolicy
- Added Type Alias ContinuablePage
- Added Type Alias PolicyType
- Interface TrafficControllerProperties has a new optional parameter securityPolicies
- Interface TrafficControllerProperties has a new optional parameter securityPolicyConfigurations
- Interface TrafficControllerUpdate has a new optional parameter properties
- Added Enum KnownPolicyType
- Added Enum KnownVersions
- Added function restorePoller

### Other Changes
### Breaking Changes

- Removed operation AssociationsInterface.beginCreateOrUpdate
- Removed operation AssociationsInterface.beginCreateOrUpdateAndWait
- Removed operation AssociationsInterface.beginDelete
- Removed operation AssociationsInterface.beginDeleteAndWait
- Removed operation FrontendsInterface.beginCreateOrUpdate
- Removed operation FrontendsInterface.beginCreateOrUpdateAndWait
- Removed operation FrontendsInterface.beginDelete
- Removed operation FrontendsInterface.beginDeleteAndWait
- Removed operation TrafficControllerInterface.beginCreateOrUpdate
- Removed operation TrafficControllerInterface.beginCreateOrUpdateAndWait
- Removed operation TrafficControllerInterface.beginDelete
- Removed operation TrafficControllerInterface.beginDeleteAndWait
- Class ServiceNetworkingManagementClient has a new signature
- Interface AssociationsInterfaceCreateOrUpdateOptionalParams no longer has parameter resumeFrom
- Interface AssociationsInterfaceDeleteOptionalParams no longer has parameter resumeFrom
- Interface FrontendsInterfaceCreateOrUpdateOptionalParams no longer has parameter resumeFrom
- Interface FrontendsInterfaceDeleteOptionalParams no longer has parameter resumeFrom
- Interface ServiceNetworkingManagementClientOptionalParams no longer has parameter $host
- Interface ServiceNetworkingManagementClientOptionalParams no longer has parameter endpoint
- Interface TrafficControllerInterfaceCreateOrUpdateOptionalParams no longer has parameter resumeFrom
- Interface TrafficControllerInterfaceDeleteOptionalParams no longer has parameter resumeFrom
- Parameter id of interface AssociationSubnetUpdate is now required
- Type of parameter tags of interface AssociationUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter info of interface ErrorAdditionalInfo is changed from Record<string, unknown> to Record<string, any>
- Type of parameter tags of interface FrontendUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter tags of interface TrackedResource is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Type of parameter tags of interface TrafficControllerUpdate is changed from {
[propertyName: string]: string;
} to Record<string, string>
- Class ServiceNetworkingManagementClient no longer has parameter $host
- Class ServiceNetworkingManagementClient no longer has parameter apiVersion
- Class ServiceNetworkingManagementClient no longer has parameter subscriptionId
- Removed function getContinuationToken


## 1.1.0-beta.1 (2024-08-22)
Compared with version 1.0.0

Expand Down
55 changes: 30 additions & 25 deletions sdk/servicenetworking/arm-servicenetworking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

Traffic Controller Provider management API.

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

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

## Getting started

Expand Down Expand Up @@ -43,53 +45,60 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure ServiceNetworkingManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
You will also need to **register a new AAD application and grant access to Azure ServiceNetworking** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { ServiceNetworkingManagementClient } = require("@azure/arm-servicenetworking");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { ServiceNetworkingManagementClient } from "../src/index.js";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ServiceNetworkingManagementClient(new DefaultAzureCredential(), subscriptionId);
```

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new ServiceNetworkingManagementClient(credential, subscriptionId);
For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { ServiceNetworkingManagementClient } from "../src/index.js";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new ServiceNetworkingManagementClient(credential, subscriptionId);
```

### JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts

### ServiceNetworkingManagementClient

`ServiceNetworkingManagementClient` is the primary interface for developers using the Azure ServiceNetworkingManagement client library. Explore the methods on this client object to understand the different features of the Azure ServiceNetworkingManagement service that you can access.
`ServiceNetworkingManagementClient` is the primary interface for developers using the Azure ServiceNetworking client library. Explore the methods on this client object to understand the different features of the Azure ServiceNetworking service that you can access.

## Troubleshooting

### Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:

```javascript
const { setLogLevel } = require("@azure/logger");
```ts snippet:SetLogLevel
import { setLogLevel } from "@azure/logger";

setLogLevel("info");
```

For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/servicenetworking/arm-servicenetworking/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -99,10 +108,6 @@ If you'd like to contribute to this library, please read the [contributing guide

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 0 additions & 8 deletions sdk/servicenetworking/arm-servicenetworking/_meta.json

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"mainEntryPointFilePath": "dist/esm/index.d.ts",
"docModel": {
"enabled": true
},
Expand All @@ -11,7 +11,7 @@
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-servicenetworking.d.ts"
"publicTrimmedFilePath": "dist/arm-servicenetworking.d.ts"
},
"messages": {
"tsdocMessageReporting": {
Expand All @@ -28,4 +28,4 @@
}
}
}
}
}
2 changes: 1 addition & 1 deletion sdk/servicenetworking/arm-servicenetworking/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/servicenetworking/arm-servicenetworking",
"Tag": "js/servicenetworking/arm-servicenetworking_5065862efa"
"Tag": "js/servicenetworking/arm-servicenetworking_369f015ecf"
}
16 changes: 16 additions & 0 deletions sdk/servicenetworking/arm-servicenetworking/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default azsdkEslint.config([
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-module": "off",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn",
},
},
]);
Loading

0 comments on commit d9da44a

Please sign in to comment.