Skip to content

Commit

Permalink
Check readme correctness for all rps (Azure#17667)
Browse files Browse the repository at this point in the history
* missing NewXxxClient

* not exist NewXxxClient

* fix

* remove authorization samples link
  • Loading branch information
Alancere committed Apr 20, 2022
1 parent ac877b9 commit 1ac2b06
Show file tree
Hide file tree
Showing 45 changed files with 90 additions and 96 deletions.
4 changes: 2 additions & 2 deletions sdk/resourcemanager/aad/armaad/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armaad.NewDiagnosticSettingsClient(cred, nil)
client, err := armaad.NewPrivateLinkResourcesClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armaad.NewDiagnosticSettingsClient(cred, &options)
client, err := armaad.NewPrivateLinkResourcesClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/attestation/armattestation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armattestation.NewAttestationProvidersClient(<subscription ID>, cred, nil)
client, err := armattestation.NewProvidersClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armattestation.NewAttestationProvidersClient(<subscription ID>, cred, &options)
client, err := armattestation.NewProvidersClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
10 changes: 2 additions & 8 deletions sdk/resourcemanager/authorization/armauthorization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

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

## More sample code

- [Permissions](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/permissions)
- [Role Assignment](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/role_assignment)
- [Role Definition](https://aka.ms/azsdk/go/mgmt/samples?path=sdk/resourcemanager/authorization/role_definition)

## Provide Feedback

If you encounter bugs or have suggestions, please
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/automanage/armautomanage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armautomanage.NewConfigurationProfilePreferencesClient(<subscription ID>, cred, nil)
client, err := armautomanage.NewReportsClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armautomanage.NewConfigurationProfilePreferencesClient(<subscription ID>, cred, &options)
client, err := armautomanage.NewReportsClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/blockchain/armblockchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armblockchain.NewBlockchainMemberOperationResultsClient(<subscription ID>, cred, nil)
client, err := armblockchain.NewMembersClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armblockchain.NewBlockchainMemberOperationResultsClient(<subscription ID>, cred, &options)
client, err := armblockchain.NewMembersClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/blueprint/armblueprint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armblueprint.(<subscription ID>, cred, nil)
client, err := armblueprint.NewBlueprintsClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armblueprint.(<subscription ID>, cred, &options)
client, err := armblueprint.NewBlueprintsClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/cdn/armcdn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armcdn.NewCdnManagementClient(<subscription ID>, cred, nil)
client, err := armcdn.NewManagementClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armcdn.NewCdnManagementClient(<subscription ID>, cred, &options)
client, err := armcdn.NewManagementClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/communication/armcommunication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armcommunication.NewCommunicationServiceClient(<subscription ID>, cred, nil)
client, err := armcommunication.NewServiceClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armcommunication.NewCommunicationServiceClient(<subscription ID>, cred, &options)
client, err := armcommunication.NewServiceClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armcustomerlockbox.(<subscription ID>, cred, nil)
client, err := armcustomerlockbox.NewGetClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armcustomerlockbox.(<subscription ID>, cred, &options)
client, err := armcustomerlockbox.NewGetClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/datacatalog/armdatacatalog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
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.

```go
client, err := armdatacatalog.(<subscription ID>, cred, nil)
client, err := armdatacatalog.NewADCCatalogsClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armdatacatalog.(<subscription ID>, cred, &options)
client, err := armdatacatalog.NewADCCatalogsClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure Backup 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.

```go
client, err := armdataprotection.NewDataProtectionClient(<subscription ID>, cred, nil)
client, err := armdataprotection.NewClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armdataprotection.NewDataProtectionClient(<subscription ID>, cred, &options)
client, err := armdataprotection.NewClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/digitaltwins/armdigitaltwins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure Digital Twins 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.

```go
client, err := armdigitaltwins.NewDigitalTwinsEndpointClient(<subscription ID>, cred, nil)
client, err := armdigitaltwins.NewClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armdigitaltwins.NewDigitalTwinsEndpointClient(<subscription ID>, cred, &options)
client, err := armdigitaltwins.NewClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/dns/armdns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure DNS 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.

```go
client, err := armdns.NewDNSResourceReferenceClient(<subscription ID>, cred, nil)
client, err := armdns.NewResourceReferenceClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armdns.NewDNSResourceReferenceClient(<subscription ID>, cred, &options)
client, err := armdns.NewResourceReferenceClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
4 changes: 2 additions & 2 deletions sdk/resourcemanager/edgeorder/armedgeorder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure Edge Order 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.

```go
client, err := armedgeorder.NewEdgeOrderManagementClient(<subscription ID>, cred, nil)
client, err := armedgeorder.NewManagementClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armedgeorder.NewEdgeOrderManagementClient(<subscription ID>, cred, &options)
client, err := armedgeorder.NewManagementClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure Edge Order Partner 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.

```go
client, err := armedgeorderpartner.NewEdgeOrderPartnerAPISClient(<subscription ID>, cred, nil)
client, err := armedgeorderpartner.NewAPISClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armedgeorderpartner.NewEdgeOrderPartnerAPISClient(<subscription ID>, cred, &options)
client, err := armedgeorderpartner.NewAPISClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For more information on authentication, please see the documentation for `aziden
Azure Guest Configuration 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.

```go
client, err := armguestconfiguration.NewGuestConfigurationAssignmentsClient(<subscription ID>, cred, nil)
client, err := armguestconfiguration.NewAssignmentsClient(<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,7 @@ options := arm.ClientOptions {
Cloud: cloud.AzureChina,
},
}
client, err := armguestconfiguration.NewGuestConfigurationAssignmentsClient(<subscription ID>, cred, &options)
client, err := armguestconfiguration.NewAssignmentsClient(<subscription ID>, cred, &options)
```

## Provide Feedback
Expand Down
Loading

0 comments on commit 1ac2b06

Please sign in to comment.