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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@
# PRLabel: %Mgmt
/sdk/redis/arm-rediscache/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt
# PRLabel: %Mgmt %mgmt-review-needed
/sdk/redhatopenshift/arm-redhatopenshift/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt %mgmt-review-needed
Expand Down
31 changes: 20 additions & 11 deletions pnpm-lock.yaml

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

80 changes: 75 additions & 5 deletions sdk/redhatopenshift/arm-redhatopenshift/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,85 @@
# Release History

## 1.0.0-beta.2 (Unreleased)
## 1.0.0-beta.2 (2026-05-27)
Compared with version 1.0.0-beta.1

### Features Added
- Added operation group PlatformWorkloadIdentityRoleSetOperations
- Added operation group PlatformWorkloadIdentityRoleSetsOperations
- Added operation OpenShiftClustersOperations.createOrUpdate
- Added operation OpenShiftClustersOperations.delete
- Added operation OpenShiftClustersOperations.update
- Added operation OpenShiftVersionsOperations.get
- Added Interface ManagedServiceIdentity
- Added Interface OpenShiftClusterProperties
- Added Interface OpenShiftVersionProperties
- Added Interface OpenShiftVersionsGetOptionalParams
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface PlatformWorkloadIdentity
- Added Interface PlatformWorkloadIdentityProfile
- Added Interface PlatformWorkloadIdentityRole
- Added Interface PlatformWorkloadIdentityRoleSet
- Added Interface PlatformWorkloadIdentityRoleSetGetOptionalParams
- Added Interface PlatformWorkloadIdentityRoleSetProperties
- Added Interface PlatformWorkloadIdentityRoleSetsListOptionalParams
- Added Interface RestorePollerOptions
- Added Interface SimplePollerLike
- Added Interface UserAssignedIdentity
- Interface ClusterProfile has a new optional parameter oidcIssuer
- Interface OpenShiftCluster has a new optional parameter identity
- Interface OpenShiftCluster has a new optional parameter platformWorkloadIdentityProfile
- Interface OpenShiftClusterUpdate has a new optional parameter identity
- Interface OpenShiftClusterUpdate has a new optional parameter platformWorkloadIdentityProfile
- Added Type Alias AzureSupportedClouds
- Added Type Alias ManagedServiceIdentityType
- Added Enum AzureClouds
- Added Enum KnownManagedServiceIdentityType
- Added Enum KnownVersions

### Breaking Changes
- Removed Interface MachinePool
- Removed Interface MachinePoolList
- Removed Interface MachinePools
- Removed Interface MachinePoolsCreateOrUpdateOptionalParams
- Removed Interface MachinePoolsDeleteOptionalParams
- Removed Interface MachinePoolsGetOptionalParams
- Removed Interface MachinePoolsListOptionalParams
- Removed Interface MachinePoolsUpdateOptionalParams
- Removed Interface MachinePoolUpdate
- Removed Interface OpenShiftClusterList
- Removed Interface OpenShiftVersionList
- Removed Interface OperationList
- Removed Interface Secret
- Removed Interface SecretList
- Removed Interface Secrets
- Removed Interface SecretsCreateOrUpdateOptionalParams
- Removed Interface SecretsDeleteOptionalParams
- Removed Interface SecretsGetOptionalParams
- Removed Interface SecretsListOptionalParams
- Removed Interface SecretsUpdateOptionalParams
- Removed Interface SecretUpdate
- Removed Interface SyncIdentityProvider
- Removed Interface SyncIdentityProviderList
- Removed Interface SyncIdentityProviders
- Removed Interface SyncIdentityProvidersCreateOrUpdateOptionalParams
- Removed Interface SyncIdentityProvidersDeleteOptionalParams
- Removed Interface SyncIdentityProvidersGetOptionalParams
- Removed Interface SyncIdentityProvidersListOptionalParams
- Removed Interface SyncIdentityProvidersUpdateOptionalParams
- Removed Interface SyncIdentityProviderUpdate
- Removed Interface SyncSet
- Removed Interface SyncSetList
- Removed Interface SyncSets
- Removed Interface SyncSetsCreateOrUpdateOptionalParams
- Removed Interface SyncSetsDeleteOptionalParams
- Removed Interface SyncSetsGetOptionalParams
- Removed Interface SyncSetsListOptionalParams
- Removed Interface SyncSetsUpdateOptionalParams
- Removed Interface SyncSetUpdate
- Interface OpenShiftClusterUpdate no longer has parameter systemData

