Categorygithub.com/Azure/azure-sdk-for-go/sdk/resourcemanager/securitydevops/armsecuritydevops
modulepackage
0.3.0
Repository: https://github.com/azure/azure-sdk-for-go.git
Documentation: pkg.go.dev

# README

Azure Securitydevops Module for Go

PkgGoDev

The armsecuritydevops module provides operations for working with Azure Securitydevops.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Securitydevops module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/securitydevops/armsecuritydevops

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Securitydevops. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

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.

Client Factory

Azure Securitydevops module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armsecuritydevops.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.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armsecuritydevops.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.

client := clientFactory.NewAzureDevOpsConnectorStatsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Securitydevops label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

# Packages

No description provided by the author

# Functions

NewAzureDevOpsConnectorClient creates a new instance of AzureDevOpsConnectorClient with the specified values.
NewAzureDevOpsConnectorStatsClient creates a new instance of AzureDevOpsConnectorStatsClient with the specified values.
NewAzureDevOpsOrgClient creates a new instance of AzureDevOpsOrgClient with the specified values.
NewAzureDevOpsProjectClient creates a new instance of AzureDevOpsProjectClient with the specified values.
NewAzureDevOpsRepoClient creates a new instance of AzureDevOpsRepoClient with the specified values.
NewClientFactory creates a new instance of ClientFactory with the specified values.
NewGitHubConnectorClient creates a new instance of GitHubConnectorClient with the specified values.
NewGitHubConnectorStatsClient creates a new instance of GitHubConnectorStatsClient with the specified values.
NewGitHubOwnerClient creates a new instance of GitHubOwnerClient with the specified values.
NewGitHubRepoClient creates a new instance of GitHubRepoClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
PossibleActionableRemediationStateValues returns the possible values for the ActionableRemediationState const type.
PossibleActionTypeValues returns the possible values for the ActionType const type.
PossibleAutoDiscoveryValues returns the possible values for the AutoDiscovery const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleOriginValues returns the possible values for the Origin const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
PossibleRuleCategoryValues returns the possible values for the RuleCategory const type.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
AzureDevOpsConnectorClient contains the methods for the AzureDevOpsConnector group.
AzureDevOpsConnectorClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureDevOpsConnectorClient.BeginCreateOrUpdate method.
AzureDevOpsConnectorClientBeginDeleteOptions contains the optional parameters for the AzureDevOpsConnectorClient.BeginDelete method.
AzureDevOpsConnectorClientBeginUpdateOptions contains the optional parameters for the AzureDevOpsConnectorClient.BeginUpdate method.
AzureDevOpsConnectorClientCreateOrUpdateResponse contains the response from method AzureDevOpsConnectorClient.BeginCreateOrUpdate.
AzureDevOpsConnectorClientDeleteResponse contains the response from method AzureDevOpsConnectorClient.BeginDelete.
AzureDevOpsConnectorClientGetOptions contains the optional parameters for the AzureDevOpsConnectorClient.Get method.
AzureDevOpsConnectorClientGetResponse contains the response from method AzureDevOpsConnectorClient.Get.
AzureDevOpsConnectorClientListByResourceGroupOptions contains the optional parameters for the AzureDevOpsConnectorClient.NewListByResourceGroupPager method.
AzureDevOpsConnectorClientListByResourceGroupResponse contains the response from method AzureDevOpsConnectorClient.NewListByResourceGroupPager.
AzureDevOpsConnectorClientListBySubscriptionOptions contains the optional parameters for the AzureDevOpsConnectorClient.NewListBySubscriptionPager method.
AzureDevOpsConnectorClientListBySubscriptionResponse contains the response from method AzureDevOpsConnectorClient.NewListBySubscriptionPager.
AzureDevOpsConnectorClientUpdateResponse contains the response from method AzureDevOpsConnectorClient.BeginUpdate.
No description provided by the author
No description provided by the author
No description provided by the author
AzureDevOpsConnectorStatsClient contains the methods for the AzureDevOpsConnectorStats group.
AzureDevOpsConnectorStatsClientGetOptions contains the optional parameters for the AzureDevOpsConnectorStatsClient.Get method.
AzureDevOpsConnectorStatsClientGetResponse contains the response from method AzureDevOpsConnectorStatsClient.Get.
No description provided by the author
No description provided by the author
AzureDevOpsOrg - Azure DevOps Org Proxy Resource.
AzureDevOpsOrgClient contains the methods for the AzureDevOpsOrg group.
AzureDevOpsOrgClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureDevOpsOrgClient.BeginCreateOrUpdate method.
AzureDevOpsOrgClientBeginUpdateOptions contains the optional parameters for the AzureDevOpsOrgClient.BeginUpdate method.
AzureDevOpsOrgClientCreateOrUpdateResponse contains the response from method AzureDevOpsOrgClient.BeginCreateOrUpdate.
AzureDevOpsOrgClientGetOptions contains the optional parameters for the AzureDevOpsOrgClient.Get method.
AzureDevOpsOrgClientGetResponse contains the response from method AzureDevOpsOrgClient.Get.
AzureDevOpsOrgClientListOptions contains the optional parameters for the AzureDevOpsOrgClient.NewListPager method.
AzureDevOpsOrgClientListResponse contains the response from method AzureDevOpsOrgClient.NewListPager.
AzureDevOpsOrgClientUpdateResponse contains the response from method AzureDevOpsOrgClient.BeginUpdate.
No description provided by the author
AzureDevOpsOrgMetadata - Org onboarding info.
AzureDevOpsOrgProperties - AzureDevOps Org properties.
AzureDevOpsProject - Azure DevOps Project Proxy Resource.
AzureDevOpsProjectClient contains the methods for the AzureDevOpsProject group.
AzureDevOpsProjectClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureDevOpsProjectClient.BeginCreateOrUpdate method.
AzureDevOpsProjectClientBeginUpdateOptions contains the optional parameters for the AzureDevOpsProjectClient.BeginUpdate method.
AzureDevOpsProjectClientCreateOrUpdateResponse contains the response from method AzureDevOpsProjectClient.BeginCreateOrUpdate.
AzureDevOpsProjectClientGetOptions contains the optional parameters for the AzureDevOpsProjectClient.Get method.
AzureDevOpsProjectClientGetResponse contains the response from method AzureDevOpsProjectClient.Get.
AzureDevOpsProjectClientListOptions contains the optional parameters for the AzureDevOpsProjectClient.NewListPager method.
AzureDevOpsProjectClientListResponse contains the response from method AzureDevOpsProjectClient.NewListPager.
AzureDevOpsProjectClientUpdateResponse contains the response from method AzureDevOpsProjectClient.BeginUpdate.
No description provided by the author
AzureDevOpsProjectMetadata - Project onboarding info.
AzureDevOpsProjectProperties - AzureDevOps Project properties.
AzureDevOpsRepo - Azure DevOps Repo Proxy Resource.
AzureDevOpsRepoClient contains the methods for the AzureDevOpsRepo group.
AzureDevOpsRepoClientBeginCreateOrUpdateOptions contains the optional parameters for the AzureDevOpsRepoClient.BeginCreateOrUpdate method.
AzureDevOpsRepoClientBeginUpdateOptions contains the optional parameters for the AzureDevOpsRepoClient.BeginUpdate method.
AzureDevOpsRepoClientCreateOrUpdateResponse contains the response from method AzureDevOpsRepoClient.BeginCreateOrUpdate.
AzureDevOpsRepoClientGetOptions contains the optional parameters for the AzureDevOpsRepoClient.Get method.
AzureDevOpsRepoClientGetResponse contains the response from method AzureDevOpsRepoClient.Get.
AzureDevOpsRepoClientListByConnectorOptions contains the optional parameters for the AzureDevOpsRepoClient.NewListByConnectorPager method.
AzureDevOpsRepoClientListByConnectorResponse contains the response from method AzureDevOpsRepoClient.NewListByConnectorPager.
AzureDevOpsRepoClientListOptions contains the optional parameters for the AzureDevOpsRepoClient.NewListPager method.
AzureDevOpsRepoClientListResponse contains the response from method AzureDevOpsRepoClient.NewListPager.
AzureDevOpsRepoClientUpdateResponse contains the response from method AzureDevOpsRepoClient.BeginUpdate.
No description provided by the author
AzureDevOpsRepoProperties - AzureDevOps Repo properties.
ClientFactory is a client factory used to create any client in this module.
GitHubConnector - Represents an ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
GitHubConnectorClient contains the methods for the GitHubConnector group.
GitHubConnectorClientBeginCreateOrUpdateOptions contains the optional parameters for the GitHubConnectorClient.BeginCreateOrUpdate method.
GitHubConnectorClientBeginDeleteOptions contains the optional parameters for the GitHubConnectorClient.BeginDelete method.
GitHubConnectorClientBeginUpdateOptions contains the optional parameters for the GitHubConnectorClient.BeginUpdate method.
GitHubConnectorClientCreateOrUpdateResponse contains the response from method GitHubConnectorClient.BeginCreateOrUpdate.
GitHubConnectorClientDeleteResponse contains the response from method GitHubConnectorClient.BeginDelete.
GitHubConnectorClientGetOptions contains the optional parameters for the GitHubConnectorClient.Get method.
GitHubConnectorClientGetResponse contains the response from method GitHubConnectorClient.Get.
GitHubConnectorClientListByResourceGroupOptions contains the optional parameters for the GitHubConnectorClient.NewListByResourceGroupPager method.
GitHubConnectorClientListByResourceGroupResponse contains the response from method GitHubConnectorClient.NewListByResourceGroupPager.
GitHubConnectorClientListBySubscriptionOptions contains the optional parameters for the GitHubConnectorClient.NewListBySubscriptionPager method.
GitHubConnectorClientListBySubscriptionResponse contains the response from method GitHubConnectorClient.NewListBySubscriptionPager.
GitHubConnectorClientUpdateResponse contains the response from method GitHubConnectorClient.BeginUpdate.
No description provided by the author
GitHubConnectorProperties - Properties of the ARM resource for /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.SecurityDevOps/gitHubConnectors.
No description provided by the author
GitHubConnectorStatsClient contains the methods for the GitHubConnectorStats group.
GitHubConnectorStatsClientGetOptions contains the optional parameters for the GitHubConnectorStatsClient.Get method.
GitHubConnectorStatsClientGetResponse contains the response from method GitHubConnectorStatsClient.Get.
No description provided by the author
No description provided by the author
GitHubOwner - GitHub repo owner Proxy Resource.
GitHubOwnerClient contains the methods for the GitHubOwner group.
GitHubOwnerClientBeginCreateOrUpdateOptions contains the optional parameters for the GitHubOwnerClient.BeginCreateOrUpdate method.
GitHubOwnerClientBeginUpdateOptions contains the optional parameters for the GitHubOwnerClient.BeginUpdate method.
GitHubOwnerClientCreateOrUpdateResponse contains the response from method GitHubOwnerClient.BeginCreateOrUpdate.
GitHubOwnerClientGetOptions contains the optional parameters for the GitHubOwnerClient.Get method.
GitHubOwnerClientGetResponse contains the response from method GitHubOwnerClient.Get.
GitHubOwnerClientListOptions contains the optional parameters for the GitHubOwnerClient.NewListPager method.
GitHubOwnerClientListResponse contains the response from method GitHubOwnerClient.NewListPager.
GitHubOwnerClientUpdateResponse contains the response from method GitHubOwnerClient.BeginUpdate.
No description provided by the author
GitHubOwnerProperties - GitHub Repo Owner properties.
GitHubRepo - GitHub repo Proxy Resource.
GitHubRepoClient contains the methods for the GitHubRepo group.
GitHubRepoClientBeginCreateOrUpdateOptions contains the optional parameters for the GitHubRepoClient.BeginCreateOrUpdate method.
GitHubRepoClientBeginUpdateOptions contains the optional parameters for the GitHubRepoClient.BeginUpdate method.
GitHubRepoClientCreateOrUpdateResponse contains the response from method GitHubRepoClient.BeginCreateOrUpdate.
GitHubRepoClientGetOptions contains the optional parameters for the GitHubRepoClient.Get method.
GitHubRepoClientGetResponse contains the response from method GitHubRepoClient.Get.
GitHubRepoClientListByConnectorOptions contains the optional parameters for the GitHubRepoClient.NewListByConnectorPager method.
GitHubRepoClientListByConnectorResponse contains the response from method GitHubRepoClient.NewListByConnectorPager.
GitHubRepoClientListOptions contains the optional parameters for the GitHubRepoClient.NewListPager method.
GitHubRepoClientListResponse contains the response from method GitHubRepoClient.NewListPager.
GitHubRepoClientUpdateResponse contains the response from method GitHubRepoClient.BeginUpdate.
No description provided by the author
GitHubRepoProperties - GitHub Repo properties.
Operation - Details of a REST API operation, returned from the Resource Provider Operations API.
OperationDisplay - Localized display information for this particular operation.
OperationListResult - A list of REST API operations supported by an Azure Resource Provider.
OperationsClient contains the methods for the Operations group.
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
SystemData - Metadata pertaining to creation and last modification of the resource.
TargetBranchConfiguration - Branch onboarding info.

# Type aliases

No description provided by the author
ActionType - Enum.
No description provided by the author
CreatedByType - The type of identity that created the resource.
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX.
No description provided by the author
No description provided by the author