Skip to content

Commit 1ac2b06

Browse files
authored
Check readme correctness for all rps (Azure#17667)
* missing NewXxxClient * not exist NewXxxClient * fix * remove authorization samples link
1 parent ac877b9 commit 1ac2b06

File tree

45 files changed

+90
-96
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+90
-96
lines changed

sdk/resourcemanager/aad/armaad/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Active Directory 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.
3939

4040
```go
41-
client, err := armaad.NewDiagnosticSettingsClient(cred, nil)
41+
client, err := armaad.NewPrivateLinkResourcesClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armaad.NewDiagnosticSettingsClient(cred, &options)
52+
client, err := armaad.NewPrivateLinkResourcesClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/attestation/armattestation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Attestation 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.
3939

4040
```go
41-
client, err := armattestation.NewAttestationProvidersClient(<subscription ID>, cred, nil)
41+
client, err := armattestation.NewProvidersClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armattestation.NewAttestationProvidersClient(<subscription ID>, cred, &options)
52+
client, err := armattestation.NewProvidersClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/authorization/armauthorization/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Authorization 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.
3939

4040
```go
41-
client, err := armauthorization.NewPermissionsClient(<subscription ID>, cred, nil)
41+
client, err := armauthorization.NewAccessReviewInstancesClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,15 +49,9 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armauthorization.NewPermissionsClient(<subscription ID>, cred, &options)
52+
client, err := armauthorization.NewAccessReviewInstancesClient(<subscription ID>, cred, &options)
5353
```
5454

55-
## More sample code
56-
57-
- [Permissions](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/permissions)
58-
- [Role Assignment](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/role_assignment)
59-
- [Role Definition](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/role_definition)
60-
6155
## Provide Feedback
6256

6357
If you encounter bugs or have suggestions, please

sdk/resourcemanager/automanage/armautomanage/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Automanage 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.
3939

4040
```go
41-
client, err := armautomanage.NewConfigurationProfilePreferencesClient(<subscription ID>, cred, nil)
41+
client, err := armautomanage.NewReportsClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armautomanage.NewConfigurationProfilePreferencesClient(<subscription ID>, cred, &options)
52+
client, err := armautomanage.NewReportsClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/blockchain/armblockchain/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Blockchain 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.
3939

4040
```go
41-
client, err := armblockchain.NewBlockchainMemberOperationResultsClient(<subscription ID>, cred, nil)
41+
client, err := armblockchain.NewMembersClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armblockchain.NewBlockchainMemberOperationResultsClient(<subscription ID>, cred, &options)
52+
client, err := armblockchain.NewMembersClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/blueprint/armblueprint/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Blueprint 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.
3939

4040
```go
41-
client, err := armblueprint.(<subscription ID>, cred, nil)
41+
client, err := armblueprint.NewBlueprintsClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armblueprint.(<subscription ID>, cred, &options)
52+
client, err := armblueprint.NewBlueprintsClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/cdn/armcdn/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Content Delivery Network 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.
3939

4040
```go
41-
client, err := armcdn.NewCdnManagementClient(<subscription ID>, cred, nil)
41+
client, err := armcdn.NewManagementClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armcdn.NewCdnManagementClient(<subscription ID>, cred, &options)
52+
client, err := armcdn.NewManagementClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/communication/armcommunication/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Communication Services 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.
3939

4040
```go
41-
client, err := armcommunication.NewCommunicationServiceClient(<subscription ID>, cred, nil)
41+
client, err := armcommunication.NewServiceClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armcommunication.NewCommunicationServiceClient(<subscription ID>, cred, &options)
52+
client, err := armcommunication.NewServiceClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/customerlockbox/armcustomerlockbox/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Customer Lockbox 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.
3939

4040
```go
41-
client, err := armcustomerlockbox.(<subscription ID>, cred, nil)
41+
client, err := armcustomerlockbox.NewGetClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armcustomerlockbox.(<subscription ID>, cred, &options)
52+
client, err := armcustomerlockbox.NewGetClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

sdk/resourcemanager/datacatalog/armdatacatalog/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
3838
Azure Data Catalog 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.
3939

4040
```go
41-
client, err := armdatacatalog.(<subscription ID>, cred, nil)
41+
client, err := armdatacatalog.NewADCCatalogsClient(<subscription ID>, cred, nil)
4242
```
4343

4444
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).
@@ -49,7 +49,7 @@ options := arm.ClientOptions {
4949
Cloud: cloud.AzureChina,
5050
},
5151
}
52-
client, err := armdatacatalog.(<subscription ID>, cred, &options)
52+
client, err := armdatacatalog.NewADCCatalogsClient(<subscription ID>, cred, &options)
5353
```
5454

5555
## Provide Feedback

0 commit comments

Comments
 (0)