### Bugs Fixed

### Other Changes


## 1.0.0-beta.1 (2024-07-26)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/redhatopenshift/arm-redhatopenshift/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
45 changes: 21 additions & 24 deletions sdk/redhatopenshift/arm-redhatopenshift/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Azure Red Hat OpenShift client library for JavaScript
# AzureRedHatOpenShift client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Red Hat OpenShift client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AzureRedHatOpenShift client.

Rest API for Azure Red Hat OpenShift 4

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

## Getting started

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

### Install the `@azure/arm-redhatopenshift` package

Install the Azure Red Hat OpenShift client library for JavaScript with `npm`:
Install the AzureRedHatOpenShift client library for JavaScript with `npm`:

```bash
npm install @azure/arm-redhatopenshift
```

### Create and authenticate a `AzureRedHatOpenShiftClient`

To create a client object to access the Azure Red Hat OpenShift API, you will need the `endpoint` of your Azure Red Hat OpenShift resource and a `credential`. The Azure Red Hat OpenShift client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Red Hat OpenShift resource in the [Azure Portal][azure_portal].
To create a client object to access the AzureRedHatOpenShift API, you will need the `endpoint` of your AzureRedHatOpenShift resource and a `credential`. The AzureRedHatOpenShift client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your AzureRedHatOpenShift resource in the [Azure Portal][azure_portal].

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

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

```bash
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Red Hat OpenShift** 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 AzureRedHatOpenShift** 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).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { AstroManagementClient } from "@azure/arm-redhatopenshift";
import { AzureRedHatOpenShiftClient } from "@azure/arm-redhatopenshift";
import { DefaultAzureCredential } from "@azure/identity";

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

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { AstroManagementClient } from "@azure/arm-redhatopenshift";
import { AzureRedHatOpenShiftClient } from "@azure/arm-redhatopenshift";

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

### JavaScript Bundle

### 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

### AzureRedHatOpenShiftClient

`AzureRedHatOpenShiftClient` is the primary interface for developers using the Azure Red Hat OpenShift client library. Explore the methods on this client object to understand the different features of the Azure Red Hat OpenShift service that you can access.
`AzureRedHatOpenShiftClient` is the primary interface for developers using the AzureRedHatOpenShift client library. Explore the methods on this client object to understand the different features of the AzureRedHatOpenShift service that you can access.

## Troubleshooting

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

## 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/redhatopenshift/arm-redhatopenshift/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -108,10 +109,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/redhatopenshift/arm-redhatopenshift/_meta.json

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
{
"extends": "../../../api-extractor-base.json"
}
{ "extends": "../../../api-extractor-base.json" }
2 changes: 1 addition & 1 deletion sdk/redhatopenshift/arm-redhatopenshift/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/redhatopenshift/arm-redhatopenshift",
"Tag": "js/redhatopenshift/arm-redhatopenshift_fd51ca4b20"
"Tag": "js/redhatopenshift/arm-redhatopenshift_2b54eee966"
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
"extends": "../../../../eng/tsconfigs/samples.json",
"compilerOptions": {
"paths": {
"@azure/arm-redhatopenshift": [
"../dist/esm"
]
"@azure/arm-redhatopenshift": ["../dist/esm"]
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.browser.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.cjs.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.esm.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.browser.json",
"compilerOptions": {
"paths": {
"@azure/arm-redhatopenshift": ["../src/index.ts"],
"@azure/arm-redhatopenshift/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.node.json"
"extends": "../../../../eng/tsconfigs/test.node.json",
"compilerOptions": {
"paths": {
"@azure/arm-redhatopenshift": ["../src/index.ts"],
"@azure/arm-redhatopenshift/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
6 changes: 3 additions & 3 deletions sdk/redhatopenshift/arm-redhatopenshift/eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ export default [
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn"
}
}
"tsdoc/syntax": "warn",
},
},
]),
{
files: ["src/**/*.ts", "src/**/*.mts", "test/**/*.ts"],
Expand Down
Loading
Loading