Skip to content

Commit 6ac706b

Browse files
azure-sdkv-jiaodi
andauthored
[AutoPR @azure-arm-appcontainers]-generated-from-SDK Generation - JS-6326722 (#38608)
Configurations: 'specification/app/resource-manager/Microsoft.App/ContainerApps/tspconfig.yaml', API Version: 2025-10-02-preview, SDK Release Type: beta, and CommitSHA: '6d50d64d3eeca46ecf1b4af80e9994bac920a7d0' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6326722 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. --------- Co-authored-by: Jiao Di (MSFT) <v-jiaodi@microsoft.com> Co-authored-by: Jiao Di (MSFT) <80496810+v-jiaodi@users.noreply.github.com>
1 parent 54f057e commit 6ac706b

913 files changed

Lines changed: 65266 additions & 35477 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@
355355
# PRLabel: %Mgmt
356356
/sdk/apimanagement/arm-apimanagement/ @qiaozha @MaryGao @JialinHuang803
357357

358-
# PRLabel: %Mgmt
358+
# PRLabel: %Mgmt %mgmt-review-needed
359359
/sdk/appcontainers/arm-appcontainers/ @qiaozha @MaryGao @JialinHuang803
360360

361361
# PRLabel: %Mgmt

pnpm-lock.yaml

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

sdk/appcontainers/arm-appcontainers/CHANGELOG.md

Lines changed: 359 additions & 0 deletions
Large diffs are not rendered by default.

sdk/appcontainers/arm-appcontainers/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Azure ContainerApps API client library for JavaScript
1+
# Azure ContainerAppsAPI client library for JavaScript
22

3-
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure ContainerApps API client.
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure ContainerAppsAPI client.
44

5-
Logic app is an extension resource on container app and the extension resource enables logic specific operations on the container app through the APIs listed.
5+
Functions is an extension resource to revisions and the api listed is used to proxy the call from Web RP to the function app's host process, this api is not exposed to users and only Web RP is allowed to invoke functions extension resource.
66

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

1214
## Getting started
1315

@@ -24,26 +26,26 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP
2426

2527
### Install the `@azure/arm-appcontainers` package
2628

27-
Install the Azure ContainerApps API client library for JavaScript with `npm`:
29+
Install the Azure ContainerAppsAPI client library for JavaScript with `npm`:
2830

2931
```bash
3032
npm install @azure/arm-appcontainers
3133
```
3234

3335
### Create and authenticate a `ContainerAppsAPIClient`
3436

35-
To create a client object to access the Azure ContainerApps API API, you will need the `endpoint` of your Azure ContainerApps API resource and a `credential`. The Azure ContainerApps API client can use Azure Active Directory credentials to authenticate.
36-
You can find the endpoint for your Azure ContainerApps API resource in the [Azure Portal][azure_portal].
37+
To create a client object to access the Azure ContainerAppsAPI API, you will need the `endpoint` of your Azure ContainerAppsAPI resource and a `credential`. The Azure ContainerAppsAPI client can use Azure Active Directory credentials to authenticate.
38+
You can find the endpoint for your Azure ContainerAppsAPI resource in the [Azure Portal][azure_portal].
3739

38-
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
40+
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
3941

4042
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
4143

4244
```bash
4345
npm install @azure/identity
4446
```
4547

46-
You will also need to **register a new AAD application and grant access to Azure ContainerApps API** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
48+
You will also need to **register a new AAD application and grant access to Azure ContainerAppsAPI** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
4749

4850
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).
4951

@@ -63,22 +65,23 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
6365
import { InteractiveBrowserCredential } from "@azure/identity";
6466
import { ContainerAppsAPIClient } from "@azure/arm-appcontainers";
6567

66-
const subscriptionId = "00000000-0000-0000-0000-000000000000";
6768
const credential = new InteractiveBrowserCredential({
6869
tenantId: "<YOUR_TENANT_ID>",
6970
clientId: "<YOUR_CLIENT_ID>",
7071
});
72+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
7173
const client = new ContainerAppsAPIClient(credential, subscriptionId);
7274
```
7375

76+
7477
### JavaScript Bundle
7578
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).
7679

7780
## Key concepts
7881

7982
### ContainerAppsAPIClient
8083

81-
`ContainerAppsAPIClient` is the primary interface for developers using the Azure ContainerApps API client library. Explore the methods on this client object to understand the different features of the Azure ContainerApps API service that you can access.
84+
`ContainerAppsAPIClient` is the primary interface for developers using the Azure ContainerAppsAPI client library. Explore the methods on this client object to understand the different features of the Azure ContainerAppsAPI service that you can access.
8285

8386
## Troubleshooting
8487

@@ -96,7 +99,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
9699

97100
## Next steps
98101

99-
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.
102+
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appcontainers/arm-appcontainers/samples) directory for detailed examples on how to use this library.
100103

101104
## Contributing
102105

@@ -106,9 +109,6 @@ If you'd like to contribute to this library, please read the [contributing guide
106109

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

109-
110-
[azure_cli]: https://learn.microsoft.com/cli/azure
111-
[azure_sub]: https://azure.microsoft.com/free/
112112
[azure_sub]: https://azure.microsoft.com/free/
113113
[azure_portal]: https://portal.azure.com
114114
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity

sdk/appcontainers/arm-appcontainers/_meta.json

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
{
2-
"extends": "../../../api-extractor-base.json"
3-
}
1+
{ "extends": "../../../api-extractor-base.json" }

sdk/appcontainers/arm-appcontainers/assets.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"AssetsRepo": "Azure/azure-sdk-assets",
33
"AssetsRepoPrefixPath": "js",
44
"TagPrefix": "js/appcontainers/arm-appcontainers",
5-
"Tag": "js/appcontainers/arm-appcontainers_aa6bb1e6dd"
5+
"Tag": "js/appcontainers/arm-appcontainers_2b2d8ca5c6"
66
}

sdk/appcontainers/arm-appcontainers/config/tsconfig.samples.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
"extends": "../../../../eng/tsconfigs/samples.json",
33
"compilerOptions": {
44
"paths": {
5-
"@azure/arm-appcontainers": [
6-
"../dist/esm"
7-
]
5+
"@azure/arm-appcontainers": ["../dist/esm"]
86
}
97
}
108
}
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
{
22
"extends": "../../../../eng/tsconfigs/src.browser.json",
3-
"include": [
4-
"../src/index.ts"
5-
]
3+
"include": ["../src/index.ts"]
64
}
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
{
22
"extends": "../../../../eng/tsconfigs/src.cjs.json",
3-
"include": [
4-
"../src/index.ts"
5-
]
3+
"include": ["../src/index.ts"]
64
}

0 commit comments

Comments
 (0)