Security Partner Providers - Get

Gets the specified Security Partner Provider.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}?api-version=2024-03-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

securityPartnerProviderName
path True

string

The name of the Security Partner Provider.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

SecurityPartnerProvider

Request successful. The operation returns a SecurityPartnerProvider resource.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get Security Partner Provider

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider?api-version=2024-03-01

Sample response

{
  "name": "securityPartnerProvider",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider",
  "type": "Microsoft.Network/securityPartnerProviders",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "securityProviderName": "ZScaler",
    "connectionStatus": "Unknown",
    "virtualHub": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1"
    }
  }
}

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

ProvisioningState

The current provisioning state.

SecurityPartnerProvider

Security Partner Provider resource.

SecurityPartnerProviderConnectionStatus

The current state of the connection with Security Partner Provider.

SecurityProviderName

The security provider name.

SubResource

Reference to another subresource.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

SecurityPartnerProvider

Security Partner Provider resource.

Name Type Description
etag

string

A unique read-only string that changes whenever the resource is updated.

id

string

Resource ID.

location

string

Resource location.

name

string

Resource name.

properties.connectionStatus

SecurityPartnerProviderConnectionStatus

The connection status with the Security Partner Provider.

properties.provisioningState

ProvisioningState

The provisioning state of the Security Partner Provider resource.

properties.securityProviderName

SecurityProviderName

The security provider name.

properties.virtualHub

SubResource

The virtualHub to which the Security Partner Provider belongs.

tags

object

Resource tags.

type

string

Resource type.

SecurityPartnerProviderConnectionStatus

The current state of the connection with Security Partner Provider.

Name Type Description
Connected

string

NotConnected

string

PartiallyConnected

string

Unknown

string

SecurityProviderName

The security provider name.

Name Type Description
Checkpoint

string

IBoss

string

ZScaler

string

SubResource

Reference to another subresource.

Name Type Description
id

string

Resource ID.