Skip to content
Closed
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
40 changes: 40 additions & 0 deletions sdk/dashboard/azure-mgmt-dashboard/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# Release History

## 1.2.0b1 (2025-05-07)

### Features Added

- Client `DashboardManagementClient` added operation group `integration_fabrics`
- Client `DashboardManagementClient` added operation group `dashboards`
- Client `DashboardManagementClient` added operation group `managed_dashboards`
- Model `GrafanaConfigurations` added property `snapshots`
- Model `GrafanaConfigurations` added property `users`
- Model `GrafanaConfigurations` added property `security`
- Model `GrafanaConfigurations` added property `unified_alerting_screenshots`
- Added model `IntegrationFabric`
- Added model `IntegrationFabricListResponse`
- Added model `IntegrationFabricProperties`
- Added model `IntegrationFabricPropertiesUpdateParameters`
- Added model `IntegrationFabricUpdateParameters`
- Added model `ManagedDashboard`
- Added model `ManagedDashboardListResponse`
- Added model `ManagedDashboardUpdateParameters`
- Added model `Security`
- Added model `Snapshots`
- Added model `UnifiedAlertingScreenshots`
- Added model `Users`
- Added model `DashboardsOperations`
- Added model `IntegrationFabricsOperations`
- Added model `ManagedDashboardsOperations`
- Method `GrafanaOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, workspace_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `GrafanaOperations.update` has a new overload `def update(self: None, resource_group_name: str, workspace_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `ManagedPrivateEndpointsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, workspace_name: str, managed_private_endpoint_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `ManagedPrivateEndpointsOperations.begin_update` has a new overload `def begin_update(self: None, resource_group_name: str, workspace_name: str, managed_private_endpoint_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `PrivateEndpointConnectionsOperations.begin_approve` has a new overload `def begin_approve(self: None, resource_group_name: str, workspace_name: str, private_endpoint_connection_name: str, body: Optional[IO[bytes]], content_type: str)`
- Method `IntegrationFabricsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, workspace_name: str, integration_fabric_name: str, request_body_parameters: IntegrationFabric, content_type: str)`
- Method `IntegrationFabricsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, workspace_name: str, integration_fabric_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `IntegrationFabricsOperations.begin_update` has a new overload `def begin_update(self: None, resource_group_name: str, workspace_name: str, integration_fabric_name: str, request_body_parameters: IntegrationFabricUpdateParameters, content_type: str)`
- Method `IntegrationFabricsOperations.begin_update` has a new overload `def begin_update(self: None, resource_group_name: str, workspace_name: str, integration_fabric_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `ManagedDashboardsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, dashboard_name: str, request_body_parameters: ManagedDashboard, content_type: str)`
- Method `ManagedDashboardsOperations.begin_create` has a new overload `def begin_create(self: None, resource_group_name: str, dashboard_name: str, request_body_parameters: IO[bytes], content_type: str)`
- Method `ManagedDashboardsOperations.update` has a new overload `def update(self: None, resource_group_name: str, dashboard_name: str, request_body_parameters: ManagedDashboardUpdateParameters, content_type: str)`
- Method `ManagedDashboardsOperations.update` has a new overload `def update(self: None, resource_group_name: str, dashboard_name: str, request_body_parameters: IO[bytes], content_type: str)`

## 1.1.0 (2023-11-20)

### Features Added
Expand Down
6 changes: 3 additions & 3 deletions sdk/dashboard/azure-mgmt-dashboard/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Microsoft Azure SDK for Python

This is the Microsoft Azure Dashboard Management Client Library.
This package has been tested with Python 3.7+.
This package has been tested with Python 3.9+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_
Expand All @@ -12,7 +12,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For

### Prerequisites

- Python 3.7+ is required to use this package.
- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package
Expand All @@ -24,7 +24,7 @@ pip install azure-identity

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
Expand Down
10 changes: 5 additions & 5 deletions sdk/dashboard/azure-mgmt-dashboard/_meta.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"commit": "42e2c0bcd77b0de6c523404668fa63511484d485",
"commit": "b27c27afa3fe9016748246af2cc5ce9add9661a5",
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
"autorest": "3.9.7",
"autorest": "3.10.2",
"use": [
"@autorest/python@6.7.1",
"@autorest/modelerfour@4.26.2"
"@autorest/python@6.34.1",
"@autorest/modelerfour@4.27.0"
],
"autorest_command": "autorest specification/dashboard/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --use=@autorest/python@6.7.1 --use=@autorest/modelerfour@4.26.2 --version=3.9.7 --version-tolerant=False",
"autorest_command": "autorest specification/dashboard/resource-manager/readme.md --generate-sample=True --generate-test=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.34.1 --use=@autorest/modelerfour@4.27.0 --version=3.10.2 --version-tolerant=False",
"readme": "specification/dashboard/resource-manager/readme.md"
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,28 @@
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position

from ._dashboard_management_client import DashboardManagementClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._dashboard_management_client import DashboardManagementClient # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
from ._patch import * # pylint: disable=unused-wildcard-import
from ._patch import *
except ImportError:
_patch_all = []
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"DashboardManagementClient",
]
__all__.extend([p for p in _patch_all if p not in __all__])
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore

_patch_sdk()
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,16 @@

from typing import Any, TYPE_CHECKING

from azure.core.configuration import Configuration
from azure.core.pipeline import policies
from azure.mgmt.core.policies import ARMChallengeAuthenticationPolicy, ARMHttpLoggingPolicy

from ._version import VERSION

if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential


class DashboardManagementClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes
class DashboardManagementClientConfiguration: # pylint: disable=too-many-instance-attributes
"""Configuration for DashboardManagementClient.

Note that all parameters used to create this instance are saved as instance
Expand All @@ -29,14 +27,13 @@ class DashboardManagementClientConfiguration(Configuration): # pylint: disable=
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. Required.
:type subscription_id: str
:keyword api_version: Api Version. Default value is "2023-09-01". Note that overriding this
default value may result in unsupported behavior.
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
"""

def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs: Any) -> None:
super(DashboardManagementClientConfiguration, self).__init__(**kwargs)
api_version: str = kwargs.pop("api_version", "2023-09-01")
api_version: str = kwargs.pop("api_version", "2024-11-01-preview")

if credential is None:
raise ValueError("Parameter 'credential' must not be None.")
Expand All @@ -48,6 +45,7 @@ def __init__(self, credential: "TokenCredential", subscription_id: str, **kwargs
self.api_version = api_version
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
kwargs.setdefault("sdk_moniker", "mgmt-dashboard/{}".format(VERSION))
self.polling_interval = kwargs.get("polling_interval", 30)
self._configure(**kwargs)

def _configure(self, **kwargs: Any) -> None:
Expand All @@ -56,9 +54,9 @@ def _configure(self, **kwargs: Any) -> None:
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
self.http_logging_policy = kwargs.get("http_logging_policy") or ARMHttpLoggingPolicy(**kwargs)
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
self.authentication_policy = kwargs.get("authentication_policy")
if self.credential and not self.authentication_policy:
self.authentication_policy = ARMChallengeAuthenticationPolicy(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,35 @@
# --------------------------------------------------------------------------

from copy import deepcopy
from typing import Any, TYPE_CHECKING
from typing import Any, Optional, TYPE_CHECKING, cast
from typing_extensions import Self

from azure.core.pipeline import policies
from azure.core.rest import HttpRequest, HttpResponse
from azure.core.settings import settings
from azure.mgmt.core import ARMPipelineClient
from azure.mgmt.core.policies import ARMAutoResourceProviderRegistrationPolicy
from azure.mgmt.core.tools import get_arm_endpoints

from . import models as _models
from ._configuration import DashboardManagementClientConfiguration
from ._serialization import Deserializer, Serializer
from ._utils.serialization import Deserializer, Serializer
from .operations import (
DashboardsOperations,
GrafanaOperations,
IntegrationFabricsOperations,
ManagedDashboardsOperations,
ManagedPrivateEndpointsOperations,
Operations,
PrivateEndpointConnectionsOperations,
PrivateLinkResourcesOperations,
)

if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from azure.core.credentials import TokenCredential


class DashboardManagementClient: # pylint: disable=client-accepts-api-version-keyword
class DashboardManagementClient: # pylint: disable=too-many-instance-attributes
"""The Microsoft.Dashboard Rest API spec.

:ivar operations: Operations operations
Expand All @@ -43,30 +50,56 @@ class DashboardManagementClient: # pylint: disable=client-accepts-api-version-k
:ivar managed_private_endpoints: ManagedPrivateEndpointsOperations operations
:vartype managed_private_endpoints:
azure.mgmt.dashboard.operations.ManagedPrivateEndpointsOperations
:ivar integration_fabrics: IntegrationFabricsOperations operations
:vartype integration_fabrics: azure.mgmt.dashboard.operations.IntegrationFabricsOperations
:ivar dashboards: DashboardsOperations operations
:vartype dashboards: azure.mgmt.dashboard.operations.DashboardsOperations
:ivar managed_dashboards: ManagedDashboardsOperations operations
:vartype managed_dashboards: azure.mgmt.dashboard.operations.ManagedDashboardsOperations
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
:param subscription_id: The ID of the target subscription. Required.
:type subscription_id: str
:param base_url: Service URL. Default value is "https://management.azure.com".
:param base_url: Service URL. Default value is None.
:type base_url: str
:keyword api_version: Api Version. Default value is "2023-09-01". Note that overriding this
default value may result in unsupported behavior.
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
this default value may result in unsupported behavior.
:paramtype api_version: str
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
"""

def __init__(
self,
credential: "TokenCredential",
subscription_id: str,
base_url: str = "https://management.azure.com",
**kwargs: Any
self, credential: "TokenCredential", subscription_id: str, base_url: Optional[str] = None, **kwargs: Any
) -> None:
_cloud = kwargs.pop("cloud_setting", None) or settings.current.azure_cloud # type: ignore
_endpoints = get_arm_endpoints(_cloud)
if not base_url:
base_url = _endpoints["resource_manager"]
credential_scopes = kwargs.pop("credential_scopes", _endpoints["credential_scopes"])
self._config = DashboardManagementClientConfiguration(
credential=credential, subscription_id=subscription_id, **kwargs
credential=credential, subscription_id=subscription_id, credential_scopes=credential_scopes, **kwargs
)
self._client: ARMPipelineClient = ARMPipelineClient(base_url=base_url, config=self._config, **kwargs)

_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
policies.RequestIdPolicy(**kwargs),
self._config.headers_policy,
self._config.user_agent_policy,
self._config.proxy_policy,
policies.ContentDecodePolicy(**kwargs),
ARMAutoResourceProviderRegistrationPolicy(),
self._config.redirect_policy,
self._config.retry_policy,
self._config.authentication_policy,
self._config.custom_hook_policy,
self._config.logging_policy,
policies.DistributedTracingPolicy(**kwargs),
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: ARMPipelineClient = ARMPipelineClient(base_url=cast(str, base_url), policies=_policies, **kwargs)

client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
self._serialize = Serializer(client_models)
Expand All @@ -83,8 +116,15 @@ def __init__(
self.managed_private_endpoints = ManagedPrivateEndpointsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.integration_fabrics = IntegrationFabricsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.dashboards = DashboardsOperations(self._client, self._config, self._serialize, self._deserialize)
self.managed_dashboards = ManagedDashboardsOperations(
self._client, self._config, self._serialize, self._deserialize
)

def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:
def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
"""Runs the network request through the client's chained policies.

>>> from azure.core.rest import HttpRequest
Expand All @@ -104,12 +144,12 @@ def _send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse:

request_copy = deepcopy(request)
request_copy.url = self._client.format_url(request_copy.url)
return self._client.send_request(request_copy, **kwargs)
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore

def close(self) -> None:
self._client.close()

def __enter__(self) -> "DashboardManagementClient":
def __enter__(self) -> Self:
self._client.__enter__()
return self

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
#
# --------------------------------------------------------------------------


# This file is used for handwritten extensions to the generated code. Example:
# https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md
def patch_sdk():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,3 @@
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from azure.core.pipeline.transport import HttpRequest


def _convert_request(request, files=None):
data = request.content if not files else None
request = HttpRequest(method=request.method, url=request.url, headers=request.headers, data=data)
if files:
request.set_formdata_body(files)
return request
Loading