Skip to content

Commit 2427c30

Browse files
authored
update armcomputeschedule readme (Azure#23520)
1 parent 129a9cf commit 2427c30

File tree

1 file changed

+17
-7
lines changed
  • sdk/resourcemanager/computeschedule/armcomputeschedule

1 file changed

+17
-7
lines changed

sdk/resourcemanager/computeschedule/armcomputeschedule/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
# Azure Computeschedule Module for Go
1+
# Azure Compute Schedule Module for Go
22

33
[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/computeschedule/armcomputeschedule)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/computeschedule/armcomputeschedule)
44

5-
The `armcomputeschedule` module provides operations for working with Azure Computeschedule.
5+
Microsoft Azure Compute Schedule allows customers to schedule one off operations on their virtual machines. These operations include:
6+
- Start
7+
- Deallocate
8+
- Hibernate
9+
10+
There are 2 groups of schedule type operations that customers can perform on their virtual machines
11+
12+
- `Submit Type Operations`: These type of operations can be scheduled at a later date in the future, up to 14 days ahead.
13+
- `Execute Type Operations`: These type of operations allow clients to perform operations on their virtual machines immediately.
14+
15+
Other operations include endpoints to get operation status on virtual machines, cancel operations scheduled on virtual machines and get errors that might have occured during operations.
616

717
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/computeschedule/armcomputeschedule)
818

@@ -17,15 +27,15 @@ The `armcomputeschedule` module provides operations for working with Azure Compu
1727

1828
This project uses [Go modules](https://github.com/golang/go/wiki/Modules) for versioning and dependency management.
1929

20-
Install the Azure Computeschedule module:
30+
Install the Azure Compute Schedule module:
2131

2232
```sh
2333
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/computeschedule/armcomputeschedule
2434
```
2535

2636
## Authorization
2737

28-
When creating a client, you will need to provide a credential for authenticating with Azure Computeschedule. The `azidentity` module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.
38+
When creating a client, you will need to provide a credential for authenticating with Azure Compute Schedule. The `azidentity` module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.
2939

3040
```go
3141
cred, err := azidentity.NewDefaultAzureCredential(nil)
@@ -35,7 +45,7 @@ For more information on authentication, please see the documentation for `aziden
3545

3646
## Client Factory
3747

38-
Azure Computeschedule module consists of one or more clients. We provide a client factory which could be used to create any client in this module.
48+
Azure Compute Schedule module consists of one or more clients. We provide a client factory which could be used to create any client in this module.
3949

4050
```go
4151
clientFactory, err := armcomputeschedule.NewClientFactory(<subscription ID>, cred, nil)
@@ -70,7 +80,7 @@ Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes
7080
## Provide Feedback
7181

7282
If you encounter bugs or have suggestions, please
73-
[open an issue](https://github.com/Azure/azure-sdk-for-go/issues) and assign the `Computeschedule` label.
83+
[open an issue](https://github.com/Azure/azure-sdk-for-go/issues) and assign the `ComputeSchedule` label.
7484

7585
# Contributing
7686

@@ -89,4 +99,4 @@ This project has adopted the
8999
For more information, see the
90100
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
91101
or contact [[email protected]](mailto:[email protected]) with any
92-
additional questions or comments.
102+
additional questions or comments.

0 commit comments

Comments
 (0)