Skip to content

Commit 9164326

Browse files
author
SDKAuto
committed
CodeGen from PR 34246 in Azure/azure-rest-api-specs
Merge ab3be28614e1ccf01dfa474b6d780629990a1a53 into 67aef4a58261c9485a320c0d5abb52c377aee72d
1 parent 5c1fc38 commit 9164326

32 files changed

+1709
-21
lines changed

‎common/config/rush/pnpm-lock.yaml

Lines changed: 61 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎rush.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* This is the main configuration file for Rush.
33
* For full documentation, please see https://rushjs.io
4-
*/ {
4+
*/{
55
"$schema": "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json",
66
/**
77
* (Required) This specifies the version of the Rush engine to be used in this repo.
@@ -2366,6 +2366,11 @@
23662366
"packageName": "@azure/arm-carbonoptimization",
23672367
"projectFolder": "sdk/carbonoptimization/arm-carbonoptimization",
23682368
"versionPolicyName": "management"
2369+
},
2370+
{
2371+
"packageName": "@azure-rest/programmableconnectivity",
2372+
"projectFolder": "sdk/programmableconnectivity/programmableconnectivity",
2373+
"versionPolicyName": "client"
23692374
}
23702375
]
2371-
}
2376+
}

‎sdk/programmableconnectivity/ci.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file.
2+
3+
trigger:
4+
branches:
5+
include:
6+
- main
7+
- feature/*
8+
- release/*
9+
- hotfix/*
10+
exclude:
11+
- feature/v4
12+
paths:
13+
include:
14+
- sdk/programmableconnectivity/
15+
exclude:
16+
- sdk/programmableconnectivity/arm-programmableconnectivity
17+
- sdk/programmableconnectivity/ci.mgmt.yml
18+
pr:
19+
branches:
20+
include:
21+
- main
22+
- feature/*
23+
- release/*
24+
- hotfix/*
25+
exclude:
26+
- feature/v4
27+
paths:
28+
include:
29+
- sdk/programmableconnectivity/
30+
exclude:
31+
- sdk/programmableconnectivity/arm-programmableconnectivity
32+
- sdk/programmableconnectivity/ci.mgmt.yml
33+
extends:
34+
template: /eng/pipelines/templates/stages/archetype-sdk-client.yml
35+
parameters:
36+
ServiceDirectory: programmableconnectivity
37+
Artifacts:
38+
- name: azure-rest-programmableconnectivity
39+
safeName: azurerestprogrammableconnectivity

‎sdk/programmableconnectivity/programmableconnectivity/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2025-04-29)
4+
5+
### Features Added
6+
7+
The package of @azure-rest/programmableconnectivity is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).

‎sdk/programmableconnectivity/programmableconnectivity/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎sdk/programmableconnectivity/programmableconnectivity/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Azure ProgrammableConnectivity REST client library for JavaScript
2+
3+
Azure Programmable Connectivity (APC) provides a unified interface to the Network APIs of multiple Telecom Operators. Note that Operators may deprecate a Network API with less advance notice than the Azure standard, in which case APC will also deprecate that Network API.
4+
5+
**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
6+
7+
Key links:
8+
9+
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/programmableconnectivity/programmableconnectivity)
10+
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/programmableconnectivity)
11+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/programmableconnectivity?view=azure-node-preview)
12+
13+
## Getting started
14+
15+
### Currently supported environments
16+
17+
- LTS versions of Node.js
18+
19+
### Prerequisites
20+
21+
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
22+
23+
### Install the `@azure-rest/programmableconnectivity` package
24+
25+
Install the Azure ProgrammableConnectivity REST client REST client library for JavaScript with `npm`:
26+
27+
```bash
28+
npm install @azure-rest/programmableconnectivity
29+
```
30+
31+
### Create and authenticate a `ProgrammableConnectivityClient`
32+
33+
To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
34+
provide an instance of the desired credential type obtained from the
35+
[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
36+
37+
To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
38+
39+
After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
40+
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
41+
can be used to authenticate the client.
42+
43+
## Troubleshooting
44+
45+
### Logging
46+
47+
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`:
48+
49+
```ts snippet:SetLogLevel
50+
import { setLogLevel } from "@azure/logger";
51+
52+
setLogLevel("info");
53+
```
54+
55+
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).

0 commit comments

Comments
 (0)