Gets supported OS options in the specified subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default?api-version=2024-02-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/osOptions/default?api-version=2024-02-01&resource-type={resource-type}
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
location
|
path |
True
|
string
|
The name of the Azure region.
|
|
subscriptionId
|
path |
True
|
string
uuid
|
The ID of the target subscription. The value must be an UUID.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
|
resource-type
|
query |
|
string
|
The resource type for which the OS options needs to be returned
|
Responses
| Name |
Type |
Description |
|
200 OK
|
OSOptionProfile
|
OK
|
|
Other Status Codes
|
CloudError
|
Error response describing why the operation failed
|
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
Get Container Service OS Options
Sample Request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default?api-version=2024-02-01
/**
* Samples for ManagedClusters GetOSOptions.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
* ContainerServiceGetOSOptions.json
*/
/**
* Sample code: Get Container Service OS Options.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getContainerServiceOSOptions(com.azure.resourcemanager.AzureResourceManager azure) {
azure.kubernetesClusters().manager().serviceClient().getManagedClusters().getOSOptionsWithResponse("location1",
null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.containerservice import ContainerServiceClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-containerservice
# USAGE
python container_service_get_os_options.py
Before run the sample, please 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. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ContainerServiceClient(
credential=DefaultAzureCredential(),
subscription_id="00000000-0000-0000-0000-000000000000",
)
response = client.managed_clusters.get_os_options(
location="location1",
)
print(response)
# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ContainerServiceGetOSOptions.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcontainerservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice/v5"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ContainerServiceGetOSOptions.json
func ExampleManagedClustersClient_GetOSOptions() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcontainerservice.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewManagedClustersClient().GetOSOptions(ctx, "location1", &armcontainerservice.ManagedClustersClientGetOSOptionsOptions{ResourceType: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OSOptionProfile = armcontainerservice.OSOptionProfile{
// Name: to.Ptr("default"),
// Type: to.Ptr("Microsoft.ContainerService/locations/osOptions"),
// ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default"),
// Properties: &armcontainerservice.OSOptionPropertyList{
// OSOptionPropertyList: []*armcontainerservice.OSOptionProperty{
// {
// EnableFipsImage: to.Ptr(false),
// OSType: to.Ptr("Linux"),
// },
// {
// EnableFipsImage: to.Ptr(false),
// OSType: to.Ptr("Windows"),
// }},
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ContainerServiceClient } = require("@azure/arm-containerservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets supported OS options in the specified subscription.
*
* @summary Gets supported OS options in the specified subscription.
* x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/ContainerServiceGetOSOptions.json
*/
async function getContainerServiceOSOptions() {
const subscriptionId =
process.env["CONTAINERSERVICE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
const location = "location1";
const credential = new DefaultAzureCredential();
const client = new ContainerServiceClient(credential, subscriptionId);
const result = await client.managedClusters.getOSOptions(location);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/osOptions/default",
"name": "default",
"type": "Microsoft.ContainerService/locations/osOptions",
"properties": {
"osOptionPropertyList": [
{
"os-type": "Linux",
"enable-fips-image": false
},
{
"os-type": "Windows",
"enable-fips-image": false
}
]
}
}
Definitions
CloudError
An error response from the Container service.
CloudErrorBody
An error response from the Container service.
| Name |
Type |
Description |
|
code
|
string
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
|
|
details
|
CloudErrorBody[]
|
A list of additional details about the error.
|
|
message
|
string
|
A message describing the error, intended to be suitable for display in a user interface.
|
|
target
|
string
|
The target of the particular error. For example, the name of the property in error.
|
OSOptionProfile
The OS option profile.
| Name |
Type |
Description |
|
id
|
string
|
The ID of the OS option resource.
|
|
name
|
string
|
The name of the OS option resource.
|
|
properties.osOptionPropertyList
|
OSOptionProperty[]
|
The list of OS options.
|
|
type
|
string
|
The type of the OS option resource.
|
OSOptionProperty
OS option property.
| Name |
Type |
Description |
|
enable-fips-image
|
boolean
|
Whether the image is FIPS-enabled.
|
|
os-type
|
string
|
The OS type.
|