Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release] sdk/resourcemanager/orbital/armorbital/2.0.0 #20365

Merged
merged 6 commits into from
Mar 24, 2023
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
22 changes: 22 additions & 0 deletions sdk/resourcemanager/orbital/armorbital/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Release History

## 2.0.0 (2023-03-24)
### Breaking Changes

- Type alias `APIVersionParameter` has been removed
- Function `*AvailableGroundStationsClient.Get` has been removed
- Field `Etag` of struct `Contact` has been removed
- Field `Etag` of struct `ContactProfile` has been removed
- Field `Etag` of struct `Spacecraft` has been removed

### Features Added

- New struct `ClientFactory` which is a client factory used to create any client in this module
- New struct `ContactProfileThirdPartyConfiguration`
- New struct `ErrorAdditionalInfo`
- New struct `ErrorDetail`
- New struct `ErrorResponse`
- New field `ThirdPartyConfigurations` in struct `ContactProfileProperties`
- New field `ThirdPartyConfigurations` in struct `ContactProfilesProperties`
- New field `NextLink` in struct `OperationResult`
- New field `Value` in struct `OperationResult`


## 1.0.0 (2022-05-19)

The package of `github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital` is using our [next generation design principles](https://azure.github.io/azure-sdk/general_introduction.html) since version 1.0.0, which contains breaking changes.
Expand Down
16 changes: 12 additions & 4 deletions sdk/resourcemanager/orbital/armorbital/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for `azidentity` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity).

## Clients
## Client Factory

Azure Orbital modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.
Azure Orbital module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

```go
client, err := armorbital.NewContactsClient(<subscription ID>, cred, nil)
clientFactory, err := armorbital.NewClientFactory(<subscription ID>, cred, nil)
```

You can use `ClientOptions` in package `github.com/Azure/azure-sdk-for-go/sdk/azcore/arm` to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for `azcore` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore).
Expand All @@ -49,7 +49,15 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armorbital.NewContactsClient(<subscription ID>, cred, &options)
clientFactory, err := armorbital.NewClientFactory(<subscription ID>, cred, &options)
```

## Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

```go
client := clientFactory.NewContactsClient()
```

## Provide Feedback
Expand Down
6 changes: 3 additions & 3 deletions sdk/resourcemanager/orbital/armorbital/autorest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
``` yaml
azure-arm: true
require:
- https://github.com/Azure/azure-rest-api-specs/blob/08a74065e38665d8a9bb5f2653e92b2abd45bf99/specification/orbital/resource-manager/readme.md
- https://github.com/Azure/azure-rest-api-specs/blob/08a74065e38665d8a9bb5f2653e92b2abd45bf99/specification/orbital/resource-manager/readme.go.md
- https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/readme.md
- https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/readme.go.md
license-header: MICROSOFT_MIT_NO_VERSION
module-version: 1.0.0
module-version: 2.0.0
```

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

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

69 changes: 69 additions & 0 deletions sdk/resourcemanager/orbital/armorbital/client_factory.go

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

Loading